Class JMediawikiSites

MediaWiki API Sites class for the Joomla Platform.

JMediawikiSites

Package: Joomla\Platform\MediaWiki
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/mediawiki/sites.php

Methods summary

`public object`	# `getSiteInfo( array $siprop = null, string $sifilteriw = null, boolean $sishowalldb = false, boolean $sinumberingroup = false, array $siinlanguagecode = null )` Method to get site information. Method to get site information. Parameters `$siprop` `array` - $siprop The sysinfo properties to get. `$sifilteriw` `string` - $sifilteriw Only local or only non local entries to return. `$sishowalldb` `boolean` - $sishowalldb List all database servers. `$sinumberingroup` `boolean` - $sinumberingroup List the number of users in usergroups. `$siinlanguagecode` `array` - $siinlanguagecode Language code for localized languages. Returns `object` Since 12.3
`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 )` Method to get events from logs. Method to get events from logs. Parameters `$leprop` `array` - $leprop List of properties to get. `$letype` `string` - $letype Filter log actions to only this type. `$leaction` `string` - $leaction Filter log actions to only this type. `$letitle` `string` - $letitle Filter entries to those related to a page. `$leprefix` `string` - $leprefix Filter entries that start with this prefix. `$letag` `string` - $letag Filter entries with tag. `$leuser` `string` - $leuser Filter entries made by the given user. `$lestart` `string` - $lestart Starting timestamp. `$leend` `string` - $leend Ending timestamp. `$ledir` `string` - $ledir Direction of enumeration. `$lelimit` `integer` - $lelimit Event limit to return. Returns `object` Since 12.3
`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 )` Method to get recent changes on a site. Method to get recent changes on a site. Parameters `$rcstart` `string` - $rcstart Starting timestamp. `$rcend` `string` - $rcend Ending timestamp. `$rcdir` `string` - $rcdir Direction of enumeration. `$rcnamespace` `array` - $rcnamespace Filter changes to only this namespace(s). `$rcuser` `string` - $rcuser Filter changes by this user. `$rcexcludeuser` `string` - $rcexcludeuser Filter changes to exclude changes by this user. `$rctag` `string` - $rctag Filter changes by this tag. `$rcprop` `array` - $rcprop Filter log actions to only this type. `$rctoken` `array` - $rctoken Which token to obtain for each change. `$rcshow` `array` - $rcshow Filter changes by this criteria. `$rclimit` `string` - $rclimit Changes limit to return. `$rctype` `string` - $rctype Filter event by type of changes. `$rctoponly` `string` - $rctoponly Filter changes which are latest revision. Returns `object` Since 12.3
`public object`	# `getProtectedTitles( array $ptnamespace = null, array $ptlevel = null, integer $ptlimit = null, string $ptdir = null, string $ptstart = null, string $ptend = null, array $ptprop = null )` Method to get protected titles on a site. Method to get protected titles on a site. Parameters `$ptnamespace` `array` - $ptnamespace Only list titles in this namespace. `$ptlevel` `array` - $ptlevel Only list titles with these protection level. `$ptlimit` `integer` - $ptlimit Limit of pages to return. `$ptdir` `string` - $ptdir Direction of enumeration. `$ptstart` `string` - $ptstart Starting timestamp. `$ptend` `string` - $ptend Ending timestamp. `$ptprop` `array` - $ptprop List of properties to get. Returns `object` Since 12.3

Methods inherited from JMediawikiObject

__construct(), buildParameter(), fetchUrl(), validateResponse()

Magic methods summary

Properties summary

Properties inherited from JMediawikiObject

$client, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JMediawikiSites

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from JMediawikiObject

Magic methods summary

Properties summary

Properties inherited from JMediawikiObject