Class JApplicationWebRouter

Class to define an abstract Web application router.

Direct known subclasses

JApplicationWebRouterBase

Indirect known subclasses

JApplicationWebRouterRest

Abstract
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.php

Methods summary

`public`	# `__construct( JApplicationWeb $app, JInput $input = null )` Constructor. Constructor. Parameters `$app` `JApplicationWeb` - $app The web application on whose behalf we are routing the request. `$input` `JInput` - $input An optional input object from which to derive the route. If none is given than the input from the application object will be used. Since 12.2
`public mixed`	# `execute( string $route )` Find and execute the appropriate controller based on a given route. Find and execute the appropriate controller based on a given route. Parameters `$route` `string` - $route The route string for which to find and execute a controller. Returns `mixed` - The return value of the controller executed Throws `InvalidArgumentException` `RuntimeException` Since 12.2
`public JApplicationWebRouter`	# `setControllerPrefix( string $prefix )` Set the controller name prefix. Set the controller name prefix. Parameters `$prefix` `string` - $prefix Controller class name prefix for creating controller objects by name. Returns `JApplicationWebRouter` - This object for method chaining. Since 12.2
`public JApplicationWebRouter`	# `setDefaultController( string $name )` Set the default controller name. Set the default controller name. Parameters `$name` `string` - $name The default page controller name for an empty route. Returns `JApplicationWebRouter` - This object for method chaining. Since 12.2
`abstract 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
`protected JController`	# `fetchController( string $name )` Get a JController object for a given name. Get a JController object for a given name. Parameters `$name` `string` - $name The controller name (excluding prefix) for which to fetch and instance. Returns `JController` Throws `RuntimeException` Since 12.2

Magic methods summary

Properties summary

`protected JApplicationWeb`	`$app`	# The web application on whose behalf we are routing the request. The web application on whose behalf we are routing the request. Since 12.2
`protected string`	`$default`	# The default page controller name for an empty route. The default page controller name for an empty route. Since 12.2
`protected string`	`$controllerPrefix`	# Controller class name prefix for creating controller objects by name. Controller class name prefix for creating controller objects by name. Since 12.2
`protected JInput`	`$input`	# An input object from which to derive the route. An input object from which to derive the route. Since 12.2

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JApplicationWebRouter

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Magic methods summary

Properties summary

Since

Since

Since

Since