class Engine

Templating engine Latte.

Constants

Version

VersionId

deprecated VERSION

deprecated VERSION_ID

deprecated CONTENT_HTML

deprecated CONTENT_XML

deprecated CONTENT_JS

deprecated CONTENT_CSS

deprecated CONTENT_ICAL

deprecated 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 = [], $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)

No description

string
getTemplateClass(string $name)

No description

array
getCacheKey()

Values that affect the results of compilation and the name of the cache file.

array
getCacheSignature(string $name)

Values that check the expiration of the compiled template.

addFilter(string $name, callable $callback)

Registers run-time filter.

addFilterLoader(callable $loader)

Registers filter loader.

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

setLoader(Loader $loader)

No description

getLoader()

No description

enablePhpLinter(string|null $phpBinary)

No description

__get(string $name)

No description

Details

at line 55
__construct()

No description

at line 69
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 81
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 93
Template createTemplate(string $name, array $params = [], $clearCache = true)

Creates template object.

Parameters

string $name
array $params
$clearCache

Return Value

Template

at line 115
string compile(string $name)

Compiles template to PHP code.

Parameters

string $name

Return Value

string

at line 147
TemplateNode parse(string $template)

Parses template to AST node.

Parameters

string $template

Return Value

TemplateNode

at line 167
void applyPasses(TemplateNode $node)

Calls node visitors.

Parameters

TemplateNode $node

Return Value

void

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

Generates compiled PHP code.

Parameters

TemplateNode $node
string $name

Return Value

string

at line 201
void warmupCache(string $name)

Compiles template to cache.

Parameters

string $name

Return Value

void

Exceptions

LogicException

at line 301
string getCacheFile(string $name)

No description

Parameters

string $name

Return Value

string

at line 310
string getTemplateClass(string $name)

No description

Parameters

string $name

Return Value

string

at line 327
protected array getCacheKey()

Values that affect the results of compilation and the name of the cache file.

Return Value

array

at line 347
protected array getCacheSignature(string $name)

Values that check the expiration of the compiled template.

Parameters

string $name

Return Value

array

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

Registers run-time filter.

Parameters

string $name
callable $callback

Return Value

Engine

at line 377
Engine addFilterLoader(callable $loader)

Registers filter loader.

Parameters

callable $loader

Return Value

Engine

at line 388
array getFilters()

Returns all run-time filters.

Return Value

array

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

Call a run-time filter.

Parameters

string $name
array $args

Return Value

mixed

at line 407
Engine addExtension(Extension $extension)

Adds new extension.

Parameters

Extension $extension

Return Value

Engine

at line 426
array getExtensions()

No description

Return Value

array

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

Registers run-time function.

Parameters

string $name
callable $callback

Return Value

Engine

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

Call a run-time function.

Parameters

string $name
array $args

Return Value

mixed

at line 459
array getFunctions()

No description

Return Value

array

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

Adds new provider.

Parameters

string $name
mixed $provider

Return Value

Engine

at line 483
array getProviders()

Returns all providers.

Return Value

array

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

No description

Parameters

Policy|null $policy

Return Value

Engine

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

No description

Parameters

bool $effective

Return Value

Policy|null

at line 504
Engine setExceptionHandler(callable $handler)

No description

Parameters

callable $handler

Return Value

Engine

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

No description

Parameters

bool $state

Return Value

Engine

at line 518
Engine setContentType(string $type)

No description

Parameters

string $type

Return Value

Engine

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

Sets path to temporary directory.

Parameters

string|null $path

Return Value

Engine

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

Sets auto-refresh mode.

Parameters

bool $state

Return Value

Engine

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

Enables declare(strict_types=1) in templates.

Parameters

bool $state

Return Value

Engine

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

No description

Parameters

bool $state

Return Value

Engine

at line 562
bool isStrictParsing()

No description

Return Value

bool

at line 568
Engine setLoader(Loader $loader)

No description

Parameters

Loader $loader

Return Value

Engine

at line 575
Loader getLoader()

No description

Return Value

Loader

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

No description

Parameters

string|null $phpBinary

Return Value

Engine

at line 623
__get(string $name)

No description

Parameters

string $name