Trait ViewVarsTrait
Provides the set() method for collecting template context.
Once collected context data can be passed to another object. This is done in Controller, TemplateTask and View for example.
Indirect Users
Properties summary
-
$_viewBuilderprotectedThe view builder instance being used. -
$viewClasspublicstring|nullThe name of default View class. -
$viewVarspublicarrayVariables for the view.
Magic properties summary
-
$_validViewOptionspublicarray
Method Summary
-
createView() public
Constructs the view class instance based on the current configuration. -
set() public
Saves a variable or an associative array of variables for use inside a template. -
viewBuilder() public
Get the view builder being used. -
viewOptions() public deprecated
Get/Set valid view options in the object's _validViewOptions property. The property is created as an empty array if it is not set. If called without any parameters it will return the current list of valid view options. See
createView().
Method Detail
createView() public ¶
createView( string|null $viewClass = null )
Constructs the view class instance based on the current configuration.
Parameters
- string|null $viewClass optional null
- Optional namespaced class name of the View class to instantiate.
Returns
Throws
set() public ¶
set( string|array $name , mixed $value = null )
Saves a variable or an associative array of variables for use inside a template.
Parameters
- string|array $name
- A string or an array of data.
- mixed $value optional null
Value in case $name is a string (which then works as the key). Unused if $name is an associative array, otherwise serves as the values to $name's keys.
Returns
$this
viewOptions() public deprecated ¶
viewOptions( string|array|null $options = null , boolean $merge = true )
Get/Set valid view options in the object's _validViewOptions property. The property is
created as an empty array if it is not set. If called without any parameters it will
return the current list of valid view options. See createView().
Deprecated
Parameters
- string|array|null $options optional null
- string or array of string to be appended to _validViewOptions.
- boolean $merge optional true
Whether to merge with or override existing valid View options. Defaults to
true.
Returns
The updated view options as an array.
Properties detail
$viewClass ¶
The name of default View class.
Deprecated
$this->viewBuilder()->getClassName()/$this->viewBuilder()->setClassName() instead.