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 SiteRouter
+ Graphe d'héritage de SiteRouter:

Fonctions membres publiques

 __construct ($options=array(), CMSApplication $app=null, \JMenu $menu=null)
 
 parse (&$uri)
 
 build ($url)
 
 getComponentRouter ($component)
 
 setComponentRouter ($component, $router)
 
- Fonctions membres publiques hérités de Router
 __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, $stage=self::PROCESS_DURING)
 
 attachParseRule ($callback, $stage=self::PROCESS_DURING)
 

Fonctions membres protégées

 parseRawRoute (&$uri)
 
 parseSefRoute (&$uri)
 
 buildRawRoute (&$uri)
 
 _buildSefRoute (&$uri)
 
 buildSefRoute (&$uri)
 
 processParseRules (&$uri, $stage=self::PROCESS_DURING)
 
 processBuildRules (&$uri, $stage=self::PROCESS_DURING)
 
 createUri ($url)
 
- Fonctions membres protégées hérités de Router
 _parseRawRoute (&$uri)
 
 parseRawRoute (&$uri)
 
 _parseSefRoute (&$uri)
 
 parseSefRoute (&$uri)
 
 _buildRawRoute (&$uri)
 
 buildRawRoute (&$uri)
 
 _buildSefRoute (&$uri)
 
 buildSefRoute (&$uri)
 
 _processParseRules (&$uri)
 
 processParseRules (&$uri, $stage=self::PROCESS_DURING)
 
 _processBuildRules (&$uri)
 
 processBuildRules (&$uri, $stage=self::PROCESS_DURING)
 
 _createUri ($url)
 
 createUri ($url)
 
 _encodeSegments ($segments)
 
 encodeSegments ($segments)
 
 _decodeSegments ($segments)
 
 decodeSegments ($segments)
 

Attributs protégés

 $componentRouters = array()
 
 $app
 
 $menu
 
- Attributs protégés hérités de Router
 $mode = null
 
 $_mode = null
 
 $vars = array()
 
 $_vars = array()
 
 $rules
 
 $_rules
 
 $cache = array()
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de Router
static getInstance ($client, $options=array())
 
- Champs de données hérités de Router
const PROCESS_BEFORE = 'preprocess'
 
const PROCESS_DURING = ''
 
const PROCESS_AFTER = 'postprocess'
 
- Attributs protégés statiques hérités de Router
static $instances = array()
 

Description détaillée

Class to create and parse routes for the site application

Depuis
1.5

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $options = array(),
CMSApplication  $app = null,
\JMenu  $menu = null 
)

Class constructor

Paramètres
array$optionsArray of options
CMSApplication$appCMSApplication Object
\JMenu$menuobject
Depuis
3.4

Références $app, $menu, $options, et CMSApplication\getInstance().

Documentation des fonctions membres

◆ _buildSefRoute()

_buildSefRoute ( $uri)
protected

Function to build a sef route

Paramètres
\JUri&$uriThe internal URL
Renvoie
void
Depuis
1.5
Obsolète:
4.0 Attach your logic as rule to the main build stage

Références $uri.

◆ build()

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
1.5

Références $format, $route, $uri, $url, et JROUTER_MODE_SEF.

◆ buildRawRoute()

buildRawRoute ( $uri)
protected

Function to build a raw route

Paramètres
\JUri&$uriThe internal URL
Renvoie
string Raw Route
Depuis
3.2
Obsolète:
4.0 Attach your logic as rule to the main build stage

Références $component, $query, et $uri.

◆ buildSefRoute()

buildSefRoute ( $uri)
protected

Function to build a sef route

Paramètres
\JUri&$uriThe uri
Renvoie
void
Depuis
3.2
Obsolète:
4.0 Attach your logic as rule to the main build stage

Références $component, $item, $parts, $query, $route, $tmp, $uri, et null.

◆ createUri()

createUri (   $url)
protected

Create a uri based on a full or partial URL string

Paramètres
string$urlThe URI
Renvoie
Depuis
3.2

Références $item, $itemid, $option, $uri, $url, et null.

◆ getComponentRouter()

getComponentRouter (   $component)

Get component router

Paramètres
string$componentName of the component including com_ prefix
Renvoie
RouterInterface Component router
Depuis
3.3

Références $class, $component, $path, et JPATH_SITE.

◆ parse()

parse ( $uri)

Function to convert a route to an internal URI

Paramètres
\JUri&$uriThe uri.
Renvoie
array
Depuis
1.5

Références $component, $path, $suffix, $uri, ComponentHelper\getComponents(), JPATH_SITE, et JROUTER_MODE_SEF.

◆ parseRawRoute()

parseRawRoute ( $uri)
protected

Function to convert a raw route to an internal URI

Paramètres
\JUri&$uriThe raw route
Renvoie
array
Depuis
3.2
Obsolète:
4.0 Attach your logic as rule to the main parse stage

Références $item, $uri, et null.

◆ parseSefRoute()

parseSefRoute ( $uri)
protected

Function to convert a sef route to an internal URI

Paramètres
\JUri&$uriThe sef URI
Renvoie
string Internal URI
Depuis
3.2
Obsolète:
4.0 Attach your logic as rule to the main parse stage

Références $component, $item, $items, $route, $suffix, $uri, elseif, et null.

◆ processBuildRules()

processBuildRules ( $uri,
  $stage = self::PROCESS_DURING 
)
protected

Process the build uri query data based on custom defined rules

Paramètres
\JUri&$uriThe URI
string$stageThe stage that should be processed. Possible values: 'preprocess', 'postprocess' and '' for the main build stage
Renvoie
void
Depuis
3.2
Obsolète:
4.0 The special logic should be implemented as rule

Références $component, $item, $itemid, $lang, $query, $route, $uri, JROUTER_MODE_SEF, et null.

◆ processParseRules()

processParseRules ( $uri,
  $stage = self::PROCESS_DURING 
)
protected

Process the parsed router variables based on custom defined rules

Paramètres
\JUri&$uriThe URI to parse
string$stageThe stage that should be processed. Possible values: 'preprocess', 'postprocess' and '' for the main parse stage
Renvoie
array The array of processed URI variables
Depuis
3.2

Références $start, $uri, JROUTER_MODE_SEF, et null.

◆ setComponentRouter()

setComponentRouter (   $component,
  $router 
)

Set a router for a component

Paramètres
string$componentComponent name with com_ prefix
object$routerComponent router
Renvoie
boolean True if the router was accepted, false if not
Depuis
3.3

Références $component.

Documentation des champs

◆ $app

$app
protected

◆ $componentRouters

$componentRouters = array()
protected

◆ $menu

$menu
protected

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