Class JMediawikiCategories
MediaWiki API Categories class for the Joomla Platform.
-
JMediawikiObject
-
JMediawikiCategories
Methods summary
public
object
|
#
getCategories( array $titles, array $clprop = null, array $clshow = null, integer $cllimit = null, boolean $clcontinue = false, array $clcategories = null, string $cldir = null )
Method to list all categories the page(s) belong to.
Method to list all categories the page(s) belong to.
Parameters
- $titles
array - $titles Page titles to retrieve categories.- $clprop
array - $clprop List of additional properties to get.- $clshow
array - $clshow Type of categories to show.- $cllimit
integer - $cllimit Number of categories to return.- $clcontinue
boolean - $clcontinue Continue when more results are available.- $clcategories
array - $clcategories Only list these categories.- $cldir
string - $cldir Direction of listing. Returns
object
Since
12.1
|
public
object
|
#
getCategoriesUsed( array $titles )
Method to get information about all categories used.
Method to get information about all categories used.
Parameters
- $titles
array - $titles Page titles to retrieve categories. Returns
object
Since
12.3
|
public
object
|
#
getCategoriesInfo( array $titles, boolean $clcontinue = false )
Method to get information about the given categories.
Method to get information about the given categories.
Parameters
- $titles
array - $titles Page titles to retrieve categories.- $clcontinue
boolean - $clcontinue Continue when more results are available. Returns
object
Since
12.3
|
public
object
|
#
getCategoryMembers( string $cmtitle = null, string $cmpageid = null, string $cmlimit = null, array $cmprop = null, array $cmnamespace = null, array $cmtype = null, string $cmstart = null, string $cmend = null, string $cmstartsortkey = null, string $cmendsortkey = null, string $cmstartsortkeyprefix = null, string $cmendsortkeyprefix = null, string $cmsort = null, string $cmdir = null, string $cmcontinue = null )
Method to get information about the pages within a category
Method to get information about the pages within a category
Parameters
- $cmtitle
string - $cmtitle The category title, must contain 'Category:' prefix, cannot be used
together with $cmpageid- $cmpageid
string - $cmpageid The category's page ID, cannot be used together with $cmtitle- $cmlimit
string - $cmlimit Maximum number of pages to retrieve- $cmprop
array - $cmprop Array of properties to retrieve- $cmnamespace
array - $cmnamespace Namespaces to retrieve pages from- $cmtype
array - $cmtype Array of category members to include, ignored if $cmsort is set to
'timestamp'- $cmstart
string - $cmstart Timestamp to start listing from, only used if $cmsort is set to
'timestamp'- $cmend
string - $cmend Timestamp to end listing at, only used if $cmsort is set to 'timestamp'- $cmstartsortkey
string - $cmstartsortkey Hexadecimal key to start listing from, only used if $cmsort is
set to 'sortkey'- $cmendsortkey
string - $cmendsortkey Hexadecimal key to end listing at, only used if $cmsort is set to
'sortkey'- $cmstartsortkeyprefix
string - $cmstartsortkeyprefix Hexadecimal key prefix to start listing from, only used if
$cmsort is set to 'sortkey', overrides $cmstartsortkey- $cmendsortkeyprefix
string - $cmendsortkeyprefix Hexadecimal key prefix to end listing before, only used if
$cmsort is set to 'sortkey', overrides $cmendsortkey- $cmsort
string - $cmsort Property to sort by- $cmdir
string - $cmdir Direction to sort in- $cmcontinue
string - $cmcontinue Used to continue a previous request Returns
object
Throws
Since
3.2.2 (CMS)
|
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 )
Method to enumerate all categories.
Method to enumerate all categories.
Parameters
- $acfrom
string - $acfrom The category to start enumerating from.- $acto
string - $acto The category to stop enumerating at.- $acprefix
string - $acprefix Search for all category titles that begin with this value.- $acdir
string - $acdir Direction to sort in.- $acmin
integer - $acmin Minimum number of category members.- $acmax
integer - $acmax Maximum number of category members.- $aclimit
integer - $aclimit How many categories to return.- $acprop
array - $acprop Which properties to get. Returns
object
Since
12.3
|
public
object
|
#
getChangeTags( array $tgprop = null, string $tglimit = null )
Method to list change tags.
Method to list change tags.
Parameters
- $tgprop
array - $tgprop List of properties to get.- $tglimit
string - $tglimit The maximum number of tags to limit. Returns
object
Since
12.3
|
__construct(),
buildParameter(),
fetchUrl(),
validateResponse()
Magic methods summary
Properties summary
$client,
$options
