Docs For Class JMediawikiSites

Description

MediaWiki API Sites class for the Joomla Platform.

since: 12.3

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

JMediawikiObject
   |
   --JMediawikiSites

Method Summary

object getEvents ([array $leprop = null], [string $letype = null], [string $leaction = null], [string $letitle = null], [string $leprefix = null], [string $letag = null], [string $leuser = null], [string $lestart = null], [string $leend = null], [string $ledir = null], [integer $lelimit = null])

object getProtectedTitles ([array $ptnamespace = null], [array $ptlevel = null], [integer $ptlimit = null], [string $ptdir = null], [string $ptstart = null], [string $ptend = null], [array $ptprop = null])

object getRecentChanges ([string $rcstart = null], [string $rcend = null], [string $rcdir = null], [array $rcnamespace = null], [string $rcuser = null], [string $rcexcludeuser = null], [string $rctag = null], [array $rcprop = null], [array $rctoken = null], [array $rcshow = null], [string $rclimit = null], [string $rctype = null], [string $rctoponly = null])

object getSiteInfo ([array $siprop = null], [string $sifilteriw = null], [boolean $sishowalldb = false], [boolean $sinumberingroup = false], [array $siinlanguagecode = null])

Variables

Inherited Variables

Inherited from JMediawikiObject

JMediawikiObject::$client
JMediawikiObject::$options

Methods

getEvents (line 89)

Method to get events from logs.

since: 12.3
access: public

object getEvents ([array $leprop = null], [string $letype = null], [string $leaction = null], [string $letitle = null], [string $leprefix = null], [string $letag = null], [string $leuser = null], [string $lestart = null], [string $leend = null], [string $ledir = null], [integer $lelimit = null])

array $leprop: List of properties to get.
string $letype: Filter log actions to only this type.
string $leaction: Filter log actions to only this type.
string $letitle: Filter entries to those related to a page.
string $leprefix: Filter entries that start with this prefix.
string $letag: Filter entries with tag.
string $leuser: Filter entries made by the given user.
string $lestart: Starting timestamp.
string $leend: Ending timestamp.
string $ledir: Direction of enumeration.
integer $lelimit: Event limit to return.

getProtectedTitles (line 269)

Method to get protected titles on a site.

since: 12.3
access: public

object getProtectedTitles ([array $ptnamespace = null], [array $ptlevel = null], [integer $ptlimit = null], [string $ptdir = null], [string $ptstart = null], [string $ptend = null], [array $ptprop = null])

array $ptnamespace: Only list titles in this namespace.
array $ptlevel: Only list titles with these protection level.
integer $ptlimit: Limit of pages to return.
string $ptdir: Direction of enumeration.
string $ptstart: Starting timestamp.
string $ptend: Ending timestamp.
array $ptprop: List of properties to get.

getRecentChanges (line 177)

Method to get recent changes on a site.

since: 12.3
access: public

object getRecentChanges ([string $rcstart = null], [string $rcend = null], [string $rcdir = null], [array $rcnamespace = null], [string $rcuser = null], [string $rcexcludeuser = null], [string $rctag = null], [array $rcprop = null], [array $rctoken = null], [array $rcshow = null], [string $rclimit = null], [string $rctype = null], [string $rctoponly = null])

string $rcstart: Starting timestamp.
string $rcend: Ending timestamp.
string $rcdir: Direction of enumeration.
array $rcnamespace: Filter changes to only this namespace(s).
string $rcuser: Filter changes by this user.
string $rcexcludeuser: Filter changes to exclude changes by this user.
string $rctag: Filter changes by this tag.
array $rcprop: Filter log actions to only this type.
array $rctoken: Which token to obtain for each change.
array $rcshow: Filter changes by this criteria.
string $rclimit: Changes limit to return.
string $rctype: Filter event by type of changes.
string $rctoponly: Filter changes which are latest revision.

getSiteInfo (line 34)

Method to get site information.

since: 12.3
access: public

object getSiteInfo ([array $siprop = null], [string $sifilteriw = null], [boolean $sishowalldb = false], [boolean $sinumberingroup = false], [array $siinlanguagecode = null])

array $siprop: The sysinfo properties to get.
string $sifilteriw: Only local or only non local entries to return.
boolean $sishowalldb: List all database servers.
boolean $sinumberingroup: List the number of users in usergroups.
array $siinlanguagecode: Language code for localized languages.

Inherited Methods

Inherited From JMediawikiObject

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