Symfony2 API
Class

Symfony\Bundle\FrameworkBundle\Templating\TemplateReference

class TemplateReference extends TemplateReference

Internal representation of a template.

Methods

__construct($bundle = null, $controller = null, $name = null, $format = null, $engine = null)

__toString()

from TemplateReference
TemplateReferenceInterface set(string $name, string $value)

Sets a template parameter.

 from TemplateReference
string get(string $name)

Gets a template parameter.

 from TemplateReference
array all()

Gets the template parameters.

 from TemplateReference
string getPath()

Returns the path to the template.
string getLogicalName()

Returns the "logical" template name.

Details

at line 23
public __construct($bundle = null, $controller = null, $name = null, $format = null, $engine = null)

Parameters

$bundle
$controller
$name
$format
$engine

in TemplateReference at line 33
public __toString()

in TemplateReference at line 50
public TemplateReferenceInterface set(string $name, string $value)

Sets a template parameter.

Parameters

string $name The parameter name
string $value The parameter value

Return Value

TemplateReferenceInterface The TemplateReferenceInterface instance

Exceptions

InvalidArgumentException if the parameter is not defined

in TemplateReference at line 72
public string get(string $name)

Gets a template parameter.

Parameters

string $name The parameter name

Return Value

string The parameter value

Exceptions

InvalidArgumentException if the parameter is not defined

in TemplateReference at line 88
public array all()

Gets the template parameters.

Return Value

array An array of parameters

at line 41
public string getPath()

Returns the path to the template.

By default, it just returns the template name.

Return Value

string A path to the template or a resource

at line 53
public string getLogicalName()

Returns the "logical" template name.

The template name acts as a unique identifier for the template.

Return Value

string The template name