Class JComponentRouterViewconfiguration

View-configuration class for the view-based component router

Package: Joomla\Libraries\Component
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 3.5
Located at cms/component/router/viewconfiguration.php

Methods summary

`public`	# `__construct( string $name )` Constructor for the View-configuration class Constructor for the View-configuration class Parameters `$name` `string` - $name Name of the view Since 3.5
`public JComponentRouterViewconfiguration`	# `setName( string $name )` Set the name of the view Set the name of the view Parameters `$name` `string` - $name Name of the view Returns `JComponentRouterViewconfiguration` - This object for chaining Since 3.5
`public JComponentRouterViewconfiguration`	# `setKey( string $key )` Set the key-identifier for the view Set the key-identifier for the view Parameters `$key` `string` - $key Key of the view Returns `JComponentRouterViewconfiguration` - This object for chaining Since 3.5
`public JComponentRouterViewconfiguration`	# `setParent( JComponentRouterViewconfiguration $parent, string $parent_key = false )` Set the parent view of this view Set the parent view of this view Parameters `$parent` `JComponentRouterViewconfiguration` - $parent Parent view object `$parent_key` `string` - $parent_key Key of the parent view in this context Returns `JComponentRouterViewconfiguration` - This object for chaining Since 3.5
`public JComponentRouterViewconfiguration`	# `setNestable( boolean $isNestable = true )` Set if this view is nestable or not Set if this view is nestable or not Parameters `$isNestable` `boolean` - $isNestable If set to true, the view is nestable Returns `JComponentRouterViewconfiguration` - This object for chaining Since 3.5
`public JComponentRouterViewconfiguration`	# `addLayout( string $layout )` Add a layout to this view Add a layout to this view Parameters `$layout` `string` - $layout Layouts that this view supports Returns `JComponentRouterViewconfiguration` - This object for chaining Since 3.5
`public JComponentRouterViewconfiguration`	# `removeLayout( string $layout )` Remove a layout from this view Remove a layout from this view Parameters `$layout` `string` - $layout Layouts that this view supports Returns `JComponentRouterViewconfiguration` - This object for chaining Since 3.5

Magic methods summary

Properties summary

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

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JComponentRouterViewconfiguration

Methods summary

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Since