RouterViewConfiguration

View-configuration class for the view-based component router

since

3.5

Methods

__construct

Constructor for the View-configuration class

__construct(string $name) 
since

3.5

Arguments

$name

stringName of the view

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(boolean $isNestable = true) : \Joomla\CMS\Component\Router\RouterViewconfiguration
since

3.5

Arguments

$isNestable

booleanIf 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 $parent_key = false) : \Joomla\CMS\Component\Router\RouterViewconfiguration
since

3.5

Arguments

$parent

\Joomla\CMS\Component\Router\RouterViewconfigurationParent view object

$parent_key

stringKey of the parent view in this context

Response

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

Properties

name

Name of the view

Type(s)

string

key

Key of the view

Type(s)

string

parent

Parentview of this one

Type(s)

\Joomla\CMS\Component\Router\RouterViewconfiguration

parent_key

Key of the parent view

Type(s)

string

nestable

Is this view nestable?

Type(s)

boolean

layouts

Layouts that are supported by this view

Type(s)

array

children

Child-views of this view

Type(s)

array<mixed,\Joomla\CMS\Component\Router\RouterViewconfiguration>

child_keys

Keys used for this parent view by the child views

Type(s)

array

path

Path of views from this one to the root view

Type(s)

array