PHP Interface Symfony\Component\Templating\EngineInterface

All methods relies on a template name. A template name is a "logical" name for the template, and as such it does not refer to a path on the filesystem (in fact, the template can be stored anywhere, like in a database). The methods should accept any name. If the name is not an instance of TemplateReferenceInterface, a TemplateNameParserInterface should be used to convert the name to a TemplateReferenceInterface instance. Each template loader use the logical template name to look for the template.
Author: Fabien Potencier ([email protected])
Show file Open project: pmjones/php-framework-benchmarks Interface Usage Examples

Public Methods

Method Description
exists ( mixed $name ) : boolean Returns true if the template exists.
render ( mixed $name, array $parameters = [] ) : string Renders a template.
supports ( mixed $name ) : boolean Returns true if this class is able to render the given template.

Method Details

exists() public method

Returns true if the template exists.
public exists ( mixed $name ) : boolean
$name mixed A template name or a TemplateReferenceInterface instance
return boolean true if the template exists, false otherwise

render() public method

Renders a template.
public render ( mixed $name, array $parameters = [] ) : string
$name mixed A template name or a TemplateReferenceInterface instance
$parameters array An array of parameters to pass to the template
return string The evaluated template as a string

supports() public method

Returns true if this class is able to render the given template.
public supports ( mixed $name ) : boolean
$name mixed A template name or a TemplateReferenceInterface instance
return boolean true if this class supports the given template, false otherwise