Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Fonctions membres publiques statiques | Fonctions membres protégées | Attributs protégés | Attributs protégés statiques
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())
 parse (&$uri)
 build ($url)
 getMode ()
 setMode ($mode)
 setVar ($key, $value, $create=true)
 setVars ($vars=array(), $merge=true)
 getVar ($key)
 getVars ()
 attachBuildRule ($callback)
 attachParseRule ($callback)
- Fonctions membres publiques inherited from JObject
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)
 toString ()

Fonctions membres publiques statiques

static getInstance ($client, $options=array())

Fonctions membres protégées

 _parseRawRoute (&$uri)
 _parseSefRoute (&$uri)
 _buildRawRoute (&$uri)
 _buildSefRoute (&$uri)
 _processParseRules (&$uri)
 _processBuildRules (&$uri)
 _createURI ($url)
 _encodeSegments ($segments)
 _decodeSegments ($segments)

Attributs protégés

 $mode = null
 $_mode = null
 $vars = array()
 $_vars = array()
 $rules
 $_rules
- Attributs protégés inherited from JObject
 $_errors = array()

Attributs protégés statiques

static $instances = array()

Documentation des constructeurs et destructeur

JRouter::__construct (   $options = array())

Class constructor

Paramètres:
array$optionsArray of options
Depuis:
11.1

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

Références $options, et JROUTER_MODE_RAW.

Documentation des fonctions membres

JRouter::_buildRawRoute ( &  $uri)
protected

Function to build a raw route

Paramètres:
JURI&$uriThe internal URL
Renvoie:
string Raw Route
Depuis:
11.1

Réimplémentée dans JRouterSite.

JRouter::_buildSefRoute ( &  $uri)
protected

Function to build a sef route

Paramètres:
JURI&$uriThe uri
Renvoie:
string The SEF route
Depuis:
11.1

Réimplémentée dans JRouterSite.

JRouter::_createURI (   $url)
protected

Create a uri based on a full or partial url string

Paramètres:
string$urlThe URI
Renvoie:
JURI
Depuis:
11.1

Réimplémentée dans JRouterSite.

Références $key, $url, et JURI\buildQuery().

+ Voici le graphe d'appel pour cette fonction :

JRouter::_decodeSegments (   $segments)
protected

Decode route segments

Paramètres:
array$segmentsAn array of route segments
Renvoie:
array Array of decoded route segments
Depuis:
11.1

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

JRouter::_encodeSegments (   $segments)
protected

Encode route segments

Paramètres:
array$segmentsAn array of route segments
Renvoie:
array Array of encoded route segments
Depuis:
11.1

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

JRouter::_parseRawRoute ( &  $uri)
protected

Function to convert a raw route to an internal URI

Paramètres:
JURI&$uriThe raw route
Renvoie:
boolean
Depuis:
11.1

Réimplémentée dans JRouterSite.

JRouter::_parseSefRoute ( &  $uri)
protected

Function to convert a sef route to an internal URI

Paramètres:
JURI&$uriThe sef URI
Renvoie:
string Internal URI
Depuis:
11.1

Réimplémentée dans JRouterSite.

JRouter::_processBuildRules ( &  $uri)
protected

Process the build uri query data based on custom defined rules

Paramètres:
JURI&$uriThe URI
Renvoie:
void
Depuis:
11.1

Réimplémentée dans JRouterSite.

Références $uri.

JRouter::_processParseRules ( &  $uri)
protected

Process the parsed router variables based on custom defined rules

Paramètres:
JURI&$uriThe URI to parse
Renvoie:
array The array of processed URI variables
Depuis:
11.1

Réimplémentée dans JRouterSite.

Références $uri.

JRouter::attachBuildRule (   $callback)

Attach a build rule

Paramètres:
callback$callbackThe function to be called
Renvoie:
void
Depuis:
11.1.
JRouter::attachParseRule (   $callback)

Attach a parse rule

Paramètres:
callback$callbackThe function to be called.
Renvoie:
void
Depuis:
11.1
JRouter::build (   $url)

Function to convert an internal URI to a route

Paramètres:
string$urlThe internal URL
Renvoie:
string The absolute search engine friendly URL
Depuis:
11.1

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

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

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

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

Paramètres:
string$clientThe name of the client
array$optionsAn associative array of options
Renvoie:
JRouter A JRouter object.
Depuis:
11.1

Références $client, $options, $path, JApplicationHelper\getClientInfo(), JError\raiseError(), et JText\sprintf().

Référencé par FinderIndexerHelper\getContentPath().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JRouter::getMode ( )

Get the router mode

Renvoie:
integer
Depuis:
11.1
JRouter::getVar (   $key)

Get a router variable

Paramètres:
string$keyThe name of the variable
Renvoie:
mixed Value of the variable
Depuis:
11.1

Références $key, et null.

JRouter::getVars ( )

Get the router variable array

Renvoie:
array An associative array of router variables
Depuis:
11.1
JRouter::parse ( &  $uri)

Function to convert a route to an internal URI

Paramètres:
JURI&$uriThe uri.
Renvoie:
array
Depuis:
11.1

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

Références $uri.

JRouter::setMode (   $mode)

Set the router mode

Paramètres:
integer$modeThe routing mode.
Renvoie:
void
Depuis:
11.1

Références $mode.

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

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

Paramètres:
string$keyThe name of the variable
mixed$valueThe value of the variable
boolean$createIf True, the variable will be created if it doesn't exist yet
Renvoie:
void
Depuis:
11.1

Références $key.

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

Set the router variable array

Paramètres:
array$varsAn associative array with variables
boolean$mergeIf True, the array will be merged instead of overwritten
Renvoie:
void
Depuis:
11.1

Documentation des données membres

JRouter::$_mode = null
protected
JRouter::$_rules
protected
Valeur initiale :
array(
'build' => array(),
'parse' => array()
)
JRouter::$_vars = array()
protected
JRouter::$instances = array()
staticprotected
JRouter::$mode = null
protected
JRouter::$rules
protected
Valeur initiale :
array(
'build' => array(),
'parse' => array()
)
JRouter::$vars = array()
protected
La documentation de cette classe a été générée à partir du fichier suivant :