Class JComponentRouterView

View-based component routing class

JComponentRouterBase implements JComponentRouterInterface

JComponentRouterView

Abstract
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/view.php

Methods summary

`public`	# `registerView( JComponentRouterViewconfiguration $view )` Register the views of a component Register the views of a component Parameters `$view` `JComponentRouterViewconfiguration` - $view View configuration object Since 3.5
`public JComponentRouterViewconfiguration[]`	# `getViews( )` Return an array of registered view objects Return an array of registered view objects Returns `JComponentRouterViewconfiguration[]` - Array of registered view objects Since 3.5
`public array`	# `getPath( array $query )` Get the path of views from target view to root view including content items of a nestable view Get the path of views from target view to root view including content items of a nestable view Parameters `$query` `array` - $query Array of query elements Returns `array` - List of views including IDs of content items Since 3.5
`public JComponentRouterRulesInterface[]`	# `getRules( )` Get all currently attached rules Get all currently attached rules Returns `JComponentRouterRulesInterface[]` - All currently attached rules in an array Since 3.5
`public`	# `attachRules( JComponentRouterRulesInterface[] $rules )` Add a number of router rules to the object Add a number of router rules to the object Parameters `$rules` `JComponentRouterRulesInterface[]` - $rules Array of JComponentRouterRulesInterface objects Since 3.5
`public`	# `attachRule( JComponentRouterRulesInterface $rule )` Attach a build rule Attach a build rule Parameters `$rule` `JComponentRouterRulesInterface` - $rule The function to be called. Since 3.5
`public boolean`	# `detachRule( JComponentRouterRulesInterface $rule )` Remove a build rule Remove a build rule Parameters `$rule` `JComponentRouterRulesInterface` - $rule The rule to be removed. Returns `boolean` - Was a rule removed? Since 3.5
`public array`	# `preprocess( array $query )` Generic method to preprocess a URL Generic method to preprocess a URL Parameters `$query` `array` - $query An associative array of URL arguments Returns `array` - The URL arguments to use to assemble the subsequent URL. Since 3.5 Overrides `JComponentRouterBase::preprocess`
`public array`	# `build( array & $query )` Build method for URLs Build method for URLs Parameters `$query` `array` - &$query Array of query elements Returns `array` - Array of URL segments Since 3.5
`public array`	# `parse( array & $segments )` Parse method for URLs Parse method for URLs Parameters `$segments` `array` - &$segments Array of URL string-segments Returns `array` - Associative array of query values Since 3.5
`public string`	# `getName( )` Method to return the name of the router Method to return the name of the router Returns `string` - Name of the router Since 3.5

Methods inherited from JComponentRouterBase

__construct()

Magic methods summary

Properties summary

`protected string`	`$name`	# Name of the router of the component Name of the router of the component Since 3.5
`protected JComponentRouterRulesInterface[]`	`$rules`	# Array of rules Array of rules Since 3.5
`protected JComponentRouterViewconfiguration[]`	`$views`	# Views of the component Views of the component Since 3.5

Properties inherited from JComponentRouterBase

$app, $menu

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JComponentRouterView

Methods summary

Parameters

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Methods inherited from JComponentRouterBase

Magic methods summary

Properties summary

Since

Since

Since

Properties inherited from JComponentRouterBase