PhpEngine

class PhpEngine implements EngineInterface, ArrayAccess

PhpEngine is an engine able to render PHP templates.

Methods

	__construct(TemplateNameParserInterface $parser, LoaderInterface $loader, array $helpers = array()) Constructor.
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.
HelperInterface	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.
HelperInterface	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)
array	getGlobals() Returns the assigned globals.
LoaderInterface	getLoader() Gets the loader associated with this engine.

Details

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

Constructor.

Parameters

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

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

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

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

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

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

offsetSet(HelperInterface $name, string $value)

Sets a helper.

Parameters

HelperInterface	$name	The helper instance
string	$value	An alias

offsetUnset(string $name)

Removes a helper.

Parameters

string

$name

The helper name

Exceptions

LogicException

addHelpers(array $helpers)

Adds some helpers.

Parameters

array

$helpers

An array of helper

setHelpers(array $helpers)

Sets the helpers.

Parameters

array

$helpers

An array of helper

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

Sets a helper.

Parameters

HelperInterface	$helper	The helper instance
string	$alias	An alias

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

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

extend(string $template)

Decorates the current template with another one.

Parameters

string

$template

The decorator logical name

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

setCharset(string $charset)

Sets the charset to use.

Parameters

string

$charset

The charset

string getCharset()

Gets the current charset.

Return Value

string

The current charset

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

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

addGlobal(string $name, mixed $value)

Parameters

string	$name
mixed	$value

array getGlobals()

Returns the assigned globals.

Return Value

array

LoaderInterface getLoader()

Gets the loader associated with this engine.

Return Value

LoaderInterface

A LoaderInterface instance

Links:

http://api.symfony.com/master/Symfony/Component/Templating/PhpEngine.html

doc_Symfony

2016-10-28 06:26:22

Comments