interface TemplateReferenceInterface

Interface to be implemented by all templates.

Methods

array
all()

Gets the template parameters.

set(string $name, string $value)

Sets a template parameter.

string
get(string $name)

Gets a template parameter.

string
getPath()

Returns the path to the template.

string
getLogicalName()

Returns the "logical" template name.

string
__toString()

Returns the string representation as shortcut for getLogicalName().

Details

at line line 26
array all()

Gets the template parameters.

Return Value

array An array of parameters

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

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

at line line 58
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 line 67
string getLogicalName()

Returns the "logical" template name.

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

Return Value

string The template name

at line line 76
string __toString()

Returns the string representation as shortcut for getLogicalName().

Alias of getLogicalName().

Return Value

string The template name