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

Creates template object.

string
compile(string $name)

Compiles template to PHP code.

TemplateNode
parse(string $source)

Parses template to AST node.

void
applyPasses(TemplateNode $node)

Calls node visitors.

string
generate(TemplateNode $node, string $name)

Generates template PHP code.

void
warmupCache(string $name)

Compiles template to cache.

string
getCacheFile(string $name)

No description

string
getTemplateClass(string $name)

No description

Engine
addFilter(string $name, callable $callback)

Registers run-time filter.

Engine
addFilterLoader(callable $callback)

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 $value)

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 $callback)

No description

Engine
setSandboxMode(bool $on = true)

No description

Engine
setContentType(string $type)

No description

Engine
setTempDirectory(string|null $path)

Sets path to temporary directory.

Engine
setAutoRefresh(bool $on = true)

Sets auto-refresh mode.

Engine
setStrictTypes(bool $on = true)

Enables declare(strict_types=1) in templates.

Engine
setStrictParsing(bool $on = true)

No description

bool
isStrictParsing()

No description

Engine
setLoader(Loader $loader)

No description

Loader
getLoader()

No description

Engine
enablePhpLinter(string|null $phpBinary)

No description

__get(string $name)

No description

Details

at line 54
__construct()

No description

at line 68
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 80
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 92
Template createTemplate(string $name, array $params = [])

Creates template object.

Parameters

string $name
array $params

Return Value

Template

at line 113
string compile(string $name)

Compiles template to PHP code.

Parameters

string $name

Return Value

string

at line 145
TemplateNode parse(string $source)

Parses template to AST node.

Parameters

string $source

Return Value

TemplateNode

at line 165
void applyPasses(TemplateNode $node)

Calls node visitors.

Parameters

TemplateNode $node

Return Value

void

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

Generates template PHP code.

Parameters

TemplateNode $node
string $name

Return Value

string

at line 200
void warmupCache(string $name)

Compiles template to cache.

Parameters

string $name

Return Value

void

Exceptions

LogicException

at line 308
string getCacheFile(string $name)

No description

Parameters

string $name

Return Value

string

at line 318
string getTemplateClass(string $name)

No description

Parameters

string $name

Return Value

string

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

Registers run-time filter.

Parameters

string $name
callable $callback

Return Value

Engine

at line 354
Engine addFilterLoader(callable $callback)

Registers filter loader.

Parameters

callable $callback

Return Value

Engine

at line 365
array getFilters()

Returns all run-time filters.

Return Value

array

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

Call a run-time filter.

Parameters

string $name
array $args

Return Value

mixed

at line 384
Engine addExtension(Extension $extension)

Adds new extension.

Parameters

Extension $extension

Return Value

Engine

at line 403
array getExtensions()

No description

Return Value

array

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

Registers run-time function.

Parameters

string $name
callable $callback

Return Value

Engine

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

Call a run-time function.

Parameters

string $name
array $args

Return Value

mixed

at line 443
array getFunctions()

No description

Return Value

array

at line 452
Engine addProvider(string $name, mixed $value)

Adds new provider.

Parameters

string $name
mixed $value

Return Value

Engine

at line 467
array getProviders()

Returns all providers.

Return Value

array

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

No description

Parameters

Policy|null $policy

Return Value

Engine

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

No description

Parameters

bool $effective

Return Value

Policy|null

at line 488
Engine setExceptionHandler(callable $callback)

No description

Parameters

callable $callback

Return Value

Engine

at line 495
Engine setSandboxMode(bool $on = true)

No description

Parameters

bool $on

Return Value

Engine

at line 502
Engine setContentType(string $type)

No description

Parameters

string $type

Return Value

Engine

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

Sets path to temporary directory.

Parameters

string|null $path

Return Value

Engine

at line 522
Engine setAutoRefresh(bool $on = true)

Sets auto-refresh mode.

Parameters

bool $on

Return Value

Engine

at line 532
Engine setStrictTypes(bool $on = true)

Enables declare(strict_types=1) in templates.

Parameters

bool $on

Return Value

Engine

at line 539
Engine setStrictParsing(bool $on = true)

No description

Parameters

bool $on

Return Value

Engine

at line 546
bool isStrictParsing()

No description

Return Value

bool

at line 552
Engine setLoader(Loader $loader)

No description

Parameters

Loader $loader

Return Value

Engine

at line 559
Loader getLoader()

No description

Return Value

Loader

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

No description

Parameters

string|null $phpBinary

Return Value

Engine

at line 611
__get(string $name)

No description

Parameters

string $name