JApplicationWebRouterRest

class JApplicationWebRouterRest extends JApplicationWebRouterBase

RESTful Web application router class for the Joomla Platform.

Methods

__construct( JApplicationWeb $app, JInput $input = null)

Constructor.

from JApplicationWebRouter
mixed
execute( string $route)

Find and execute the appropriate controller based on a given route.

JApplicationWebRouter
setControllerPrefix( string $prefix)

Set the controller name prefix.

from JApplicationWebRouter
JApplicationWebRouter
setDefaultController( string $name)

Set the default controller name.

from JApplicationWebRouter
JApplicationWebRouter
addMap( string $pattern, string $controller)

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

from JApplicationWebRouterBase
JApplicationWebRouter
addMaps( array $maps)

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

from JApplicationWebRouterBase
JApplicationWebRouter
setHttpMethodSuffix( string $method, string $suffix)

Set a controller class suffix for a given HTTP method.

void
setMethodInPostRequest( boolean $value)

Set to allow or not method in POST request

boolean
isMethodInPostRequest()

Get the property to allow or not method in POST request

Details

__construct( JApplicationWeb $app, JInput $input = null)

Constructor.

Parameters

JApplicationWeb $app The web application on whose behalf we are routing the request.
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.

mixed execute( string $route)

Find and execute the appropriate controller based on a given route.

Parameters

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

Return Value

mixed The return value of the controller executed

Exceptions

InvalidArgumentException
RuntimeException

JApplicationWebRouter setControllerPrefix( string $prefix)

Set the controller name prefix.

Parameters

string $prefix Controller class name prefix for creating controller objects by name.

Return Value

JApplicationWebRouter This object for method chaining.

JApplicationWebRouter setDefaultController( string $name)

Set the default controller name.

Parameters

string $name The default page controller name for an empty route.

Return Value

JApplicationWebRouter This object for method chaining.

JApplicationWebRouter addMap( string $pattern, string $controller)

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

Parameters

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

Return Value

JApplicationWebRouter This object for method chaining.

JApplicationWebRouter addMaps( array $maps)

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

Parameters

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

Return Value

JApplicationWebRouter This object for method chaining.

JApplicationWebRouter setHttpMethodSuffix( string $method, string $suffix)

Set a controller class suffix for a given HTTP method.

Parameters

string $method The HTTP method for which to set the class suffix.
string $suffix The class suffix to use when fetching the controller name for a given request.

Return Value

JApplicationWebRouter This object for method chaining.

void setMethodInPostRequest( boolean $value)

Set to allow or not method in POST request

Parameters

boolean $value A boolean to allow or not method in POST request

Return Value

void

boolean isMethodInPostRequest()

Get the property to allow or not method in POST request

Return Value

boolean