class PhpEngine extends PhpEngine implements EngineInterface

This engine knows how to render Symfony templates.

Properties

protected $loader from PhpEngine
protected $current from PhpEngine
protected HelperInterface[] $helpers from PhpEngine
protected $parents from PhpEngine
protected $stack from PhpEngine
protected $charset from PhpEngine
protected $cache from PhpEngine
protected $escapers from PhpEngine
static protected $escaperCache from PhpEngine
protected $globals from PhpEngine
protected $parser from PhpEngine
protected $container

Methods

__construct(TemplateNameParserInterface $parser, ContainerInterface $container, LoaderInterface $loader, GlobalVariables $globals = null)

No description

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

Renders a template.

from PhpEngine
bool
exists(string|TemplateReferenceInterface $name)

Returns true if the template exists.

from PhpEngine
bool
supports(string|TemplateReferenceInterface $name)

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

from PhpEngine
string|false
evaluate(Storage $template, array $parameters = [])

Evaluates a template.

from PhpEngine
offsetGet(string $name)

Gets a helper value.

from PhpEngine
bool
offsetExists(string $name)

Returns true if the helper is defined.

from PhpEngine
offsetSet(HelperInterface $name, string $value)

Sets a helper.

from PhpEngine
offsetUnset(string $name)

Removes a helper.

from PhpEngine
addHelpers(array $helpers)

Adds some helpers.

from PhpEngine
setHelpers(array $helpers)

Sets the helpers.

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

Sets a helper.

from PhpEngine
bool
has(string $name)

Returns true if the helper if defined.

from PhpEngine
get(string $name)

Gets a helper value.

extend(string $template)

Decorates the current template with another one.

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

Escapes a string by using the current charset.

from PhpEngine
setCharset(string $charset)

Sets the charset to use.

from PhpEngine
string
getCharset()

Gets the current charset.

from PhpEngine
setEscaper(string $context, callable $escaper)

Adds an escaper for the given context.

from PhpEngine
callable
getEscaper(string $context)

Gets an escaper for a given context.

from PhpEngine
addGlobal(string $name, mixed $value)

No description

from PhpEngine
array
getGlobals()

Returns the assigned globals.

from PhpEngine
initializeEscapers()

Initializes the built-in escapers.

from PhpEngine
getLoader()

Gets the loader associated with this engine.

from PhpEngine
load(string|TemplateReferenceInterface $name)

Loads the given template.

from PhpEngine
renderResponse(string $view, array $parameters = [], Response $response = null)

Renders a view and returns a Response.

Details

at line 29
__construct(TemplateNameParserInterface $parser, ContainerInterface $container, LoaderInterface $loader, GlobalVariables $globals = null)

Parameters

TemplateNameParserInterface $parser A TemplateNameParserInterface instance
ContainerInterface $container
LoaderInterface $loader A loader instance
GlobalVariables $globals

in PhpEngine at line 68
string render(string|TemplateReferenceInterface $name, array $parameters = [])

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

in PhpEngine at 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

in PhpEngine at 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

in PhpEngine at line 130
protected string|false evaluate(Storage $template, array $parameters = [])

Evaluates a template.

Parameters

Storage $template The template to render
array $parameters An array of parameters to pass to the template

Return Value

string|false The evaluated template, or false if the engine is unable to render the template

Exceptions

InvalidArgumentException

in PhpEngine at 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

in PhpEngine at 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

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

Sets a helper.

Parameters

HelperInterface $name The helper instance
string $value An alias

in PhpEngine at line 214
offsetUnset(string $name)

Removes a helper.

Parameters

string $name The helper name

Exceptions

LogicException

in PhpEngine at line 224
addHelpers(array $helpers)

Adds some helpers.

Parameters

array $helpers An array of helper

at line 60
setHelpers(array $helpers)

Sets the helpers.

Parameters

array $helpers An array of helper

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

Sets a helper.

Parameters

HelperInterface $helper The helper instance
string $alias An alias

in PhpEngine at 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 43
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

in PhpEngine at line 293
extend(string $template)

Decorates the current template with another one.

Parameters

string $template The decorator logical name

in PhpEngine at 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

in PhpEngine at line 330
setCharset(string $charset)

Sets the charset to use.

Parameters

string $charset The charset

in PhpEngine at line 347
string getCharset()

Gets the current charset.

Return Value

string The current charset

in PhpEngine at line 358
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

in PhpEngine at line 373
callable getEscaper(string $context)

Gets an escaper for a given context.

Parameters

string $context The context name

Return Value

callable A PHP callable

Exceptions

InvalidArgumentException

in PhpEngine at line 386
addGlobal(string $name, mixed $value)

Parameters

string $name
mixed $value

in PhpEngine at line 396
array getGlobals()

Returns the assigned globals.

Return Value

array

in PhpEngine at line 418
protected initializeEscapers()

Initializes the built-in escapers.

Each function specifies a way for applying a transformation to a string passed to it. The purpose is for the string to be "escaped" so it is suitable for the format it is being displayed in.

For example, the string: "It's required that you enter a username & password.\n" If this were to be displayed as HTML it would be sensible to turn the ampersand into '&' and the apostrophe into '&aps;'. However if it were going to be used as a string in JavaScript to be displayed in an alert box it would be right to leave the string as-is, but c-escape the apostrophe and the new line.

For each function there is a define to avoid problems with strings being incorrectly specified.

in PhpEngine at line 485
LoaderInterface getLoader()

Gets the loader associated with this engine.

Return Value

LoaderInterface A LoaderInterface instance

in PhpEngine at line 499
protected Storage load(string|TemplateReferenceInterface $name)

Loads the given template.

Parameters

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

Return Value

Storage A Storage instance

Exceptions

InvalidArgumentException if the template cannot be found

at line 68
Response renderResponse(string $view, array $parameters = [], Response $response = null)

Renders a view and returns a Response.

Parameters

string $view The view name
array $parameters An array of parameters to pass to the view
Response $response A Response instance

Return Value

Response A Response instance

Exceptions

RuntimeException if the template cannot be rendered