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

Fonctions membres publiques

 registerView (RouterViewConfiguration $view)
 
 getViews ()
 
 getPath ($query)
 
 getRules ()
 
 attachRules ($rules)
 
 attachRule (RulesInterface $rule)
 
 detachRule (RulesInterface $rule)
 
 preprocess ($query)
 
 build (&$query)
 
 parse (&$segments)
 
 getName ()
 
- Fonctions membres publiques hérités de RouterBase
 __construct ($app=null, $menu=null)
 
 preprocess ($query)
 

Attributs protégés

 $name
 
 $rules = array()
 
 $views = array()
 

Membres hérités additionnels

- Champs de données hérités de RouterBase
 $app
 
 $menu
 

Description détaillée

View-based component routing class

Depuis
3.5

Documentation des fonctions membres

◆ attachRule()

attachRule ( RulesInterface  $rule)

Attach a build rule

Paramètres
RulesInterface$ruleThe function to be called.
Renvoie
void
Depuis
3.5

◆ attachRules()

attachRules (   $rules)

Add a number of router rules to the object

Paramètres
RulesInterface[]$rules Array of JComponentRouterRulesInterface objects
Renvoie
void
Depuis
3.5

◆ build()

build ( $query)

Build method for URLs

Paramètres
array&$queryArray of query elements
Renvoie
array Array of URL segments
Depuis
3.5

Implémente RouterInterface.

Références $query.

◆ detachRule()

detachRule ( RulesInterface  $rule)

Remove a build rule

Paramètres
RulesInterface$ruleThe rule to be removed.
Renvoie
boolean Was a rule removed?
Depuis
3.5

Références $id, et $r.

◆ getName()

getName ( )

Method to return the name of the router

Renvoie
string Name of the router
Depuis
3.5

Références $name, $r, name, et null.

◆ getPath()

getPath (   $query)

Get the path of views from target view to root view including content items of a nestable view

Paramètres
array$queryArray of query elements
Renvoie
array List of views including IDs of content items
Depuis
3.5

Références $key, $path, $query, $start, $view, et elseif.

◆ getRules()

getRules ( )

Get all currently attached rules

Renvoie
RulesInterface[] All currently attached rules in an array
Depuis
3.5

◆ getViews()

getViews ( )

Return an array of registered view objects

Renvoie
RouterViewConfiguration[] Array of registered view objects
Depuis
3.5

◆ parse()

parse ( $segments)

Parse method for URLs

Paramètres
array&$segmentsArray of URL string-segments
Renvoie
array Associative array of query values
Depuis
3.5

Implémente RouterInterface.

◆ preprocess()

preprocess (   $query)

Generic method to preprocess a URL

Paramètres
array$queryAn associative array of URL arguments
Renvoie
array The URL arguments to use to assemble the subsequent URL.
Depuis
3.5

Implémente RouterInterface.

Références $query.

◆ registerView()

registerView ( RouterViewConfiguration  $view)

Register the views of a component

Paramètres
RouterViewConfiguration$viewView configuration object
Renvoie
void
Depuis
3.5

Références $view.

Documentation des champs

◆ $name

$name
protected

◆ $rules

$rules = array()
protected

◆ $views

$views = array()
protected

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