Référence de la classe JApplicationWebRouterRest

Graphe d'héritage de JApplicationWebRouterRest:

Graphe de collaboration de JApplicationWebRouterRest:

Liste de tous les membres

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

Fonctions membres protégées
	fetchControllerSuffix ()
Fonctions membres protégées inherited from JApplicationWebRouterBase
	parseRoute ($route)
Fonctions membres protégées inherited from JApplicationWebRouter
	fetchController ($name)

Attributs protégés
	$methodInPostRequest = false
	$suffixMap
Attributs protégés inherited from JApplicationWebRouterBase
	$maps = array()
Attributs protégés inherited from JApplicationWebRouter
	$app
	$default
	$controllerPrefix
	$input

---

Description détaillée

Définition à la ligne 19 du fichier rest.php.

---

Documentation des fonctions membres

JApplicationWebRouterRest::execute

(

$route

)

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

Paramètres:

string

$route

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

Renvoie:

void

Depuis:

12.2

Exceptions:

InvalidArgumentException
RuntimeException

Réimplémentée à partir de JApplicationWebRouter.

Définition à la ligne 53 du fichier rest.php.

        {
                // Get the controller name based on the route patterns and requested route.
                $name = $this->parseRoute($route);

                // Append the HTTP method based suffix.
                $name .= $this->fetchControllerSuffix();

                // Get the controller object by name.
                $controller = $this->fetchController($name);

                // Execute the controller.
                $controller->execute();
        }

JApplicationWebRouterRest::fetchControllerSuffix ( )

protected

Get the controller class suffix string.

Renvoie:

string

Depuis:

12.2

Exceptions:

RuntimeException

Définition à la ligne 119 du fichier rest.php.

        {
                // Validate that we have a map to handle the given HTTP method.
                if (!isset($this->suffixMap[$this->input->getMethod()]))
                {
                        throw new RuntimeException(sprintf('Unable to support the HTTP method `%s`.', $this->input->getMethod()), 404);
                }

                // Check if request method is POST
                if ( $this->methodInPostRequest == true && strcmp(strtoupper($this->input->server->getMethod()), 'POST') === 0)
                {
                        // Get the method from input
                        $postMethod = $this->input->get->getWord('_method');

                        // Validate that we have a map to handle the given HTTP method from input
                        if ($postMethod && isset($this->suffixMap[strtoupper($postMethod)]))
                        {
                                return ucfirst($this->suffixMap[strtoupper($postMethod)]);
                        }
                }

                return ucfirst($this->suffixMap[$this->input->getMethod()]);
        }

JApplicationWebRouterRest::isMethodInPostRequest

(

)

Get the property to allow or not method in POST request

Renvoie:

boolean

Depuis:

12.2

Définition à la ligne 106 du fichier rest.php.

        {
                return $this->methodInPostRequest;
        }

JApplicationWebRouterRest::setHttpMethodSuffix	(		$method,
			$suffix
	)

Set a controller class suffix for a given HTTP method.

Paramètres:

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.

Renvoie:

JApplicationWebRouter This object for method chaining.

Depuis:

12.2

Définition à la ligne 78 du fichier rest.php.

        {
                $this->suffixMap[strtoupper((string) $method)] = (string) $suffix;

                return $this;
        }

JApplicationWebRouterRest::setMethodInPostRequest

(

$value

)

Set to allow or not method in POST request

Paramètres:

boolean

$value

A boolean to allow or not method in POST request

Renvoie:

void

Depuis:

12.2

Définition à la ligne 94 du fichier rest.php.

        {
                $this->methodInPostRequest = $value;
        }

---

Documentation des données membres

JApplicationWebRouterRest::$methodInPostRequest = false

protected

Définition à la ligne 26 du fichier rest.php.

JApplicationWebRouterRest::$suffixMap

protected

Valeur initiale :

 array(
                'GET' => 'Get',
                'POST' => 'Create',
                'PUT' => 'Update',
                'PATCH' => 'Update',
                'DELETE' => 'Delete',
                'HEAD' => 'Head',
                'OPTIONS' => 'Options'
        )

Définition à la ligne 32 du fichier rest.php.

---

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

• jplatform-13.1/joomla/application/web/router/rest.php