Référence de la classe Router

Graphe d'héritage de Router:

Fonctions membres publiques
	__construct (SiteApplication $app, AbstractMenu $menu, CategoryFactoryInterface $categoryFactory, DatabaseInterface $db)
	getCategorySegment ($id, $query)
	getCategoriesSegment ($id, $query)
	getArticleSegment ($id, $query)
	getFormSegment ($id, $query)
	getCategoryId ($segment, $query)
	getCategoriesId ($segment, $query)
	getArticleId ($segment, $query)
Fonctions membres publiques hérités de RouterView
	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
	$noIDs = false
Attributs protégés hérités de RouterView
	$name
	$rules = array()
	$views = array()

Fonctions membres privées
	getCategories (array $options=[])

Attributs privés
	$categoryFactory
	$categoryCache = []
	$db

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

Description détaillée

Routing class of com_content

Depuis

3.3

Documentation des constructeurs et destructeur

__construct()

__construct	(	SiteApplication	$app,
		AbstractMenu	$menu,
		CategoryFactoryInterface	$categoryFactory,
		DatabaseInterface	$db
	)

Content Component router constructor

Paramètres

SiteApplication	$app	The application object
AbstractMenu	$menu	The menu object to work with
CategoryFactoryInterface	$categoryFactory	The category object
DatabaseInterface	$db	The database object

Références $app, $article, $category, $db, $form, $menu, $params, $this, Symfony\Contracts\Service\__construct(), et ComponentHelper\getParams().

Documentation des fonctions membres

getArticleId()

getArticleId	(		$segment,
			$query
	)

Method to get the segment(s) for an article

Paramètres

string	$segment	Segment of the article to retrieve the ID for
array	$query	The request that is parsed right now

Renvoie

mixed The id of this item or false

Références $query, et ParameterType\INTEGER.

getArticleSegment()

getArticleSegment	(		$id,
			$query
	)

Method to get the segment(s) for an article

Paramètres

string	$id	ID of the article to retrieve the segments for
array	$query	The request that is built right now

Renvoie

array|string The segments of this item

Références $id, et ParameterType\INTEGER.

getCategories()

getCategories ( array  $options = [] )

private

Method to get categories from cache

Paramètres

array

$options

The options for retrieving categories

Renvoie

CategoryInterface The object containing categories

Depuis

4.0.0

Références $key, et $options.

getCategoriesId()

getCategoriesId	(		$segment,
			$query
	)

Method to get the segment(s) for a category

Paramètres

string	$segment	Segment to retrieve the ID for
array	$query	The request that is parsed right now

Renvoie

mixed The id of this item or false

Références $query.

getCategoriesSegment()

getCategoriesSegment	(		$id,
			$query
	)

Method to get the segment(s) for a category

Paramètres

string	$id	ID of the category to retrieve the segments for
array	$query	The request that is built right now

Renvoie

array|string The segments of this item

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

getCategoryId()

getCategoryId	(		$segment,
			$query
	)

Method to get the id for a category

Paramètres

string	$segment	Segment to retrieve the ID for
array	$query	The request that is parsed right now

Renvoie

mixed The id of this item or false

Références $category, et $query.

getCategorySegment()

getCategorySegment	(		$id,
			$query
	)

Method to get the segment(s) for a category

Paramètres

string	$id	ID of the category to retrieve the segments for
array	$query	The request that is built right now

Renvoie

array|string The segments of this item

Références $category, $id, et $path.

getFormSegment()

getFormSegment	(		$id,
			$query
	)

Method to get the segment(s) for a form

Paramètres

string	$id	ID of the article form to retrieve the segments for
array	$query	The request that is built right now

Renvoie

array|string The segments of this item

Depuis

3.7.3

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

Documentation des champs

$categoryCache

$categoryCache = []

private

$categoryFactory

$categoryFactory

private

$db

$db

private

$noIDs

$noIDs = false

protected

---

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

• components/com_content/src/Service/Router.php