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

Fonctions membres publiques

 getCategories (array $titles, array $clprop=null, array $clshow=null, $cllimit=null, $clcontinue=false, array $clcategories=null, $cldir=null)
 
 getCategoriesUsed (array $titles)
 
 getCategoriesInfo (array $titles, $clcontinue=false)
 
 getCategoryMembers ($cmtitle=null, $cmpageid=null, $cmlimit=null, array $cmprop=null, array $cmnamespace=null, array $cmtype=null, $cmstart=null, $cmend=null, $cmstartsortkey=null, $cmendsortkey=null, $cmstartsortkeyprefix=null, $cmendsortkeyprefix=null, $cmsort=null, $cmdir=null, $cmcontinue=null)
 
 enumerateCategories ($acfrom=null, $acto=null, $acprefix=null, $acdir=null, $acmin=null, $acmax=null, $aclimit=null, array $acprop=null)
 
 getChangeTags (array $tgprop=null, $tglimit=null)
 
- Fonctions membres publiques hérités de JMediawikiObject
 __construct (Registry $options=null, JMediawikiHttp $client=null)
 
 buildParameter (array $params)
 
 validateResponse ($response)
 

Membres hérités additionnels

- Fonctions membres protégées hérités de JMediawikiObject
 fetchUrl ($path)
 
- Attributs protégés hérités de JMediawikiObject
 $options
 
 $client
 

Description détaillée

MediaWiki API Categories class for the Joomla Platform.

Depuis
3.1.4

Documentation des fonctions membres

◆ enumerateCategories()

enumerateCategories (   $acfrom = null,
  $acto = null,
  $acprefix = null,
  $acdir = null,
  $acmin = null,
  $acmax = null,
  $aclimit = null,
array  $acprop = null 
)

Method to enumerate all categories.

Paramètres
string$acfromThe category to start enumerating from.
string$actoThe category to stop enumerating at.
string$acprefixSearch for all category titles that begin with this value.
string$acdirDirection to sort in.
integer$acminMinimum number of category members.
integer$acmaxMaximum number of category members.
integer$aclimitHow many categories to return.
array$acpropWhich properties to get.
Renvoie
object
Depuis
3.1.4

Références $path.

◆ getCategories()

getCategories ( array  $titles,
array  $clprop = null,
array  $clshow = null,
  $cllimit = null,
  $clcontinue = false,
array  $clcategories = null,
  $cldir = null 
)

Method to list all categories the page(s) belong to.

Paramètres
array$titlesPage titles to retrieve categories.
array$clpropList of additional properties to get.
array$clshowType of categories to show.
integer$cllimitNumber of categories to return.
boolean$clcontinueContinue when more results are available.
array$clcategoriesOnly list these categories.
string$cldirDirection of listing.
Renvoie
object
Depuis
3.0.0

Références $path.

◆ getCategoriesInfo()

getCategoriesInfo ( array  $titles,
  $clcontinue = false 
)

Method to get information about the given categories.

Paramètres
array$titlesPage titles to retrieve categories.
boolean$clcontinueContinue when more results are available.
Renvoie
object
Depuis
3.1.4

Références $path.

◆ getCategoriesUsed()

getCategoriesUsed ( array  $titles)

Method to get information about all categories used.

Paramètres
array$titlesPage titles to retrieve categories.
Renvoie
object
Depuis
3.1.4

Références $path.

◆ getCategoryMembers()

getCategoryMembers (   $cmtitle = null,
  $cmpageid = null,
  $cmlimit = null,
array  $cmprop = null,
array  $cmnamespace = null,
array  $cmtype = null,
  $cmstart = null,
  $cmend = null,
  $cmstartsortkey = null,
  $cmendsortkey = null,
  $cmstartsortkeyprefix = null,
  $cmendsortkeyprefix = null,
  $cmsort = null,
  $cmdir = null,
  $cmcontinue = null 
)

Method to get information about the pages within a category

Paramètres
string$cmtitleThe category title, must contain 'Category:' prefix, cannot be used together with $cmpageid
string$cmpageidThe category's page ID, cannot be used together with $cmtitle
string$cmlimitMaximum number of pages to retrieve
array$cmpropArray of properties to retrieve
array$cmnamespaceNamespaces to retrieve pages from
array$cmtypeArray of category members to include, ignored if $cmsort is set to 'timestamp'
string$cmstartTimestamp to start listing from, only used if $cmsort is set to 'timestamp'
string$cmendTimestamp to end listing at, only used if $cmsort is set to 'timestamp'
string$cmstartsortkeyHexadecimal key to start listing from, only used if $cmsort is set to 'sortkey'
string$cmendsortkeyHexadecimal key to end listing at, only used if $cmsort is set to 'sortkey'
string$cmstartsortkeyprefixHexadecimal key prefix to start listing from, only used if $cmsort is set to 'sortkey', overrides $cmstartsortkey
string$cmendsortkeyprefixHexadecimal key prefix to end listing before, only used if $cmsort is set to 'sortkey', overrides $cmendsortkey
string$cmsortProperty to sort by
string$cmdirDirection to sort in
string$cmcontinueUsed to continue a previous request
Renvoie
object
Depuis
3.2.2 (CMS)
Exceptions
RuntimeException

Références $path.

◆ getChangeTags()

getChangeTags ( array  $tgprop = null,
  $tglimit = null 
)

Method to list change tags.

Paramètres
array$tgpropList of properties to get.
string$tglimitThe maximum number of tags to limit.
Renvoie
object
Depuis
3.1.4

Références $path.


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