1. class
  2. Symfony
  3. Bundle
  4. FrameworkBundle
  5. Templating
  6. PhpEngine

PhpEngine

class PhpEngine extends PhpEngine implements EngineInterface

This engine knows how to render Symfony templates.

Methods

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

Constructor.

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

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
HelperInterface
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
HelperInterface
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, mixed $escaper)

Adds an escaper for the given context.

from PhpEngine
mixed
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
string
convertEncoding(string $string, string $to, string $from)

Convert a string from one encoding to another.

from PhpEngine
LoaderInterface
getLoader()

Gets the loader associated with this engine.

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

Renders a view and returns a Response.

Details

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

Constructor.

Parameters

TemplateNameParserInterface $parser A TemplateNameParserInterface instance
ContainerInterface $container The DI container
LoaderInterface $loader A loader instance
GlobalVariables $globals A GlobalVariables instance or null

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

in PhpEngine at line line 111
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 line 127
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 line 194
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 line 208
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 line 221
offsetSet(HelperInterface $name, string $value)

Sets a helper.

Parameters

HelperInterface $name The helper instance
string $value An alias

in PhpEngine at line line 235
offsetUnset(string $name)

Removes a helper.

Parameters

string $name The helper name

Exceptions

LogicException

in PhpEngine at line line 247
addHelpers(array $helpers)

Adds some helpers.

Parameters

array $helpers An array of helper

at line line 68
setHelpers(array $helpers)

Sets the helpers.

Parameters

array $helpers An array of helper

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

Sets a helper.

Parameters

HelperInterface $helper The helper instance
string $alias An alias

in PhpEngine at line line 294
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 51
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 line 326
extend(string $template)

Decorates the current template with another one.

Parameters

string $template The decorator logical name

in PhpEngine at line line 341
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 line 367
setCharset(string $charset)

Sets the charset to use.

Parameters

string $charset The charset

in PhpEngine at line line 383
string getCharset()

Gets the current charset.

Return Value

string The current charset

in PhpEngine at line line 396
setEscaper(string $context, mixed $escaper)

Adds an escaper for the given context.

Parameters

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

in PhpEngine at line line 413
mixed getEscaper(string $context)

Gets an escaper for a given context.

Parameters

string $context The context name

Return Value

mixed $escaper A PHP callable

Exceptions

InvalidArgumentException

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

Parameters

string $name
mixed $value

in PhpEngine at line line 440
array getGlobals()

Returns the assigned globals.

Return Value

array

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

in PhpEngine at line line 550
LoaderInterface getLoader()

Gets the loader associated with this engine.

Return Value

LoaderInterface A LoaderInterface instance

at line line 76
Response renderResponse(string $view, array $parameters = array(), 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