Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class RouterView - list of methods

View-based component routing class

Extends

RouterBase
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/RouterView.php
Project: Joomla

Method Summary

public void
(\Joomla\CMS\Component\Router\RouterViewConfiguration $view)

Register the views of a component
Parameters
  • \Joomla\CMS\Component\Router\RouterViewConfiguration $view View configuration object
Returns
  • void
Since
  • 3.5
Show source code of this method: registerView Source Code

public \Joomla\CMS\Component\Router\RouterViewConfiguration[]
()

Return an array of registered view objects
Returns
  • \Joomla\CMS\Component\Router\RouterViewConfiguration[] Array of registered view objects
Since
  • 3.5
Show source code of this method: getViews Source Code

public array
(mixed $query)

Get the path of views from target view to root view including content items of a nestable view
Parameters
  • array $query Array of query elements
Returns
  • array List of views including IDs of content items
Since
  • 3.5
Show source code of this method: getPath Source Code

public \Joomla\CMS\Component\Router\Rules\RulesInterface[]
()

Get all currently attached rules
Returns
  • \Joomla\CMS\Component\Router\Rules\RulesInterface[] All currently attached rules in an array
Since
  • 3.5
Show source code of this method: getRules Source Code

public void
(mixed $rules)

Add a number of router rules to the object
Parameters
  • \Joomla\CMS\Component\Router\Rules\RulesInterface[] $rules Array of JComponentRouterRulesInterface objects
Returns
  • void
Since
  • 3.5
Show source code of this method: attachRules Source Code

public void
(\Joomla\CMS\Component\Router\Rules\RulesInterface $rule)

Attach a build rule
Parameters
  • \Joomla\CMS\Component\Router\Rules\RulesInterface $rule The function to be called.
Returns
  • void
Since
  • 3.5
Show source code of this method: attachRule Source Code

public bool
(\Joomla\CMS\Component\Router\Rules\RulesInterface $rule)

Remove a build rule
Parameters
  • \Joomla\CMS\Component\Router\Rules\RulesInterface $rule The rule to be removed.
Returns
  • bool Was a rule removed?
Since
  • 3.5
Show source code of this method: detachRule Source Code

public array
(mixed $query)

Generic method to preprocess a URL
Parameters
  • array $query An associative array of URL arguments
Returns
  • array The URL arguments to use to assemble the subsequent URL.
Since
  • 3.5
Show source code of this method: preprocess Source Code

public array
(mixed &$query)

Build method for URLs
Parameters
  • array & $query Array of query elements
Returns
  • array Array of URL segments
Since
  • 3.5
Show source code of this method: build Source Code

public array
(mixed &$segments)

Parse method for URLs
Parameters
  • array & $segments Array of URL string-segments
Returns
  • array Associative array of query values
Since
  • 3.5
Show source code of this method: parse Source Code

public string
()

Method to return the name of the router
Returns
  • string Name of the router
Since
  • 3.5
Show source code of this method: getName Source Code

Properties Summary

protected string
$name
Name of the router of the component
Since
  • 3.5
protected \Joomla\CMS\Component\Router\Rules\RulesInterface[]
$rules
Array of rules
Since
  • 3.5
protected \Joomla\CMS\Component\Router\RouterViewConfiguration[]
$views
Views of the component
Since
  • 3.5

Tags Summary

Since
3.5