Class JApplicationWebRouterBase

Basic Web application router class for the Joomla Platform.

JApplicationWebRouterBase

Direct known subclasses

JApplicationWebRouterRest

Package: Joomla\Platform\Application
Deprecated: 3.7.0 Use the joomla/router package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.2
Located at joomla/application/web/router/base.php

Methods summary

`public JApplicationWebRouter`	# `addMap( string $pattern, string $controller )` Add a route map to the router. If the pattern already exists it will be overwritten. Add a route map to the router. If the pattern already exists it will be overwritten. Parameters `$pattern` `string` - $pattern The route pattern to use for matching. `$controller` `string` - $controller The controller name to map to the given pattern. Returns `JApplicationWebRouter` - This object for method chaining. Since 12.2
`public JApplicationWebRouter`	# `addMaps( array $maps )` Add a route map to the router. If the pattern already exists it will be overwritten. Add a route map to the router. If the pattern already exists it will be overwritten. Parameters `$maps` `array` - $maps A list of route maps to add to the router as $pattern => $controller. Returns `JApplicationWebRouter` - This object for method chaining. Since 12.2
`protected string`	# `parseRoute( string $route )` Parse the given route and return the name of a controller mapped to the given route. Parse the given route and return the name of a controller mapped to the given route. Parameters `$route` `string` - $route The route string for which to find and execute a controller. Returns `string` - The controller name for the given route excluding prefix. Throws `InvalidArgumentException` Since 12.2

Methods inherited from JApplicationWebRouter

__construct(), execute(), fetchController(), setControllerPrefix(), setDefaultController()

Magic methods summary

Properties summary

`protected array`	`$maps`	# An array of rules, each rule being an associative array('regex'=> $regex, 'vars' => $vars, 'controller' => $controller) for routing the request. An array of rules, each rule being an associative array('regex'=> $regex, 'vars' => $vars, 'controller' => $controller) for routing the request. Since 12.2

Properties inherited from JApplicationWebRouter

$app, $controllerPrefix, $default, $input

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JApplicationWebRouterBase

Direct known subclasses

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Methods inherited from JApplicationWebRouter

Magic methods summary

Properties summary

Since

Properties inherited from JApplicationWebRouter