Sites
Extends AbstractMediawikiObjectMediaWiki API Sites class.
| since |
1.0 |
|---|---|
| package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Mediawiki\Http client = null) :
buildParameter
Method to build request parameters from a string array.
buildParameter(mixed||string|int params) :
| since |
1.0 |
|---|
Arguments
- params
array<string|int, mixed>string array that contains the parameters
Response
stringrequest parameter
fetchUrl
Method to build and return a full request URL for the request.
fetchUrl( path) :
| since |
1.0 |
|---|
Arguments
- path
stringURL to inflect
Response
stringThe request URL.
getEvents
Method to get events from logs.
getEvents(array leprop = null, letype = null, leaction = null, letitle = null, leprefix = null, letag = null, leuser = null, lestart = null, leend = null, ledir = null, lelimit = null) :
| since |
1.0 |
|---|
Arguments
- leprop
array<string|int, mixed>|nullList 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, ptlimit = null, ptdir = null, ptstart = null, ptend = null, array ptprop = null) :
| since |
1.0 |
|---|
Arguments
- ptnamespace
array<string|int, mixed>|nullOnly list titles in this namespace.- ptlevel
array<string|int, mixed>|nullOnly list titles with these protection level.- ptlimit
intLimit of pages to return.- ptdir
stringDirection of enumeration.- ptstart
stringStarting timestamp.- ptend
stringEnding timestamp.- ptprop
array<string|int, mixed>|nullList of properties to get.
Response
object
getRecentChanges
Method to get recent changes on a site.
getRecentChanges( rcstart = null, rcend = null, rcdir = null, array rcnamespace = null, rcuser = null, rcexcludeuser = null, rctag = null, array rcprop = null, array rctoken = null, array rcshow = null, rclimit = null, rctype = null, rctoponly = null) :
| since |
1.0 |
|---|
Arguments
- rcstart
stringStarting timestamp.- rcend
stringEnding timestamp.- rcdir
stringDirection of enumeration.- rcnamespace
array<string|int, mixed>|nullFilter 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
array<string|int, mixed>|nullFilter log actions to only this type.- rctoken
array<string|int, mixed>|nullWhich token to obtain for each change.- rcshow
array<string|int, mixed>|nullFilter 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, sifilteriw = null, sishowalldb = false, sinumberingroup = false, array siinlanguagecode = null) :
| since |
1.0 |
|---|
Arguments
- siprop
array<string|int, mixed>|nullThe 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
array<string|int, mixed>|nullLanguage code for localized languages.
Response
object
validateResponse
Method to validate response for errors
validateResponse(\Joomla\Http\Response response) : \SimpleXMLElement
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- response
ResponseThe response from the mediawiki server.
Response
SimpleXMLElement