class RouterViewConfiguration

View-configuration class for the view-based component router

Properties

string $name Name of the view
string $key Key of the view
RouterViewconfiguration $parent Parentview of this one
string $parent_key Key of the parent view
bool $nestable Is this view nestable?
array $layouts Layouts that are supported by this view
RouterViewconfiguration[] $children Child-views of this view
array $child_keys Keys used for this parent view by the child views
array $path Path of views from this one to the root view

Methods

__construct( string $name)

Constructor for the View-configuration class

RouterViewconfiguration
setName( string $name)

Set the name of the view

RouterViewconfiguration
setKey( string $key)

Set the key-identifier for the view

RouterViewconfiguration
setParent( RouterViewconfiguration $parent, string $parent_key = false)

Set the parent view of this view

RouterViewconfiguration
setNestable( bool $isNestable = true)

Set if this view is nestable or not

RouterViewconfiguration
addLayout( string $layout)

Add a layout to this view

RouterViewconfiguration
removeLayout( string $layout)

Remove a layout from this view

Details

__construct( string $name)

Constructor for the View-configuration class

Parameters

string $name Name of the view

RouterViewconfiguration setName( string $name)

Set the name of the view

Parameters

string $name Name of the view

Return Value

RouterViewconfiguration This object for chaining

RouterViewconfiguration setKey( string $key)

Set the key-identifier for the view

Parameters

string $key Key of the view

Return Value

RouterViewconfiguration This object for chaining

RouterViewconfiguration setParent( RouterViewconfiguration $parent, string $parent_key = false)

Set the parent view of this view

Parameters

RouterViewconfiguration $parent Parent view object
string $parent_key Key of the parent view in this context

Return Value

RouterViewconfiguration This object for chaining

RouterViewconfiguration setNestable( bool $isNestable = true)

Set if this view is nestable or not

Parameters

bool $isNestable If set to true, the view is nestable

Return Value

RouterViewconfiguration This object for chaining

RouterViewconfiguration addLayout( string $layout)

Add a layout to this view

Parameters

string $layout Layouts that this view supports

Return Value

RouterViewconfiguration This object for chaining

RouterViewconfiguration removeLayout( string $layout)

Remove a layout from this view

Parameters

string $layout Layouts that this view supports

Return Value

RouterViewconfiguration This object for chaining