class DelegatingEngine extends DelegatingEngine implements EngineInterface

DelegatingEngine selects an engine for a given template.

Properties

protected EngineInterface[] $engines from DelegatingEngine
protected $container

Methods

__construct(ContainerInterface $container, array $engineIds)

No description

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

Renders a template.

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

Streams a template.

bool
exists(string|TemplateReferenceInterface $name)

Returns true if the template exists.

addEngine(EngineInterface $engine)

No description

bool
supports(string|TemplateReferenceInterface $name)

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

getEngine(string|TemplateReferenceInterface $name)

Get an engine able to render the given template.

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

Renders a view and returns a Response.

Details

at line 27
__construct(ContainerInterface $container, array $engineIds)

Parameters

ContainerInterface $container
array $engineIds

in DelegatingEngine at line 39
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 DelegatingEngine at line 47
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

in DelegatingEngine at line 60
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 DelegatingEngine at line 65
addEngine(EngineInterface $engine)

Parameters

EngineInterface $engine

in DelegatingEngine at line 73
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

at line 36
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

at line 46
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