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	$acfrom	The category to start enumerating from.
string	$acto	The category to stop enumerating at.
string	$acprefix	Search for all category titles that begin with this value.
string	$acdir	Direction to sort in.
integer	$acmin	Minimum number of category members.
integer	$acmax	Maximum number of category members.
integer	$aclimit	How many categories to return.
array	$acprop	Which 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	$titles	Page titles to retrieve categories.
array	$clprop	List of additional properties to get.
array	$clshow	Type of categories to show.
integer	$cllimit	Number of categories to return.
boolean	$clcontinue	Continue when more results are available.
array	$clcategories	Only list these categories.
string	$cldir	Direction 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	$titles	Page titles to retrieve categories.
boolean	$clcontinue	Continue 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

$titles

Page 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	$cmtitle	The category title, must contain 'Category:' prefix, cannot be used together with $cmpageid
string	$cmpageid	The category's page ID, cannot be used together with $cmtitle
string	$cmlimit	Maximum number of pages to retrieve
array	$cmprop	Array of properties to retrieve
array	$cmnamespace	Namespaces to retrieve pages from
array	$cmtype	Array of category members to include, ignored if $cmsort is set to 'timestamp'
string	$cmstart	Timestamp to start listing from, only used if $cmsort is set to 'timestamp'
string	$cmend	Timestamp to end listing at, only used if $cmsort is set to 'timestamp'
string	$cmstartsortkey	Hexadecimal key to start listing from, only used if $cmsort is set to 'sortkey'
string	$cmendsortkey	Hexadecimal key to end listing at, only used if $cmsort is set to 'sortkey'
string	$cmstartsortkeyprefix	Hexadecimal key prefix to start listing from, only used if $cmsort is set to 'sortkey', overrides $cmstartsortkey
string	$cmendsortkeyprefix	Hexadecimal key prefix to end listing before, only used if $cmsort is set to 'sortkey', overrides $cmendsortkey
string	$cmsort	Property to sort by
string	$cmdir	Direction to sort in
string	$cmcontinue	Used 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	$tgprop	List of properties to get.
string	$tglimit	The 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 :

• libraries/joomla/mediawiki/categories.php