Docs For Class JApplicationWebRouterBase

Description

Basic Web application router class for the Joomla Platform.

since: 12.2

Located in /libraries/joomla/application/web/router/base.php (line 19)

JApplicationWebRouter
   |
   --JApplicationWebRouterBase

Direct descendents

Class	Description
JApplicationWebRouterRest	RESTful Web application router class for the Joomla Platform.

Variable Summary

array $maps

Method Summary

JApplicationWebRouter addMap (string $pattern, string $controller)

JApplicationWebRouter addMaps (array $maps)

string parseRoute (string $route)

Variables

array $maps = array() (line 26)

var: An array of rules, each rule being an associative array('regex'=> $regex, 'vars' => $vars, 'controller' => $controller) for routing the request.
since: 12.2
access: protected

Inherited Variables

Inherited from JApplicationWebRouter

JApplicationWebRouter::$app
JApplicationWebRouter::$controllerPrefix
JApplicationWebRouter::$default
JApplicationWebRouter::$input

Methods

addMap (line 38)

Add a route map to the router. If the pattern already exists it will be overwritten.

return: This object for method chaining.
since: 12.2
access: public

JApplicationWebRouter addMap (string $pattern, string $controller)

string $pattern: The route pattern to use for matching.
string $controller: The controller name to map to the given pattern.

addMaps (line 109)

Add a route map to the router. If the pattern already exists it will be overwritten.

return: This object for method chaining.
since: 12.2
access: public

JApplicationWebRouter addMaps (array $maps)

array $maps: A list of route maps to add to the router as $pattern => $controller.

parseRoute (line 129)

Parse the given route and return the name of a controller mapped to the given route.

return: The controller name for the given route excluding prefix.
since: 12.2
throws: InvalidArgumentException
access: protected

string parseRoute (string $route)

string $route: The route string for which to find and execute a controller.

Redefinition of:

JApplicationWebRouter::parseRoute(): Parse the given route and return the name of a controller mapped to the given route.

Inherited Methods

Inherited From JApplicationWebRouter

JApplicationWebRouter::__construct()
JApplicationWebRouter::execute()
JApplicationWebRouter::fetchController()
JApplicationWebRouter::parseRoute()
JApplicationWebRouter::setControllerPrefix()
JApplicationWebRouter::setDefaultController()