class PhpEngine implements EngineInterface, ArrayAccess

PhpEngine is an engine able to render PHP templates.

Methods

__construct(TemplateNameParserInterface $parser, LoaderInterface $loader, array $helpers = array())

No description

string
render(string|TemplateReferenceInterface $name, array $parameters = array())

Renders a template.

bool
exists(string|TemplateReferenceInterface $name)

Returns true if the template exists.

bool
supports(string|TemplateReferenceInterface $name)

Returns true if this class is able to render the given template.

offsetGet(string $name)

Gets a helper value.

bool
offsetExists(string $name)

Returns true if the helper is defined.

offsetSet(HelperInterface $name, string $value)

Sets a helper.

offsetUnset(string $name)

Removes a helper.

addHelpers(array $helpers)

Adds some helpers.

setHelpers(array $helpers)

Sets the helpers.

set(HelperInterface $helper, string $alias = null)

Sets a helper.

bool
has(string $name)

Returns true if the helper if defined.

get(string $name)

Gets a helper value.

extend(string $template)

Decorates the current template with another one.

string
escape(mixed $value, string $context = 'html')

Escapes a string by using the current charset.

setCharset(string $charset)

Sets the charset to use.

string
getCharset()

Gets the current charset.

setEscaper(string $context, callable $escaper)

Adds an escaper for the given context.

callable
getEscaper(string $context)

Gets an escaper for a given context.

addGlobal(string $name, mixed $value)

No description

array
getGlobals()

Returns the assigned globals.

string
convertEncoding(string $string, string $to, string $from)

Convert a string from one encoding to another.

getLoader()

Gets the loader associated with this engine.

Details

at line line 50
__construct(TemplateNameParserInterface $parser, LoaderInterface $loader, array $helpers = array())

Parameters

TemplateNameParserInterface $parser A TemplateNameParserInterface instance
LoaderInterface $loader A loader instance
array $helpers An array of helper instances

at line line 68
string render(string|TemplateReferenceInterface $name, array $parameters = array())

Renders a template.

Parameters

string|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance
array $parameters An array of parameters to pass to the template

Return Value

string The evaluated template as a string

Exceptions

RuntimeException if the template cannot be rendered

at line line 99
bool exists(string|TemplateReferenceInterface $name)

Returns true if the template exists.

Parameters

string|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance

Return Value

bool true if the template exists, false otherwise

Exceptions

RuntimeException if the engine cannot handle the template name

at line line 113
bool supports(string|TemplateReferenceInterface $name)

Returns true if this class is able to render the given template.

Parameters

string|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance

Return Value

bool true if this class supports the given template, false otherwise

at line line 179
HelperInterface offsetGet(string $name)

Gets a helper value.

Parameters

string $name The helper name

Return Value

HelperInterface The helper value

Exceptions

InvalidArgumentException if the helper is not defined

at line line 191
bool offsetExists(string $name)

Returns true if the helper is defined.

Parameters

string $name The helper name

Return Value

bool true if the helper is defined, false otherwise

at line line 202
offsetSet(HelperInterface $name, string $value)

Sets a helper.

Parameters

HelperInterface $name The helper instance
string $value An alias

at line line 214
offsetUnset(string $name)

Removes a helper.

Parameters

string $name The helper name

Exceptions

LogicException

at line line 224
addHelpers(array $helpers)

Adds some helpers.

Parameters

array $helpers An array of helper

at line line 236
setHelpers(array $helpers)

Sets the helpers.

Parameters

array $helpers An array of helper

at line line 248
set(HelperInterface $helper, string $alias = null)

Sets a helper.

Parameters

HelperInterface $helper The helper instance
string $alias An alias

at line line 265
bool has(string $name)

Returns true if the helper if defined.

Parameters

string $name The helper name

Return Value

bool true if the helper is defined, false otherwise

at line line 279
HelperInterface get(string $name)

Gets a helper value.

Parameters

string $name The helper name

Return Value

HelperInterface The helper instance

Exceptions

InvalidArgumentException if the helper is not defined

at line line 293
extend(string $template)

Decorates the current template with another one.

Parameters

string $template The decorator logical name

at line line 306
string escape(mixed $value, string $context = 'html')

Escapes a string by using the current charset.

Parameters

mixed $value A variable to escape
string $context The context name

Return Value

string The escaped value

at line line 330
setCharset(string $charset)

Sets the charset to use.

Parameters

string $charset The charset

at line line 344
string getCharset()

Gets the current charset.

Return Value

string The current charset

at line line 355
setEscaper(string $context, callable $escaper)

Adds an escaper for the given context.

Parameters

string $context The escaper context (html, js, ...)
callable $escaper A PHP callable

at line line 370
callable getEscaper(string $context)

Gets an escaper for a given context.

Parameters

string $context The context name

Return Value

callable $escaper A PHP callable

Exceptions

InvalidArgumentException

at line line 383
addGlobal(string $name, mixed $value)

Parameters

string $name
mixed $value

at line line 393
array getGlobals()

Returns the assigned globals.

Return Value

array

at line line 493
string convertEncoding(string $string, string $to, string $from)

Convert a string from one encoding to another.

Parameters

string $string The string to convert
string $to The input encoding
string $from The output encoding

Return Value

string The string with the new encoding

Exceptions

RuntimeException if no suitable encoding function is found (iconv or mbstring)

at line line 509
LoaderInterface getLoader()

Gets the loader associated with this engine.

Return Value

LoaderInterface A LoaderInterface instance