Template
extends ConfigurationAnnotation
in package
The Template class handles the Template annotation parts.
Tags
Table of Contents
- $template : string
- The template.
- $owner : array<string|int, mixed>
- The controller (+action) this annotation is set to.
- $streamable : bool
- Should the template be streamed?
- $vars : array<string|int, mixed>
- The associative array of template variables.
- __construct() : mixed
- allowArray() : bool
- Only one template directive is allowed.
- getAliasName() : string
- Returns the annotation alias name.
- getOwner() : array<string|int, mixed>
- The controller (+action) this annotation is attached to.
- getTemplate() : string
- Returns the template.
- getVars() : array<string|int, mixed>
- Returns the array of templates variables.
- isStreamable() : bool
- setIsStreamable() : mixed
- setOwner() : mixed
- setTemplate() : mixed
- Sets the template.
- setValue() : mixed
- Sets the template logic name.
- setVars() : mixed
- Sets the template variables.
Properties
$template
The template.
protected
string
$template
$owner
The controller (+action) this annotation is set to.
private
array<string|int, mixed>
$owner
= []
$streamable
Should the template be streamed?
private
bool
$streamable
= false
$vars
The associative array of template variables.
private
array<string|int, mixed>
$vars
= []
Methods
__construct()
public
__construct(array<string|int, mixed> $values) : mixed
Parameters
- $values : array<string|int, mixed>
Return values
mixed —allowArray()
Only one template directive is allowed.
public
allowArray() : bool
Tags
Return values
bool —getAliasName()
Returns the annotation alias name.
public
getAliasName() : string
Tags
Return values
string —getOwner()
The controller (+action) this annotation is attached to.
public
getOwner() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTemplate()
Returns the template.
public
getTemplate() : string
Return values
string —getVars()
Returns the array of templates variables.
public
getVars() : array<string|int, mixed>
Return values
array<string|int, mixed> —isStreamable()
public
isStreamable() : bool
Return values
bool —setIsStreamable()
public
setIsStreamable(bool $streamable) : mixed
Parameters
- $streamable : bool
Return values
mixed —setOwner()
public
setOwner(array<string|int, mixed> $owner) : mixed
Parameters
- $owner : array<string|int, mixed>
Return values
mixed —setTemplate()
Sets the template.
public
setTemplate(string $template) : mixed
Parameters
- $template : string
-
The template
Return values
mixed —setValue()
Sets the template logic name.
public
setValue(string $template) : mixed
Parameters
- $template : string
-
The template logic name
Return values
mixed —setVars()
Sets the template variables.
public
setVars(array<string|int, mixed> $vars) : mixed
Parameters
- $vars : array<string|int, mixed>
-
The template variables