Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
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)
 
 getNewsfeedSegment ($id, $query)
 
 getCategoryId ($segment, $query)
 
 getCategoriesId ($segment, $query)
 
 getNewsfeedId ($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 from com_newsfeeds

Depuis
3.3

Documentation des constructeurs et destructeur

◆ __construct()

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

Newsfeeds Component router constructor

Paramètres
SiteApplication$appThe application object
AbstractMenu$menuThe menu object to work with
CategoryFactoryInterface$categoryFactoryThe category object
DatabaseInterface$dbThe database object

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

Documentation des fonctions membres

◆ getCategories()

getCategories ( array  $options = [])
private

Method to get categories from cache

Paramètres
array$optionsThe 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$segmentSegment to retrieve the ID for
array$queryThe 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$idID of the category to retrieve the segments for
array$queryThe 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$segmentSegment to retrieve the ID for
array$queryThe 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$idID of the category to retrieve the segments for
array$queryThe request that is built right now
Renvoie
array|string The segments of this item

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

◆ getNewsfeedId()

getNewsfeedId (   $segment,
  $query 
)

Method to get the segment(s) for a newsfeed

Paramètres
string$segmentSegment of the newsfeed to retrieve the ID for
array$queryThe request that is parsed right now
Renvoie
mixed The id of this item or false

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

◆ getNewsfeedSegment()

getNewsfeedSegment (   $id,
  $query 
)

Method to get the segment(s) for a newsfeed

Paramètres
string$idID of the newsfeed to retrieve the segments for
array$queryThe request that is built right now
Renvoie
array|string The segments of this item

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

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 :