站点

扩展自 AbstractMediawikiObject

MediaWiki API 站点类。

1.0

Joomla 框架

方法

__construct

构造函数。

__construct(\Joomla\Registry\Registry options = null, \Joomla\Mediawiki\Http client = null) : 
继承

1.0

参数

options

Registry|nullMediawiki 选项对象。

client

Http|nullHTTP 客户端对象。

响应

混合类型

buildParameter

从字符串数组构建请求参数的方法。

buildParameter(mixed||string|int params) : 
继承

1.0

参数

params

array<string|int, mixed>包含参数的字符串数组

响应

string请求参数

fetchUrl

构建并返回请求的完整请求 URL 的方法。

fetchUrl( path) : 
继承

1.0

参数

path

string要变形的 URL

响应

string请求 URL。

getEvents

从日志获取事件的方法。

getEvents(array leprop = null,  letype = null,  leaction = null,  letitle = null,  leprefix = null,  letag = null,  leuser = null,  lestart = null,  leend = null,  ledir = null,  lelimit = null) : 

1.0

参数

leprop

array<string|int, mixed>|null要获取的属性列表。

letype

string将日志操作过滤为仅此类型。

leaction

string将日志操作过滤为仅此类型。

letitle

string将条目过滤为与页面相关的条目。

leprefix

string过滤以该前缀开头的条目。

letag

string过滤带标签的条目。

leuser

string过滤由给定用户进行的条目。

lestart

string起始时间戳。

leend

string结束时间戳。

ledir

string枚举方向。

lelimit

int要返回的事件限制。

响应

object

getProtectedTitles

获取站点上的受保护标题的方法。

getProtectedTitles(array ptnamespace = null, array ptlevel = null,  ptlimit = null,  ptdir = null,  ptstart = null,  ptend = null, array ptprop = null) : 

1.0

参数

ptnamespace

array<string|int, mixed>|null仅列出此命名空间中的标题。

ptlevel

array<string|int, mixed>|null仅列出具有这些保护级别的标题。

ptlimit

int要返回的页面限制。

ptdir

string枚举方向。

ptstart

string起始时间戳。

ptend

string结束时间戳。

ptprop

array<string|int, mixed>|null要获取的属性列表。

响应

object

getRecentChanges

获取站点上的最近更改的方法。

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) : 

1.0

参数

rcstart

string起始时间戳。

rcend

string结束时间戳。

rcdir

string枚举方向。

rcnamespace

array<string|int, mixed>|null将更改过滤为仅此命名空间。

rcuser

string过滤由该用户进行的更改。

rcexcludeuser

string过滤更改以排除由该用户进行的更改。

rctag

string过滤由该标签进行的更改。

rcprop

array<string|int, mixed>|null将日志操作过滤为仅此类型。

rctoken

array<string|int, mixed>|null为每个更改获取哪个令牌。

rcshow

array<string|int, mixed>|null根据此条件过滤更改。

rclimit

string要返回的更改限制。

rctype

string按更改类型过滤事件。

rctoponly

string过滤最新修订版本的更改。

响应

object

getSiteInfo

获取站点信息的方法。

getSiteInfo(array siprop = null,  sifilteriw = null,  sishowalldb = false,  sinumberingroup = false, array siinlanguagecode = null) : 

1.0

参数

siprop

array<string|int, mixed>|null要获取的 sysinfo 属性。

sifilteriw

string仅返回本地或非本地条目。

sishowalldb

bool列出所有数据库服务器。

sinumberingroup

bool列出用户组中的用户数量。

siinlanguagecode

array<string|int, mixed>|null本地化语言的语言代码。

响应

object

validateResponse

验证响应以查找错误的方法

validateResponse(\Joomla\Http\Response response) : \SimpleXMLElement
继承

1.0

抛出

DomainException

参数

response

Response来自 Mediawiki 服务器的响应。

响应

SimpleXMLElement

属性

options

Mediawiki 对象的选项。

继承

1.0

类型

Registry

client

用于发送 HTTP 请求的 HTTP 客户端对象。

继承

1.0

类型

Http