Docs For Class JMediawikiCategories

Description

MediaWiki API Categories class for the Joomla Platform.

since: 12.3

Located in /libraries/joomla/mediawiki/categories.php (line 19)

JMediawikiObject
   |
   --JMediawikiCategories

Method Summary

object enumerateCategories ([string $acfrom = null], [string $acto = null], [string $acprefix = null], [string $acdir = null], [integer $acmin = null], [integer $acmax = null], [integer $aclimit = null], [array $acprop = null])

object getCategories (array $titles, [array $clprop = null], [array $clshow = null], [integer $cllimit = null], [boolean $clcontinue = false], [array $clcategories = null], [string $cldir = null])

object getCategoriesInfo (array $titles, [boolean $clcontinue = false])

object getCategoriesUsed (array $titles)

object getChangeTags ([array $tgprop = null], [string $tglimit = null])

Variables

Inherited Variables

Inherited from JMediawikiObject

JMediawikiObject::$client
JMediawikiObject::$options

Methods

enumerateCategories (line 149)

Method to enumerate all categories.

since: 12.3
access: public

object enumerateCategories ([string $acfrom = null], [string $acto = null], [string $acprefix = null], [string $acdir = null], [integer $acmin = null], [integer $acmax = null], [integer $aclimit = null], [array $acprop = null])

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.

getCategories (line 36)

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

since: 12.1
access: public

object getCategories (array $titles, [array $clprop = null], [array $clshow = null], [integer $cllimit = null], [boolean $clcontinue = false], [array $clcategories = null], [string $cldir = null])

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.

getCategoriesInfo (line 114)

Method to get information about the given categories.

since: 12.3
access: public

object getCategoriesInfo (array $titles, [boolean $clcontinue = false])

array $titles: Page titles to retrieve categories.
boolean $clcontinue: Continue when more results are available.

getCategoriesUsed (line 90)

Method to get information about all categories used.

since: 12.3
access: public

object getCategoriesUsed (array $titles)

array $titles: Page titles to retrieve categories.

getChangeTags (line 216)

Method to list change tags.

since: 12.3
access: public

object getChangeTags ([array $tgprop = null], [string $tglimit = null])

array $tgprop: List of properties to get.
string $tglimit: The maximum number of tags to limit.

Inherited Methods

Inherited From JMediawikiObject

JMediawikiObject::__construct()
JMediawikiObject::buildParameter()
JMediawikiObject::fetchUrl()
JMediawikiObject::validateResponse()