RouterViewConfiguration
View-configuration class for the view-based component router
| since |
3.5 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor for the View-configuration class
__construct( name) :
| since |
3.5 |
|---|
Arguments
- name
stringName of the view
Response
mixed
addLayout
Add a layout to this view
addLayout( layout) : \Joomla\CMS\Component\Router\RouterViewConfiguration
| since |
3.5 |
|---|
Arguments
- layout
stringLayouts that this view supports
Response
RouterViewConfigurationThis object for chaining
removeLayout
Remove a layout from this view
removeLayout( layout) : \Joomla\CMS\Component\Router\RouterViewConfiguration
| since |
3.5 |
|---|
Arguments
- layout
stringLayouts that this view supports
Response
RouterViewConfigurationThis object for chaining
setKey
Set the key-identifier for the view
setKey( key) : \Joomla\CMS\Component\Router\RouterViewConfiguration
| since |
3.5 |
|---|
Arguments
- key
stringKey of the view
Response
RouterViewConfigurationThis object for chaining
setName
Set the name of the view
setName( name) : \Joomla\CMS\Component\Router\RouterViewConfiguration
| since |
3.5 |
|---|
Arguments
- name
stringName of the view
Response
RouterViewConfigurationThis object for chaining
setNestable
Set if this view is nestable or not
setNestable( isNestable = true) : \Joomla\CMS\Component\Router\RouterViewConfiguration
| since |
3.5 |
|---|
Arguments
- isNestable
boolIf set to true, the view is nestable
Response
RouterViewConfigurationThis object for chaining
setParent
Set the parent view of this view
setParent(\Joomla\CMS\Component\Router\RouterViewConfiguration parent, parentKey = null) : \Joomla\CMS\Component\Router\RouterViewConfiguration
| since |
3.5 |
|---|
Arguments
- parent
RouterViewConfigurationParent view object- parentKey
stringKey of the parent view in this context
Response
RouterViewConfigurationThis object for chaining
Properties
name
Name of the view
| since |
3.5 |
|---|
Type(s)
string
key
Key of the view
| since |
3.5 |
|---|
Type(s)
string
parent_key
Key of the parent view
| since |
3.5 |
|---|
Type(s)
string
nestable
Is this view nestable?
| since |
3.5 |
|---|
Type(s)
bool
layouts
Layouts that are supported by this view
| since |
3.5 |
|---|
Type(s)
array<string|int, mixed>
child_keys
Keys used for this parent view by the child views
| since |
3.5 |
|---|
Type(s)
array<string|int, mixed>
path
Path of views from this one to the root view
| since |
3.5 |
|---|
Type(s)
array<string|int, mixed>