class TwigEngine extends TwigEngine implements EngineInterface

This engine renders Twig templates.

Properties

protected $environment from TwigEngine
protected $parser from TwigEngine
protected $locator

Methods

__construct(Environment $environment, TemplateNameParserInterface $parser, FileLocatorInterface $locator)

No description

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

Renders a template.

stream(string|TemplateReferenceInterface $name, array $parameters = [])

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.

renderResponse(string $view, array $parameters = [], Response $response = null)

Renders a view and returns a Response.

Details

at line 32
__construct(Environment $environment, TemplateNameParserInterface $parser, FileLocatorInterface $locator)

Parameters

Environment $environment
TemplateNameParserInterface $parser
FileLocatorInterface $locator

at line 42
string render(string|TemplateReferenceInterface $name, array $parameters = [])

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 TwigEngine at line 59
stream(string|TemplateReferenceInterface $name, array $parameters = [])

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

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

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

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

at line 66
Response renderResponse(string $view, array $parameters = [], 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