1. class
  2. Symfony
  3. \
  4. Bundle
  5. \
  6. FrameworkBundle
  7. \
  8. Templating
  9. \
  10. DelegatingEngine

DelegatingEngine

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.

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)

No description

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)

Parameters

ContainerInterface $container
array $engineIds

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)

Parameters

EngineInterface $engine

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

Response A Response instance

Exceptions

RuntimeException if the template cannot be rendered