Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JApplicationWebRouterRest
+ Graphe d'héritage de JApplicationWebRouterRest:

Fonctions membres publiques

 execute ($route)
 
 setHttpMethodSuffix ($method, $suffix)
 
 setMethodInPostRequest ($value)
 
 isMethodInPostRequest ()
 
- Fonctions membres publiques hérités de JApplicationWebRouterBase
 addMap ($pattern, $controller)
 
 addMaps ($maps)
 
- Fonctions membres publiques hérités de JApplicationWebRouter
 __construct (JApplicationWeb $app, JInput $input=null)
 
 execute ($route)
 
 setControllerPrefix ($prefix)
 
 setDefaultController ($name)
 

Fonctions membres protégées

 fetchControllerSuffix ()
 
- Fonctions membres protégées hérités de JApplicationWebRouterBase
 parseRoute ($route)
 
- Fonctions membres protégées hérités de JApplicationWebRouter
 parseRoute ($route)
 
 fetchController ($name)
 

Attributs protégés

 $methodInPostRequest = false
 
 $suffixMap
 
- Attributs protégés hérités de JApplicationWebRouterBase
 $maps = array()
 
- Attributs protégés hérités de JApplicationWebRouter
 $app
 
 $default
 
 $controllerPrefix
 
 $input
 

Description détaillée

RESTful Web application router class for the Joomla Platform.

Depuis
3.0
Obsolète:
4.0 Use the joomla/router package via Composer instead

Documentation des fonctions membres

◆ execute()

execute (   $route)

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

Paramètres
string$routeThe route string for which to find and execute a controller.
Renvoie
void
Depuis
3.0
Exceptions
InvalidArgumentException
RuntimeException

Références $controller, $name, et $route.

◆ fetchControllerSuffix()

fetchControllerSuffix ( )
protected

Get the controller class suffix string.

Renvoie
string
Depuis
3.0
Exceptions
RuntimeException

◆ isMethodInPostRequest()

isMethodInPostRequest ( )

Get the property to allow or not method in POST request

Renvoie
boolean
Depuis
3.0

◆ setHttpMethodSuffix()

setHttpMethodSuffix (   $method,
  $suffix 
)

Set a controller class suffix for a given HTTP method.

Paramètres
string$methodThe HTTP method for which to set the class suffix.
string$suffixThe class suffix to use when fetching the controller name for a given request.
Renvoie
JApplicationWebRouter This object for method chaining.
Depuis
3.0

Références $suffix.

◆ setMethodInPostRequest()

setMethodInPostRequest (   $value)

Set to allow or not method in POST request

Paramètres
boolean$valueA boolean to allow or not method in POST request
Renvoie
void
Depuis
3.0

Références $value.

Documentation des champs

◆ $methodInPostRequest

$methodInPostRequest = false
protected

◆ $suffixMap

$suffixMap
protected
Valeur initiale :
= array(
'GET' => 'Get',
'POST' => 'Create',
'PUT' => 'Update',
'PATCH' => 'Update',
'DELETE' => 'Delete',
'HEAD' => 'Head',
'OPTIONS' => 'Options',
)

La documentation de cette classe a été générée à partir du fichier suivant :