Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class RouterViewConfiguration - list of methods

View-configuration class for the view-based component router
Package: Joomla\CMS\Component\Router
Copyright: (C) 2015 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Component/Router/RouterViewConfiguration.php
Project: Joomla

Method Summary

public
__construct
(mixed $name)

Constructor for the View-configuration class
Parameters
  • string $name Name of the view
Since
  • 3.5
Show source code of this method: __construct Source Code

public \Joomla\CMS\Component\Router\RouterViewConfiguration
(mixed $name)

Set the name of the view
Parameters
  • string $name Name of the view
Returns
  • \Joomla\CMS\Component\Router\RouterViewConfiguration This object for chaining
Since
  • 3.5
Show source code of this method: setName Source Code

public \Joomla\CMS\Component\Router\RouterViewConfiguration
(mixed $key)

Set the key-identifier for the view
Parameters
  • string $key Key of the view
Returns
  • \Joomla\CMS\Component\Router\RouterViewConfiguration This object for chaining
Since
  • 3.5
Show source code of this method: setKey Source Code

public \Joomla\CMS\Component\Router\RouterViewConfiguration
(\Joomla\CMS\Component\Router\RouterViewConfiguration $parent, mixed $parentKey = null)

Set the parent view of this view
Parameters
  • \Joomla\CMS\Component\Router\RouterViewConfiguration $parent Parent view object
  • string $parentKey Key of the parent view in this context
Returns
  • \Joomla\CMS\Component\Router\RouterViewConfiguration This object for chaining
Since
  • 3.5
Show source code of this method: setParent Source Code

public \Joomla\CMS\Component\Router\RouterViewConfiguration
(mixed $isNestable = true)

Set if this view is nestable or not
Parameters
  • bool $isNestable If set to true, the view is nestable
Returns
  • \Joomla\CMS\Component\Router\RouterViewConfiguration This object for chaining
Since
  • 3.5
Show source code of this method: setNestable Source Code

public \Joomla\CMS\Component\Router\RouterViewConfiguration
(mixed $layout)

Add a layout to this view
Parameters
  • string $layout Layouts that this view supports
Returns
  • \Joomla\CMS\Component\Router\RouterViewConfiguration This object for chaining
Since
  • 3.5
Show source code of this method: addLayout Source Code

public \Joomla\CMS\Component\Router\RouterViewConfiguration
(mixed $layout)

Remove a layout from this view
Parameters
  • string $layout Layouts that this view supports
Returns
  • \Joomla\CMS\Component\Router\RouterViewConfiguration This object for chaining
Since
  • 3.5
Show source code of this method: removeLayout Source Code

Properties Summary

public string
$name
Name of the view
Since
  • 3.5
public string
$key
Key of the view
Since
  • 3.5
public \Joomla\CMS\Component\Router\RouterViewConfiguration
$parent
Parentview of this one
Since
  • 3.5
public string
$parent_key
Key of the parent view
Since
  • 3.5
public bool
$nestable
Is this view nestable?
Since
  • 3.5
public array
$layouts
Layouts that are supported by this view
Since
  • 3.5
public \Joomla\CMS\Component\Router\RouterViewConfiguration[]
$children
Child-views of this view
Since
  • 3.5
public array
$child_keys
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
Since
  • 3.5

Tags Summary

Since
3.5