1. class
  2. Latte
  3. \
  4. Engine

Engine

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.

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

Creates template object.

string
compile(string $name)

Compiles template to PHP code.

TemplateNode
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
getCacheKey()

Returns values that determine isolation for different configurations.

Engine
addFilter(string $name, callable $callback)

Registers run-time filter.

Engine
addFilterLoader(callable $loader)

Registers filter loader.

array
getFilters()

Returns all run-time filters.

mixed
invokeFilter(string $name, array $args)

Call a run-time filter.

Engine
addExtension(Extension $extension)

Adds new extension.

array
getExtensions()

No description

Engine
addFunction(string $name, callable $callback)

Registers run-time function.

mixed
invokeFunction(string $name, array $args)

Call a run-time function.

array
getFunctions()

No description

Engine
addProvider(string $name, mixed $provider)

Adds new provider.

array
getProviders()

Returns all providers.

Engine
setPolicy(Policy|null $policy)

No description

Policy|null
getPolicy(bool $effective = false)

No description

Engine
setExceptionHandler(callable $handler)

No description

Engine
setSandboxMode(bool $state = true)

No description

Engine
setContentType(string $type)

No description

Engine
setCacheDirectory(string|null $path)

Sets path to temporary directory.

Engine
setTempDirectory(string|null $path)

No description

Engine
setAutoRefresh(bool $state = true)

Sets auto-refresh mode.

Engine
setFeature(string $feature, bool $state = true)

Enables or disables an engine feature.

bool
hasFeature(string $feature)

Checks if a feature is enabled.

Engine
setStrictTypes(bool $state = true)

Enables declare(strict_types=1) in templates.

Engine
setStrictParsing(bool $state = true)

No description

bool
isStrictParsing()

No description

Engine
setLocale(string|null $locale)

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

string|null
getLocale()

No description

Engine
setLoader(Loader $loader)

No description

Loader
getLoader()

No description

Engine
enablePhpLinter(string|null $phpBinary)

No description

Engine
setSyntax(string $syntax)

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

__get(string $name)

No description

Details

at line 61
__construct()

No description

at line 76
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 88
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 100
Template createTemplate(string $name, array $params = [], bool $clearCache = true)

Creates template object.

Parameters

string $name
array $params
bool $clearCache

Return Value

Template

at line 118
string compile(string $name)

Compiles template to PHP code.

Parameters

string $name

Return Value

string

at line 150
TemplateNode parse(string $template)

Parses template to AST node.

Parameters

string $template

Return Value

TemplateNode

at line 171
void applyPasses(TemplateNode $node)

Calls node visitors.

Parameters

TemplateNode $node

Return Value

void

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

Generates compiled PHP code.

Parameters

TemplateNode $node
string $name

Return Value

string

at line 205
void warmupCache(string $name)

Compiles template to cache.

Parameters

string $name

Return Value

void

Exceptions

LogicException

at line 236
string getCacheFile(string $name)

Returns the file path where compiled template will be cached.

Parameters

string $name

Return Value

string

at line 245
string getTemplateClass(string $name)

Returns the PHP class name for compiled template.

Parameters

string $name

Return Value

string

at line 256
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 268
protected array getCacheKey()

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 285
Engine addFilter(string $name, callable $callback)

Registers run-time filter.

Parameters

string $name
callable $callback

Return Value

Engine

at line 299
Engine addFilterLoader(callable $loader)

Registers filter loader.

Parameters

callable $loader

Return Value

Engine

at line 310
array getFilters()

Returns all run-time filters.

Return Value

array

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

Call a run-time filter.

Parameters

string $name
array $args

Return Value

mixed

at line 329
Engine addExtension(Extension $extension)

Adds new extension.

Parameters

Extension $extension

Return Value

Engine

at line 348
array getExtensions()

No description

Return Value

array

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

Registers run-time function.

Parameters

string $name
callable $callback

Return Value

Engine

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

Call a run-time function.

Parameters

string $name
array $args

Return Value

mixed

at line 381
array getFunctions()

No description

Return Value

array

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

Adds new provider.

Parameters

string $name
mixed $provider

Return Value

Engine

at line 405
array getProviders()

Returns all providers.

Return Value

array

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

No description

Parameters

Policy|null $policy

Return Value

Engine

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

No description

Parameters

bool $effective

Return Value

Policy|null

at line 426
Engine setExceptionHandler(callable $handler)

No description

Parameters

callable $handler

Return Value

Engine

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

No description

Parameters

bool $state

Return Value

Engine

at line 440
Engine setContentType(string $type)

No description

Parameters

string $type

Return Value

Engine

at line 450
Engine setCacheDirectory(string|null $path)

Sets path to temporary directory.

Parameters

string|null $path

Return Value

Engine

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

No description

Parameters

string|null $path

Return Value

Engine

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

Sets auto-refresh mode.

Parameters

bool $state

Return Value

Engine

at line 476
Engine setFeature(string $feature, bool $state = true)

Enables or disables an engine feature.

Parameters

string $feature
bool $state

Return Value

Engine

at line 486
bool hasFeature(string $feature)

Checks if a feature is enabled.

Parameters

string $feature

Return Value

bool

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

Enables declare(strict_types=1) in templates.

Parameters

bool $state

Return Value

Engine

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

No description

Parameters

bool $state

Return Value

Engine

at line 507
bool isStrictParsing()

No description

Return Value

bool

at line 516
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 526
string|null getLocale()

No description

Return Value

string|null

at line 532
Engine setLoader(Loader $loader)

No description

Parameters

Loader $loader

Return Value

Engine

at line 539
Loader getLoader()

No description

Return Value

Loader

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

No description

Parameters

string|null $phpBinary

Return Value

Engine

at line 555
Engine setSyntax(string $syntax)

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

Parameters

string $syntax

Return Value

Engine

at line 608
__get(string $name)

No description

Parameters

string $name