Joomla! API

Download
Launch

Sites

Extends AbstractMediawikiObject

MediaWiki API Sites class.

since

1.0
package

Joomla Framework

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry options = null, \Joomla\Mediawiki\Http client = null) : mixed
inherited
since

1.0

Arguments

options

\Joomla\Registry\RegistryMediawiki options object.

client

\Joomla\Mediawiki\HttpThe HTTP client object.

Response

mixed

buildParameter

Method to build request parameters from a string array.

buildParameter(array params) : string
inherited
since

1.0

Arguments

params

arraystring array that contains the parameters

Response

stringrequest parameter

fetchUrl

Method to build and return a full request URL for the request.

fetchUrl(string path) : string
inherited
since

1.0

Arguments

path

stringURL to inflect

Response

stringThe request URL.

getEvents

Method to get events from logs.

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, int lelimit = null) : object
since

1.0

Arguments

leprop

arrayList of properties to get.

letype

stringFilter log actions to only this type.

leaction

stringFilter log actions to only this type.

letitle

stringFilter entries to those related to a page.

leprefix

stringFilter entries that start with this prefix.

letag

stringFilter entries with tag.

leuser

stringFilter entries made by the given user.

lestart

stringStarting timestamp.

leend

stringEnding timestamp.

ledir

stringDirection of enumeration.

lelimit

intEvent limit to return.

Response

object

getProtectedTitles

Method to get protected titles on a site.

getProtectedTitles(array ptnamespace = null, array ptlevel = null, int ptlimit = null, string ptdir = null, string ptstart = null, string ptend = null, array ptprop = null) : object
since

1.0

Arguments

ptnamespace

arrayOnly list titles in this namespace.

ptlevel

arrayOnly list titles with these protection level.

ptlimit

intLimit of pages to return.

ptdir

stringDirection of enumeration.

ptstart

stringStarting timestamp.

ptend

stringEnding timestamp.

ptprop

arrayList of properties to get.

Response

object

getRecentChanges

Method to get recent changes on a site.

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
since

1.0

Arguments

rcstart

stringStarting timestamp.

rcend

stringEnding timestamp.

rcdir

stringDirection of enumeration.

rcnamespace

arrayFilter changes to only this namespace(s).

rcuser

stringFilter changes by this user.

rcexcludeuser

stringFilter changes to exclude changes by this user.

rctag

stringFilter changes by this tag.

rcprop

arrayFilter log actions to only this type.

rctoken

arrayWhich token to obtain for each change.

rcshow

arrayFilter changes by this criteria.

rclimit

stringChanges limit to return.

rctype

stringFilter event by type of changes.

rctoponly

stringFilter changes which are latest revision.

Response

object

getSiteInfo

Method to get site information.

getSiteInfo(array siprop = null, string sifilteriw = null, bool sishowalldb = false, bool sinumberingroup = false, array siinlanguagecode = null) : object
since

1.0

Arguments

siprop

arrayThe sysinfo properties to get.

sifilteriw

stringOnly local or only non local entries to return.

sishowalldb

boolList all database servers.

sinumberingroup

boolList the number of users in usergroups.

siinlanguagecode

arrayLanguage code for localized languages.

Response

object

validateResponse

Method to validate response for errors

validateResponse(\Joomla\Http\Response response) : \SimpleXMLElement
inherited
since

1.0
throws

\DomainException

Arguments

response

\Joomla\Http\ResponseThe response from the mediawiki server.

Response

\SimpleXMLElement

Properties

options

Options for the Mediawiki object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Mediawiki\Http
  • \ Joomla
  • \ Mediawiki
  • \ Sites