Class JApplicationWebRouterRest

RESTful Web application router class for the Joomla Platform.

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/rest.php

Methods summary

`public`	# `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. Throws `InvalidArgumentException` `RuntimeException` Since 12.2 Overrides `JApplicationWebRouter::execute`
`public JApplicationWebRouter`	# `setHttpMethodSuffix( string $method, string $suffix )` Set a controller class suffix for a given HTTP method. Set a controller class suffix for a given HTTP method. Parameters `$method` `string` - $method The HTTP method for which to set the class suffix. `$suffix` `string` - $suffix The class suffix to use when fetching the controller name for a given request. Returns `JApplicationWebRouter` - This object for method chaining. Since 12.2
`public`	# `setMethodInPostRequest( boolean $value )` Set to allow or not method in POST request Set to allow or not method in POST request Parameters `$value` `boolean` - $value A boolean to allow or not method in POST request Since 12.2
`public boolean`	# `isMethodInPostRequest( )` Get the property to allow or not method in POST request Get the property to allow or not method in POST request Returns `boolean` Since 12.2
`protected string`	# `fetchControllerSuffix( )` Get the controller class suffix string. Get the controller class suffix string. Returns `string` Throws `RuntimeException` Since 12.2

Methods inherited from JApplicationWebRouterBase

addMap(), addMaps(), parseRoute()

Methods inherited from JApplicationWebRouter

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

Magic methods summary

Properties summary

`protected boolean`	`$methodInPostRequest`	# A boolean allowing to pass _method as parameter in POST requests A boolean allowing to pass _method as parameter in POST requests Since 12.2
`protected array`	`$suffixMap`	# An array of HTTP Method => controller suffix pairs for routing the request. An array of HTTP Method => controller suffix pairs for routing the request. Since 12.2

Properties inherited from JApplicationWebRouterBase

$maps

Properties inherited from JApplicationWebRouter

$app, $controllerPrefix, $default, $input

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JApplicationWebRouterRest

Methods summary

Parameters

Throws

Since

Overrides

Parameters

Returns

Since

Parameters

Since

Returns

Since

Returns

Throws

Since

Methods inherited from JApplicationWebRouterBase

Methods inherited from JApplicationWebRouter

Magic methods summary

Properties summary

Since

Since

Properties inherited from JApplicationWebRouterBase

Properties inherited from JApplicationWebRouter