TwigEngine

class TwigEngine implements EngineInterface, StreamingEngineInterface

This engine knows how to render Twig templates.

Methods

__construct(Twig_Environment $environment, TemplateNameParserInterface $parser)

Constructor.

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.

bool supports(string|TemplateReferenceInterface $name)

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

Details

__construct(Twig_Environment $environment, TemplateNameParserInterface $parser)

Constructor.

Parameters

Twig_Environment $environment A \Twig_Environment instance
TemplateNameParserInterface $parser A TemplateNameParserInterface instance

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

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
doc_Symfony
2016-10-28 06:35:39
Comments
Leave a Comment

Please login to continue.