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

Engine

class Engine

Templating engine Latte.

Constants

VERSION

VERSION_ID

CONTENT_HTML

Content types
CONTENT_XHTML

Content types
CONTENT_XML

Content types
CONTENT_JS

Content types
CONTENT_CSS

Content types
CONTENT_ICAL

Content types
CONTENT_TEXT

Content types

Properties

callable[] $onCompile

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.

void
warmupCache(string $name)

Compiles template to cache.

string
getCacheFile(string $name)

No description

string
getTemplateClass(string $name)

No description

Engine
addFilter(string|null $name, callable $callback)

Registers run-time filter.

array
getFilters()

Returns all run-time filters.

mixed
invokeFilter(string $name, array $args)

Call a run-time filter.

Engine
addMacro(string $name, Macro $macro)

Adds new macro.

Engine
addFunction(string $name, callable $callback)

Registers run-time function.

mixed
invokeFunction(string $name, array $args)

Call a run-time function.

Engine
addProvider(string $name, mixed $value)

Adds new provider.

array
getProviders()

Returns all providers.

Engine
setPolicy(Policy|null $policy)

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.

Parser
getParser()

No description

Compiler
getCompiler()

No description

Engine
setLoader(Loader $loader)

No description

Loader
getLoader()

No description

Details

at line 73
__construct()

No description

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

Creates template object.

Parameters

string $name
array $params

Return Value

Template

at line 121
string compile(string $name)

Compiles template to PHP code.

Parameters

string $name

Return Value

string

at line 168
void warmupCache(string $name)

Compiles template to cache.

Parameters

string $name

Return Value

void

Exceptions

LogicException

at line 258
string getCacheFile(string $name)

No description

Parameters

string $name

Return Value

string

at line 268
string getTemplateClass(string $name)

No description

Parameters

string $name

Return Value

string

at line 279
Engine addFilter(string|null $name, callable $callback)

Registers run-time filter.

Parameters

string|null $name
callable $callback

Return Value

Engine

at line 290
array getFilters()

Returns all run-time filters.

Return Value

array

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

Call a run-time filter.

Parameters

string $name
array $args

Return Value

mixed

at line 311
Engine addMacro(string $name, Macro $macro)

Adds new macro.

Parameters

string $name
Macro $macro

Return Value

Engine

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

Registers run-time function.

Parameters

string $name
callable $callback

Return Value

Engine

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

Call a run-time function.

Parameters

string $name
array $args

Return Value

mixed

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

Adds new provider.

Parameters

string $name
mixed $value

Return Value

Engine

at line 363
array getProviders()

Returns all providers.

Return Value

array

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

No description

Parameters

Policy|null $policy

Return Value

Engine

at line 378
Engine setExceptionHandler(callable $callback)

No description

Parameters

callable $callback

Return Value

Engine

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

No description

Parameters

bool $on

Return Value

Engine

at line 394
Engine setContentType(string $type)

No description

Parameters

string $type

Return Value

Engine

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

Sets path to temporary directory.

Parameters

string|null $path

Return Value

Engine

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

Sets auto-refresh mode.

Parameters

bool $on

Return Value

Engine

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

Enables declare(strict_types=1) in templates.

Parameters

bool $on

Return Value

Engine

at line 434
Parser getParser()

No description

Return Value

Parser

at line 444
Compiler getCompiler()

No description

Return Value

Compiler

at line 457
Engine setLoader(Loader $loader)

No description

Parameters

Loader $loader

Return Value

Engine

at line 464
Loader getLoader()

No description

Return Value

Loader

Traits

Strict

Better OOP experience.