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) : mixed
since |
1.0 |
---|
Arguments
- options
\Joomla\Registry\Registry
Mediawiki options object.- client
\Joomla\Mediawiki\Http
The HTTP client object.
Response
mixed
buildParameter
Method to build request parameters from a string array.
buildParameter(array params) : string
since |
1.0 |
---|
Arguments
- params
array
string array that contains the parameters
Response
string
request parameter
fetchUrl
Method to build and return a full request URL for the request.
fetchUrl(string path) : string
since |
1.0 |
---|
Arguments
- path
string
URL to inflect
Response
string
The 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
array
List of properties to get.- letype
string
Filter log actions to only this type.- leaction
string
Filter log actions to only this type.- letitle
string
Filter entries to those related to a page.- leprefix
string
Filter entries that start with this prefix.- letag
string
Filter entries with tag.- leuser
string
Filter entries made by the given user.- lestart
string
Starting timestamp.- leend
string
Ending timestamp.- ledir
string
Direction of enumeration.- lelimit
int
Event 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
array
Only list titles in this namespace.- ptlevel
array
Only list titles with these protection level.- ptlimit
int
Limit of pages to return.- ptdir
string
Direction of enumeration.- ptstart
string
Starting timestamp.- ptend
string
Ending timestamp.- ptprop
array
List 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
string
Starting timestamp.- rcend
string
Ending timestamp.- rcdir
string
Direction of enumeration.- rcnamespace
array
Filter changes to only this namespace(s).- rcuser
string
Filter changes by this user.- rcexcludeuser
string
Filter changes to exclude changes by this user.- rctag
string
Filter changes by this tag.- rcprop
array
Filter log actions to only this type.- rctoken
array
Which token to obtain for each change.- rcshow
array
Filter changes by this criteria.- rclimit
string
Changes limit to return.- rctype
string
Filter event by type of changes.- rctoponly
string
Filter 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
array
The sysinfo properties to get.- sifilteriw
string
Only local or only non local entries to return.- sishowalldb
bool
List all database servers.- sinumberingroup
bool
List the number of users in usergroups.- siinlanguagecode
array
Language 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
\Joomla\Http\Response
The response from the mediawiki server.
Response
\SimpleXMLElement
Properties
options
Options for the Mediawiki object.
since |
1.0 |
---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
since |
1.0 |
---|
Type(s)
\Joomla\Mediawiki\Http