Interface

Symfony\Bundle\FrameworkBundle\Templating\EngineInterface

interface EngineInterface implements EngineInterface

EngineInterface is the interface each engine must implement.

Methods

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

Renders a template.

from EngineInterface
Boolean exists(string|TemplateReferenceInterface $name)

Returns true if the template exists.

from EngineInterface
Boolean supports(string|TemplateReferenceInterface $name)

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

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

Renders a view and returns a Response.

Details

in EngineInterface 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

in EngineInterface at line 60
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

in EngineInterface at line 71
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 35
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

Exceptions

RuntimeException if the template cannot be rendered