class TwigEngine implements EngineInterface, StreamingEngineInterface

This engine knows how to render Twig templates.

Properties

protected $environment
protected $parser

Methods

__construct(Environment $environment, TemplateNameParserInterface $parser)

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.

bool
supports(string|TemplateReferenceInterface $name)

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

Template
load(string|TemplateReferenceInterface|Template $name)

Loads the given template.

Details

at line 34
__construct(Environment $environment, TemplateNameParserInterface $parser)

Parameters

Environment $environment
TemplateNameParserInterface $parser

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

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

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

at line 97
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 118
protected Template load(string|TemplateReferenceInterface|Template $name)

Loads the given template.

Parameters

string|TemplateReferenceInterface|Template $name A template name or an instance of TemplateReferenceInterface or Template

Return Value

Template

Exceptions

InvalidArgumentException if the template does not exist