Class JRouterSite

Class to create and parse routes for the site application

JRouter

JRouterSite

Package: Joomla\Libraries\Router
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.5
Located at cms/router/site.php

Methods summary

`public`	# `__construct( array $options = array(), JApplicationCms $app = null, JMenu $menu = null )` Class constructor Class constructor Parameters `$options` `array` - $options Array of options `$app` `JApplicationCms` - $app JApplicationCms Object `$menu` `JMenu` - $menu JMenu object Since 3.4 Overrides `JRouter::__construct`
`public array`	# `parse( JUri & $uri )` Function to convert a route to an internal URI Function to convert a route to an internal URI Parameters `$uri` `JUri` - &$uri The uri. Returns `array` Since 1.5 Overrides `JRouter::parse`
`public string`	# `build( string $url )` Function to convert an internal URI to a route Function to convert an internal URI to a route Parameters `$url` `string` - $url The internal URL Returns `string` - The absolute search engine friendly URL Since 1.5 Overrides `JRouter::build`
`protected array`	# `parseRawRoute( JUri & $uri )` Function to convert a raw route to an internal URI Function to convert a raw route to an internal URI Deprecated 4.0 Attach your logic as rule to the main parse stage Parameters `$uri` `JUri` - &$uri The raw route Returns `array` Since 3.2 Overrides `JRouter::parseRawRoute`
`protected string`	# `parseSefRoute( JUri & $uri )` Function to convert a sef route to an internal URI Function to convert a sef route to an internal URI Deprecated 4.0 Attach your logic as rule to the main parse stage Parameters `$uri` `JUri` - &$uri The sef URI Returns `string` - Internal URI Since 3.2 Overrides `JRouter::parseSefRoute`
`protected string`	# `buildRawRoute( JUri & $uri )` Function to build a raw route Function to build a raw route Deprecated 4.0 Attach your logic as rule to the main build stage Parameters `$uri` `JUri` - &$uri The internal URL Returns `string` - Raw Route Since 3.2 Overrides `JRouter::buildRawRoute`
`protected`	# `_buildSefRoute( JUri & $uri )` Function to build a sef route Function to build a sef route Deprecated 4.0 Attach your logic as rule to the main build stage Parameters `$uri` `JUri` - &$uri The internal URL Since 1.5 CodeCoverageIgnore Overrides `JRouter::_buildSefRoute`
`protected`	# `buildSefRoute( JUri & $uri )` Function to build a sef route Function to build a sef route Deprecated 4.0 Attach your logic as rule to the main build stage Parameters `$uri` `JUri` - &$uri The uri Since 3.2 Overrides `JRouter::buildSefRoute`
`protected array`	# `processParseRules( JUri & $uri, string $stage = JRouter::PROCESS_DURING )` Process the parsed router variables based on custom defined rules Process the parsed router variables based on custom defined rules Parameters `$uri` `JUri` - &$uri The URI to parse `$stage` `string` - $stage The stage that should be processed. Possible values: 'preprocess', 'postprocess' and '' for the main parse stage Returns `array` - The array of processed URI variables Since 3.2 Overrides `JRouter::processParseRules`
`protected`	# `processBuildRules( JUri & $uri, string $stage = JRouter::PROCESS_DURING )` Process the build uri query data based on custom defined rules Process the build uri query data based on custom defined rules Deprecated 4.0 The special logic should be implemented as rule Parameters `$uri` `JUri` - &$uri The URI `$stage` `string` - $stage The stage that should be processed. Possible values: 'preprocess', 'postprocess' and '' for the main build stage Since 3.2 Overrides `JRouter::processBuildRules`
`protected JUri`	# `createUri( string $url )` Create a uri based on a full or partial URL string Create a uri based on a full or partial URL string Parameters `$url` `string` - $url The URI Returns `JUri` Since 3.2 Overrides `JRouter::createUri`
`public JComponentRouterInterface`	# `getComponentRouter( string $component )` Get component router Get component router Parameters `$component` `string` - $component Name of the component including com_ prefix Returns `JComponentRouterInterface` - Component router Since 3.3
`public boolean`	# `setComponentRouter( string $component, object $router )` Set a router for a component Set a router for a component Parameters `$component` `string` - $component Component name with com_ prefix `$router` `object` - $router Component router Returns `boolean` - True if the router was accepted, false if not Since 3.3

Methods inherited from JRouter

_buildRawRoute(), _createUri(), _decodeSegments(), _encodeSegments(), _parseRawRoute(), _parseSefRoute(), _processBuildRules(), _processParseRules(), attachBuildRule(), attachParseRule(), decodeSegments(), encodeSegments(), getInstance(), getMode(), getVar(), getVars(), setMode(), setVar(), setVars()

Magic methods summary

Constants summary

Constants inherited from JRouter

PROCESS_AFTER, PROCESS_BEFORE, PROCESS_DURING

Properties summary

`protected array`	`$componentRouters`	# Component-router objects Component-router objects Since 3.3
`protected JApplicationCms`	`$app`	# Current JApplication-Object Current JApplication-Object Since 3.4
`protected JMenu`	`$menu`	# Current JMenu-Object Current JMenu-Object Since 3.4

Properties inherited from JRouter

$_mode, $_rules, $_vars, $cache, $instances, $mode, $rules, $vars

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JRouterSite

Methods summary

Parameters

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Deprecated

Parameters

Returns

Since

Overrides

Deprecated

Parameters

Returns

Since

Overrides

Deprecated

Parameters

Returns

Since

Overrides

Deprecated

Parameters

Since

CodeCoverageIgnore

Overrides

Deprecated

Parameters

Since

Overrides

Parameters

Returns

Since

Overrides

Deprecated

Parameters

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from JRouter

Magic methods summary

Constants summary

Constants inherited from JRouter

Properties summary

Since

Since

Since

Properties inherited from JRouter