class Engine

Templating engine Latte.

Constants

Version

VersionId

deprecated VERSION

deprecated VERSION_ID

CONTENT_HTML

CONTENT_XML

CONTENT_JS

CONTENT_CSS

CONTENT_ICAL

CONTENT_TEXT

Methods

__construct()

No description

void
render(string $name, object|array $params = [], string|null $block = null)

Renders template to output.

string
renderToString(string $name, object|array $params = [], string|null $block = null)

Renders template to string.

createTemplate(string $name, array $params = [], bool $clearCache = true)

Creates template object.

string
compile(string $name)

Compiles template to PHP code.

parse(string $template)

Parses template to AST node.

void
applyPasses(TemplateNode $node)

Calls node visitors.

string
generate(TemplateNode $node, string $name)

Generates compiled PHP code.

void
warmupCache(string $name)

Compiles template to cache.

string
getCacheFile(string $name)

Returns the file path where compiled template will be cached.

string
getTemplateClass(string $name)

Returns the PHP class name for compiled template.

string
generateTemplateHash(string $name)

Generates unique hash for template based on current configuration.

array
generateConfigurationSignature()

Returns values that determine isolation for different configurations.

addFilter(string $name, callable $callback)

Registers run-time filter.

addFilterLoader(callable $loader)

No description

array
getFilters()

Returns all run-time filters.

mixed
invokeFilter(string $name, array $args)

Call a run-time filter.

addExtension(Extension $extension)

Adds new extension.

array
getExtensions()

No description

addFunction(string $name, callable $callback)

Registers run-time function.

mixed
invokeFunction(string $name, array $args)

Call a run-time function.

array
getFunctions()

No description

addProvider(string $name, mixed $provider)

Adds new provider.

array
getProviders()

Returns all providers.

setPolicy(Policy|null $policy)

No description

Policy|null
getPolicy(bool $effective = false)

No description

setExceptionHandler(callable $handler)

No description

setSandboxMode(bool $state = true)

No description

setContentType(string $type)

No description

setTempDirectory(string|null $path)

Sets path to temporary directory.

setAutoRefresh(bool $state = true)

Sets auto-refresh mode.

setStrictTypes(bool $state = true)

Enables declare(strict_types=1) in templates.

setStrictParsing(bool $state = true)

No description

bool
isStrictParsing()

No description

setLocale(string|null $locale)

Sets the locale. It uses the same identifiers as the PHP intl extension.

string|null
getLocale()

No description

setLoader(Loader $loader)

No description

getLoader()

No description

enablePhpLinter(string|null $phpBinary)

No description

setSyntax(string $syntax)

Sets default Latte syntax. Available options: 'single', 'double', 'off'

setMigrationWarnings(bool $state = true)

No description

Details

at line 68
__construct()

No description

at line 83
void render(string $name, object|array $params = [], string|null $block = null)

Renders template to output.

Parameters

string $name
object|array $params
string|null $block

Return Value

void

at line 95
string renderToString(string $name, object|array $params = [], string|null $block = null)

Renders template to string.

Parameters

string $name
object|array $params
string|null $block

Return Value

string

at line 107
Template createTemplate(string $name, array $params = [], bool $clearCache = true)

Creates template object.

Parameters

string $name
array $params
bool $clearCache

Return Value

Template

at line 125
string compile(string $name)

Compiles template to PHP code.

Parameters

string $name

Return Value

string

at line 157
TemplateNode parse(string $template)

Parses template to AST node.

Parameters

string $template

Return Value

TemplateNode

at line 178
void applyPasses(TemplateNode $node)

Calls node visitors.

Parameters

TemplateNode $node

Return Value

void

at line 196
string generate(TemplateNode $node, string $name)

Generates compiled PHP code.

Parameters

TemplateNode $node
string $name

Return Value

string

at line 208
void warmupCache(string $name)

Compiles template to cache.

Parameters

string $name

Return Value

void

Exceptions

LogicException

at line 239
string getCacheFile(string $name)

Returns the file path where compiled template will be cached.

Parameters

string $name

Return Value

string

at line 248
string getTemplateClass(string $name)

Returns the PHP class name for compiled template.

Parameters

string $name

Return Value

string

at line 259
string generateTemplateHash(string $name)

internal  
 

Generates unique hash for template based on current configuration.

Used to create isolated cache files for different engine configurations.

Parameters

string $name

Return Value

string

at line 271
protected array generateConfigurationSignature()

Returns values that determine isolation for different configurations.

When any of these values change, a new compiled template is created to avoid conflicts.

Return Value

array

at line 289
Engine addFilter(string $name, callable $callback)

Registers run-time filter.

Parameters

string $name
callable $callback

Return Value

Engine

at line 300
Engine addFilterLoader(callable $loader)

No description

Parameters

callable $loader

Return Value

Engine

at line 313
array getFilters()

Returns all run-time filters.

Return Value

array

at line 323
mixed invokeFilter(string $name, array $args)

Call a run-time filter.

Parameters

string $name
array $args

Return Value

mixed

at line 332
Engine addExtension(Extension $extension)

Adds new extension.

Parameters

Extension $extension

Return Value

Engine

at line 351
array getExtensions()

No description

Return Value

array

at line 360
Engine addFunction(string $name, callable $callback)

Registers run-time function.

Parameters

string $name
callable $callback

Return Value

Engine

at line 375
mixed invokeFunction(string $name, array $args)

Call a run-time function.

Parameters

string $name
array $args

Return Value

mixed

at line 384
array getFunctions()

No description

Return Value

array

at line 393
Engine addProvider(string $name, mixed $provider)

Adds new provider.

Parameters

string $name
mixed $provider

Return Value

Engine

at line 408
array getProviders()

Returns all providers.

Return Value

array

at line 414
Engine setPolicy(Policy|null $policy)

No description

Parameters

Policy|null $policy

Return Value

Engine

at line 421
Policy|null getPolicy(bool $effective = false)

No description

Parameters

bool $effective

Return Value

Policy|null

at line 429
Engine setExceptionHandler(callable $handler)

No description

Parameters

callable $handler

Return Value

Engine

at line 436
Engine setSandboxMode(bool $state = true)

No description

Parameters

bool $state

Return Value

Engine

at line 443
Engine setContentType(string $type)

No description

Parameters

string $type

Return Value

Engine

at line 453
Engine setTempDirectory(string|null $path)

Sets path to temporary directory.

Parameters

string|null $path

Return Value

Engine

at line 463
Engine setAutoRefresh(bool $state = true)

Sets auto-refresh mode.

Parameters

bool $state

Return Value

Engine

at line 473
Engine setStrictTypes(bool $state = true)

Enables declare(strict_types=1) in templates.

Parameters

bool $state

Return Value

Engine

at line 480
Engine setStrictParsing(bool $state = true)

No description

Parameters

bool $state

Return Value

Engine

at line 487
bool isStrictParsing()

No description

Return Value

bool

at line 496
Engine setLocale(string|null $locale)

Sets the locale. It uses the same identifiers as the PHP intl extension.

Parameters

string|null $locale

Return Value

Engine

at line 506
string|null getLocale()

No description

Return Value

string|null

at line 512
Engine setLoader(Loader $loader)

No description

Parameters

Loader $loader

Return Value

Engine

at line 519
Loader getLoader()

No description

Return Value

Loader

at line 525
Engine enablePhpLinter(string|null $phpBinary)

No description

Parameters

string|null $phpBinary

Return Value

Engine

at line 535
Engine setSyntax(string $syntax)

Sets default Latte syntax. Available options: 'single', 'double', 'off'

Parameters

string $syntax

Return Value

Engine

at line 542
Engine setMigrationWarnings(bool $state = true)

No description

Parameters

bool $state

Return Value

Engine