RouterViewConfiguration

View-configuration class for the view-based component router

since

3.5

package

Application

Methods

__construct

Constructor for the View-configuration class

__construct(string name) : mixed
since

3.5

Arguments

name

stringName of the view

Response

mixed

addLayout

Add a layout to this view

addLayout(string layout) : \Joomla\CMS\Component\Router\RouterViewConfiguration
since

3.5

Arguments

layout

stringLayouts that this view supports

Response

\Joomla\CMS\Component\Router\RouterViewConfigurationThis object for chaining

removeLayout

Remove a layout from this view

removeLayout(string layout) : \Joomla\CMS\Component\Router\RouterViewConfiguration
since

3.5

Arguments

layout

stringLayouts that this view supports

Response

\Joomla\CMS\Component\Router\RouterViewConfigurationThis object for chaining

setKey

Set the key-identifier for the view

setKey(string key) : \Joomla\CMS\Component\Router\RouterViewConfiguration
since

3.5

Arguments

key

stringKey of the view

Response

\Joomla\CMS\Component\Router\RouterViewConfigurationThis object for chaining

setName

Set the name of the view

setName(string name) : \Joomla\CMS\Component\Router\RouterViewConfiguration
since

3.5

Arguments

name

stringName of the view

Response

\Joomla\CMS\Component\Router\RouterViewConfigurationThis object for chaining

setNestable

Set if this view is nestable or not

setNestable(bool isNestable = true) : \Joomla\CMS\Component\Router\RouterViewConfiguration
since

3.5

Arguments

isNestable

boolIf set to true, the view is nestable

Response

\Joomla\CMS\Component\Router\RouterViewConfigurationThis object for chaining

setParent

Set the parent view of this view

setParent(\Joomla\CMS\Component\Router\RouterViewConfiguration parent, string parentKey = null) : \Joomla\CMS\Component\Router\RouterViewConfiguration
since

3.5

Arguments

parent

\Joomla\CMS\Component\Router\RouterViewConfigurationParent view object

parentKey

stringKey of the parent view in this context

Response

\Joomla\CMS\Component\Router\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

Parentview of this one

since

3.5

Type(s)

RouterViewConfiguration

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

children

Child-views of this view

since

3.5

Type(s)

RouterViewConfiguration[]

child_keys

Keys used for this parent view by the child views

since

3.5

Type(s)

array

path

Path of views from this one to the root view

since

3.5

Type(s)

array