Login Register

DelegatingEngine

class DelegatingEngine extends DelegatingEngine implements EngineInterface

DelegatingEngine selects an engine for a given template.

Methods

	__construct(ContainerInterface $container, array $engineIds) Constructor.
string	render(string\|TemplateReferenceInterface $name, array $parameters = array()) Renders a template.	from DelegatingEngine
	stream(string\|TemplateReferenceInterface $name, array $parameters = array()) Streams a template.	from DelegatingEngine
bool	exists(string\|TemplateReferenceInterface $name) Returns true if the template exists.	from DelegatingEngine
	addEngine(EngineInterface $engine) Adds an engine.	from DelegatingEngine
bool	supports(string\|TemplateReferenceInterface $name) Returns true if this class is able to render the given template.	from DelegatingEngine
EngineInterface	getEngine(string\|TemplateReferenceInterface $name) Get an engine able to render the given template.
Response	renderResponse(string $view, array $parameters = array(), Response $response = null) Renders a view and returns a Response.

Details

__construct(ContainerInterface $container, array $engineIds)

Constructor.

Parameters

ContainerInterface	$container	The DI container
array	$engineIds	An array of engine Ids

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

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

Streams a template.

The implementation should output the content directly to the client.

Parameters

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

Exceptions

RuntimeException	if the template cannot be rendered
LogicException	if the template cannot be streamed

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

addEngine(EngineInterface $engine)

Adds an engine.

Parameters

EngineInterface

$engine

An EngineInterface instance

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

EngineInterface getEngine(string|TemplateReferenceInterface $name)

Get an engine able to render the given template.

Parameters

string|TemplateReferenceInterface

$name

A template name or a TemplateReferenceInterface instance

Return Value

EngineInterface

The engine

Exceptions

RuntimeException

if no engine able to work with the template is found

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

A Response instance

Exceptions

RuntimeException

if the template cannot be rendered

Links:

http://api.symfony.com/master/Symfony/Bundle/FrameworkBundle/Templating/DelegatingEngine.html

doc_Symfony

2016-10-28 06:13:59

Comments

Leave a Comment

Please login to continue.

Popular Articles

DelegatingEngine class DelegatingEngine implements EngineInterface, StreamingEngineInterface DelegatingEngine selects an engine for a given template. Methods _

DelegatingEngine::getEngine() EngineInterface getEngine(string|TemplateReferenceInterface $name) Get an engine able to render the given template. Parameters stri

DelegatingEngine::addEngine() addEngine(EngineInterface $engine) Adds an engine. Parameters EngineInterface $engine An EngineInterface instance

DelegatingEngine::render() string render(string|TemplateReferenceInterface $name, array $parameters = array()) Renders a template. Parameters string|TemplateRe

DelegatingEngine::stream() stream(string|TemplateReferenceInterface $name, array $parameters = array()) Streams a template. The implementation should output the cont