Interface JComponentRouterRulesInterface

JComponentRouterRules interface for Joomla

Direct known implementers

JComponentRouterRulesMenu, JComponentRouterRulesNomenu, JComponentRouterRulesStandard

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

Methods summary

`public`	# `preprocess( array & $query )` Prepares a query set to be handed over to the build() method. This should complete a partial query set to work as a complete non-SEFed URL and in general make sure that all information is present and properly formatted. For example, the Itemid should be retrieved and set here. Prepares a query set to be handed over to the build() method. This should complete a partial query set to work as a complete non-SEFed URL and in general make sure that all information is present and properly formatted. For example, the Itemid should be retrieved and set here. Parameters `$query` `array` - &$query The query array to process Since 3.4
`public`	# `parse( array & $segments, array & $vars )` Parses a URI to retrieve informations for the right route through the component. This method should retrieve all its input from its method arguments. Parses a URI to retrieve informations for the right route through the component. This method should retrieve all its input from its method arguments. Parameters `$segments` `array` - &$segments The URL segments to parse `$vars` `array` - &$vars The vars that result from the segments Since 3.4
`public`	# `build( array & $query, array & $segments )` Builds URI segments from a query to encode the necessary informations for a route in a human-readable URL. This method should retrieve all its input from its method arguments. Builds URI segments from a query to encode the necessary informations for a route in a human-readable URL. This method should retrieve all its input from its method arguments. Parameters `$query` `array` - &$query The vars that should be converted `$segments` `array` - &$segments The URL segments to create Since 3.4

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Interface JComponentRouterRulesInterface

Direct known implementers

Methods summary

Parameters

Since

Parameters

Since

Parameters

Since

Magic methods summary