Interface JComponentRouterInterface

Component routing interface

Direct known implementers

JComponentRouterBase, JComponentRouterLegacy

Indirect known implementers

JComponentRouterView

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.3
Located at cms/component/router/interface.php

Methods summary

`public array`	# `preprocess( array $query )` Prepare-method for URLs This method is meant to validate and complete the URL parameters. For example it can add the Itemid or set a language parameter. This method is executed on each URL, regardless of SEF mode switched on or not. Prepare-method for URLs This method is meant to validate and complete the URL parameters. For example it can add the Itemid or set a language parameter. This method is executed on each URL, regardless of SEF mode switched on or not. Parameters `$query` `array` - $query An associative array of URL arguments Returns `array` - The URL arguments to use to assemble the subsequent URL. Since 3.3
`public array`	# `build( array & $query )` Build method for URLs This method is meant to transform the query parameters into a more human readable form. It is only executed when SEF mode is switched on. Build method for URLs This method is meant to transform the query parameters into a more human readable form. It is only executed when SEF mode is switched on. Parameters `$query` `array` - &$query An array of URL arguments Returns `array` - The URL arguments to use to assemble the subsequent URL. Since 3.3
`public array`	# `parse( array & $segments )` Parse method for URLs This method is meant to transform the human readable URL back into query parameters. It is only executed when SEF mode is switched on. Parse method for URLs This method is meant to transform the human readable URL back into query parameters. It is only executed when SEF mode is switched on. Parameters `$segments` `array` - &$segments The segments of the URL to parse. Returns `array` - The URL attributes to be used by the application. Since 3.3

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Interface JComponentRouterInterface

Direct known implementers

Indirect known implementers

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary