Class

Symfony\Component\Templating\DelegatingEngine

class DelegatingEngine implements EngineInterface, StreamingEngineInterface

DelegatingEngine selects an engine for a given template.

Methods

__construct(array $engines = array())

Constructor.

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

Renders a template.

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

Streams a template.

Boolean exists(string|TemplateReferenceInterface $name)

Returns true if the template exists.

addEngine(EngineInterface $engine)

Adds an engine.

Boolean supports(string|TemplateReferenceInterface $name)

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

EngineInterface getEngine(string|TemplateReferenceInterface $name)

Get an engine able to render the given template.

Details

at line 35
public __construct(array $engines = array())

Constructor.

Parameters

array $engines An array of EngineInterface instances to add

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

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

at line 72
public Boolean exists(string|TemplateReferenceInterface $name)

Returns true if the template exists.

Parameters

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

Return Value

Boolean true if the template exists, false otherwise

Exceptions

RuntimeException if the engine cannot handle the template name

at line 84
public addEngine(EngineInterface $engine)

Adds an engine.

Parameters

EngineInterface $engine An EngineInterface instance

at line 94
public Boolean 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

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

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