1. class
  2. Symfony
  3. \
  4. Bundle
  5. \
  6. FrameworkBundle
  7. \
  8. Templating
  9. \
  10. TemplateReference

TemplateReference

class TemplateReference extends TemplateReference

Internal representation of a template.

Properties

protected $parameters from TemplateReference

Methods

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

No description

string
__toString()

Returns the string representation as shortcut for getLogicalName().

from TemplateReference
$this
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 - as a path when the template is not part of a bundle - as a resource when the template is part of a bundle.

string
getLogicalName()

Returns the "logical" template name.

Details

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

Parameters

string $bundle
string $controller
string $name
string $format
string $engine

string __toString()

Returns the string representation as shortcut for getLogicalName().

Alias of getLogicalName().

Return Value

string The template name

$this set(string $name, string $value)

Sets a template parameter.

Parameters

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

Return Value

$this

Exceptions

InvalidArgumentException if the parameter name is not supported

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 name is not supported

array all()

Gets the template parameters.

Return Value

array An array of parameters

string getPath()

Returns the path to the template - as a path when the template is not part of a bundle - as a resource when the template is part of a bundle.

Return Value

string A path to the template or a resource

string getLogicalName()

Returns the "logical" template name.

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

Return Value

string The template name