Symfony2 API
Class

Symfony\Bundle\FrameworkBundle\Templating\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(mixed $name, array $parameters = array())

Renders a template.

 from PhpEngine
Boolean exists(mixed $name)

Returns true if the template exists.

 from PhpEngine
Boolean supports(mixed $name)

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

 from PhpEngine
mixed offsetGet(string $name)

Gets a helper value.

 from PhpEngine
Boolean 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)

from PhpEngine
setHelpers(array $helpers)

Sets the helpers.
set(HelperInterface $helper, string $alias = null)

Sets a helper.

 from PhpEngine
Boolean 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)

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 37
public __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 78
public string render(mixed $name, array $parameters = array())

Renders a template.

Parameters

mixed $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 115
public Boolean exists(mixed $name)

Returns true if the template exists.

Parameters

mixed $name A template name or a TemplateReferenceInterface instance

Return Value

Boolean true if the template exists, false otherwise

in PhpEngine at line 135
public Boolean supports(mixed $name)

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

Parameters

mixed $name A template name or a TemplateReferenceInterface instance

Return Value

Boolean true if this class supports the given resource, false otherwise

in PhpEngine at line 188
public mixed offsetGet(string $name)

Gets a helper value.

Parameters

string $name The helper name

Return Value

mixed The helper value

Exceptions

InvalidArgumentException if the helper is not defined

in PhpEngine at line 202
public Boolean offsetExists(string $name)

Returns true if the helper is defined.

Parameters

string $name The helper name

Return Value

Boolean true if the helper is defined, false otherwise

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

Sets a helper.

Parameters

HelperInterface $name The helper instance
string $value An alias

in PhpEngine at line 227
public offsetUnset(string $name)

Removes a helper.

Parameters

string $name The helper name

in PhpEngine at line 237
public addHelpers(array $helpers)

Parameters

array $helpers An array of helper

at line 68
public setHelpers(array $helpers)

Sets the helpers.

Parameters

array $helpers An array of helper

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

Sets a helper.

Parameters

HelperInterface $helper The helper instance
string $alias An alias

in PhpEngine at line 284
public Boolean has(string $name)

Returns true if the helper if defined.

Parameters

string $name The helper name

Return Value

Boolean true if the helper is defined, false otherwise

at line 51
public 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 316
public extend(string $template)

Decorates the current template with another one.

Parameters

string $template The decorator logical name

in PhpEngine at line 331
public 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 343
public setCharset(string $charset)

Sets the charset to use.

Parameters

string $charset The charset

in PhpEngine at line 355
public string getCharset()

Gets the current charset.

Return Value

string The current charset

in PhpEngine at line 368
public 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 382
public mixed getEscaper(string $context)

Gets an escaper for a given context.

Parameters

string $context The context name

Return Value

mixed $escaper A PHP callable

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

Parameters

string $name
mixed $value

in PhpEngine at line 409
public array getGlobals()

Returns the assigned globals.

Return Value

array

in PhpEngine at line 501
public 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 517
public LoaderInterface getLoader()

Gets the loader associated with this engine.

Return Value

LoaderInterface A LoaderInterface instance

at line 82
public 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