Symfony2 API
Class

Symfony\Bundle\FrameworkBundle\Templating\DelegatingEngine

class DelegatingEngine extends DelegatingEngine implements EngineInterface

DelegatingEngine selects an engine for a given template.

Methods

__construct(ContainerInterface $container, array $engineIds)

Constructor.
string render(mixed $name, array $parameters = array())

Renders a template.

 from DelegatingEngine
stream(mixed $name, array $parameters = array())

Streams a template.

 from DelegatingEngine
Boolean exists(mixed $name)

Returns true if the template exists.

 from DelegatingEngine
addEngine(EngineInterface $engine)

Adds an engine.

 from DelegatingEngine
Boolean supports(mixed $name)

Returns true if this class is able to render the given template.
EngineInterface getEngine(mixed $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

at line 34
public __construct(ContainerInterface $container, array $engineIds)

Constructor.

Parameters

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

in DelegatingEngine at line 48
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 DelegatingEngine at line 58
public stream(mixed $name, array $parameters = array())

Streams a template.

The implementation should output the content directly to the client.

Parameters

mixed $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 73
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 DelegatingEngine at line 85
public addEngine(EngineInterface $engine)

Adds an engine.

Parameters

EngineInterface $engine An EngineInterface instance

at line 43
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 template, false otherwise

at line 61
public EngineInterface getEngine(mixed $name)

Get an engine able to render the given template.

Parameters

mixed $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 85
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