Référence de la classe JApplicationWebRouter

Graphe d'héritage de JApplicationWebRouter:

Liste de tous les membres

Fonctions membres publiques
	__construct (JApplicationWeb $app, JInput $input=null)
	execute ($route)
	setControllerPrefix ($prefix)
	setDefaultController ($name)

Fonctions membres protégées
	parseRoute ($route)
	fetchController ($name)

Attributs protégés
	$app
	$default
	$controllerPrefix
	$input

---

Description détaillée

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

---

Documentation des constructeurs et destructeur

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

Constructor.

Paramètres:

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.

Depuis:

12.2

Définition à la ligne 54 du fichier router.php.

        {
                $this->app   = $app;
                $this->input = ($input === null) ? $this->app->input : $input;
        }

---

Documentation des fonctions membres

JApplicationWebRouter::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:

mixed The return value of the controller executed

Depuis:

12.2

Exceptions:

InvalidArgumentException
RuntimeException

Réimplémentée dans JApplicationWebRouterRest.

Définition à la ligne 71 du fichier router.php.

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

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

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

JApplicationWebRouter::fetchController (   $name )

protected

Get a JController object for a given name.

Paramètres:

string

$name

The controller name (excluding prefix) for which to fetch and instance.

Renvoie:

JController

Depuis:

12.2

Exceptions:

RuntimeException

Définition à la ligne 137 du fichier router.php.

        {
                // Derive the controller class name.
                $class = $this->controllerPrefix . ucfirst($name);

                // If the controller class does not exist panic.
                if (!class_exists($class) || !is_subclass_of($class, 'JController'))
                {
                        throw new RuntimeException(sprintf('Unable to locate controller `%s`.', $class), 404);
                }

                // Instantiate the controller.
                $controller = new $class($this->input, $this->app);

                return $controller;
        }

JApplicationWebRouter::parseRoute (   $route )

abstractprotected

Parse the given route and return the name of a controller mapped to the given route.

Paramètres:

string

$route

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

Renvoie:

string The controller name for the given route excluding prefix.

Depuis:

12.2

Exceptions:

InvalidArgumentException

Réimplémentée dans JApplicationWebRouterBase.

JApplicationWebRouter::setControllerPrefix

(

$prefix

)

Set the controller name prefix.

Paramètres:

string

$prefix

Controller class name prefix for creating controller objects by name.

Renvoie:

JApplicationWebRouter This object for method chaining.

Depuis:

12.2

Définition à la ligne 92 du fichier router.php.

        {
                $this->controllerPrefix = (string) $prefix;

                return $this;
        }

JApplicationWebRouter::setDefaultController

(

$name

)

Set the default controller name.

Paramètres:

string

$name

The default page controller name for an empty route.

Renvoie:

JApplicationWebRouter This object for method chaining.

Depuis:

12.2

Définition à la ligne 108 du fichier router.php.

        {
                $this->default = (string) $name;

                return $this;
        }

---

Documentation des données membres

JApplicationWebRouter::$app

protected

Définition à la ligne 25 du fichier router.php.

JApplicationWebRouter::$controllerPrefix

protected

Définition à la ligne 37 du fichier router.php.

JApplicationWebRouter::$default

protected

Définition à la ligne 31 du fichier router.php.

JApplicationWebRouter::$input

protected

Définition à la ligne 43 du fichier router.php.

---

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

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