Référence de la classe JRouter

Graphe d'héritage de JRouter:

Graphe de collaboration de JRouter:

Liste de tous les membres

Fonctions membres publiques

• __construct ($options=array())
• & getInstance ($client, $options=array())
• parse (&$uri)
• & build ($url)
• getMode ()
• setMode ($mode)
• setVar ($key, $value, $create=true)
• setVars ($vars=array(), $merge=true)
• getVar ($key)
• getVars ()
• attachBuildRule ($callback)
• attachParseRule ($callback)
• _parseRawRoute (&$uri)
• _parseSefRoute (&$uri)
• _buildRawRoute (&$uri)
• _buildSefRoute (&$uri)
• _processParseRules (&$uri)
• _processBuildRules (&$uri)
• & _createURI ($url)
• _encodeSegments ($segments)
• _decodeSegments ($segments)

Attributs publics

• $_mode = null
• $_vars = array()
• $_rules

---

Documentation des constructeurs et destructeur

JRouter::__construct

(

$

options = array()

)

Class constructor

public

Réimplémentée dans JRouterSite.

---

Documentation des fonctions membres

JRouter::_buildRawRoute

(

&$

uri

)

Function to build a raw route

protected

Réimplémentée dans JRouterSite.

JRouter::_buildSefRoute

(

&$

uri

)

Function to build a sef route

protected

Réimplémentée dans JRouterSite.

& JRouter::_createURI

(

$

url

)

Create a uri based on a full or partial url string

protected

Renvoie:

JURI A JURI object

Réimplémentée dans JRouterSite.

Références $uri, et $url.

JRouter::_decodeSegments

(

$

segments

)

Decode route segments

protected

Paramètres:

array

An array of route segments

Renvoie:

array

Références $i, et $total.

JRouter::_encodeSegments

(

$

segments

)

Encode route segments

protected

Paramètres:

array

An array of route segments

Renvoie:

array

Références $i, et $total.

JRouter::_parseRawRoute

(

&$

uri

)

Function to convert a raw route to an internal URI

protected

Réimplémentée dans JRouterSite.

JRouter::_parseSefRoute

(

&$

uri

)

Function to convert a sef route to an internal URI

protected

Réimplémentée dans JRouterSite.

JRouter::_processBuildRules

(

&$

uri

)

Process the build uri query data based on custom defined rules

protected

Réimplémentée dans JRouterSite.

Références $uri.

JRouter::_processParseRules

(

&$

uri

)

Process the parsed router variables based on custom defined rules

protected

Réimplémentée dans JRouterSite.

Références $uri.

JRouter::attachBuildRule

(

$

callback

)

Attach a build rule

public

Paramètres:

callback

$callback

The function to be called.

JRouter::attachParseRule

(

$

callback

)

Attach a parse rule

public

Paramètres:

callback

$callback

The function to be called.

& JRouter::build

(

$

url

)

Function to convert an internal URI to a route

Paramètres:

string

$string

The internal URL

Renvoie:

string The absolute search engine friendly URL

Réimplémentée dans JRouterAdministrator, et JRouterSite.

Références $uri, et $url.

& JRouter::getInstance	(	$	client,
		$	options = array()
	)

Returns a reference to the global JRouter object, only creating it if it doesn't already exist.

This method must be invoked as:

  $menu = &JRouter::getInstance();

public

Paramètres:

string	$client	The name of the client
array	$options	An associative array of options

Renvoie:

JRouter A router object.

Références $classname, $client, $error, $path, JApplicationHelper::getClientInfo(), et JError::raiseError().

Référencé par JApplication::getRouter().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JRouter::getMode

(

)

Get the router mode

public

JRouter::getVar

(

$

key

)

Get a router variable

public

Paramètres:

string

$key

The name of the variable $return mixed Value of the variable

JRouter::getVars

(

)

Get the router variable array

public

Renvoie:

array An associative array of router variables

JRouter::parse

(

&$

uri

)

Function to convert a route to an internal URI

public

Réimplémentée dans JRouterSite.

Références $uri.

JRouter::setMode

(

$

mode

)

Get the router mode

public

JRouter::setVar	(	$	key,
		$	value,
		$	create = true
	)

Set a router variable, creating it if it doesn't exist

public

Paramètres:

string	$key	The name of the variable
mixed	$value	The value of the variable
boolean	$create	If True, the variable will be created if it doesn't exist yet

JRouter::setVars	(	$	vars = array(),
		$	merge = true
	)

Set the router variable array

public

Paramètres:

array	$vars	An associative array with variables
boolean	$create	If True, the array will be merged instead of overwritten

---

Documentation des données membres

JRouter::$_mode = null

JRouter::$_rules

Valeur initiale :

 array(
                'build' => array(),
                'parse' => array()
        )

JRouter::$_vars = array()

---

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

• libraries/joomla/application/router.php