Joomla! 框架 3.x API » \Joomla\Mediawiki\Pages

构造函数。

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

继承

自	1.0

参数

options: Registry|nullMediawiki 选项对象。
client: Http|nullHTTP 客户端对象。

Response

混合

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

buildParameter(mixed||string|int params) :

继承

自	1.0

参数

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

Response

string请求参数

用于更改页面保护级别的方法。

changeProtection( title,  protections,  expiry = null,  reason = null,  cascade = null,  watchlist = null) :

自	1.0

参数

title: string要（取消）保护的页面的标题。
protections: string用管道分隔的保护级别列表。
expiry: string过期时间戳。
reason: string（取消）保护的原因（可选）。
cascade: string启用级联保护。
watchlist: string无条件地将页面添加到或从您的监视列表中删除。

Response

object

用于删除页面的方法。

deletePageByID( pageid,  reason = null,  watchlist = null,  oldimage = null) :

自	1.0

参数

pageid: string要删除的页面的页面 ID。
reason: string删除的原因。
watchlist: string无条件地将页面添加到或从您的监视列表中删除。
oldimage: string要删除的旧图像的名称。

Response

object

用于删除页面的方法。

deletePageByName( title,  reason = null,  watchlist = null,  oldimage = null) :

自	1.0

参数

title: string要删除的页面的标题。
reason: string删除的原因。
watchlist: string无条件地将页面添加到或从您的监视列表中删除。
oldimage: string要删除的旧图像的名称。

Response

object

用于编辑页面的方法。

editPage( title,  section = null,  sectiontitle = null,  text = null,  summary = null) :

自	1.0

参数

title: string页面标题。
section: int节号。
sectiontitle: string新节的标题。
text: string页面内容。
summary: string要删除的页面的标题。

Response

object

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

fetchUrl( path) :

继承

自	1.0

参数

path: string要影响的 URL

Response

string请求 URL。

用于获取所有链接到给定页面的页面的方法。

getBackLinks( bltitle,  blpageid = null,  blcontinue = null, array blnamespace = null,  blfilterredirect = null,  bllimit = null,  blredirect = null) :

自	1.0

参数

bltitle: string要搜索的标题。
blpageid: int要搜索的页面 ID。
blcontinue: bool当有更多结果可用时，使用此参数继续。
blnamespace: array<string|int, mixed>|null要枚举的命名空间。
blfilterredirect: string如何筛选重定向。
bllimit: int要返回的页面总数。
blredirect: bool如果链接页面是重定向，则也查找所有链接到该重定向的页面。

Response

object

用于获取所有链接到给定跨维基链接的页面的方法。

getIWBackLinks( iwbltitle,  iwblprefix = null,  iwblcontinue = null,  iwbllimit = null, array iwblprop = null) :

自	1.0

参数

iwbltitle: string要搜索的跨维基链接。必须与 iwblprefix 一起使用。
iwblprefix: string跨维基的前缀。
iwblcontinue: bool当有更多结果可用时，使用此参数继续。
iwbllimit: int要返回的页面总数。
iwblprop: array<string|int, mixed>|null要获取的属性。

Response

object

用于获取基本页面信息的方法。

getPageInfo(mixed||string|int titles, array inprop = null, array intoken = null,  incontinue = null) :

自	1.0

参数

titles: array<string|int, mixed>要检索信息的页面标题。
inprop: array<string|int, mixed>|null要获取的其他属性。
intoken: array<string|int, mixed>|null请求令牌以对页面执行数据修改操作
incontinue: bool当有更多结果可用时，使用此参数继续。

Response

object

用于获取页面内容中定义的各种属性的方法。

getPageProperties(mixed||string|int titles,  ppcontinue = null,  ppprop = null) :

自	1.0

参数

titles: array<string|int, mixed>要检索属性的页面标题。
ppcontinue: bool当有更多结果可用时，使用此参数继续。
ppprop: string要在页面上查找的页面属性。

Response

object

用于获取给定页面上的所有页面模板的方法。

getPageTemplates(mixed||string|int titles, array tlnamespace = null,  tllimit = null,  tlcontinue = null,  tltemplates = null,  tldir = null) :

自	1.0

参数

titles: array<string|int, mixed>要检索模板的页面标题。
tlnamespace: array<string|int, mixed>|null仅显示此命名空间中的模板。
tllimit: int要返回的模板数。
tlcontinue: bool当有更多结果可用时，使用此参数继续。
tltemplates: string仅列出这些模板。
tldir: string列出的方向。

Response

object

用于获取修订列表的方法。

getRevisions(mixed||string|int titles, array rvprop = null,  rvparse = null,  rvlimit = null) :

自	1.0

参数

titles: array<string|int, mixed>要检索修订的页面标题。
rvprop: array<string|int, mixed>|null每个修订要获取的属性。
rvparse: bool解析修订内容。
rvlimit: int限制要返回的修订数量。

Response

object

用于获取访问令牌的方法。

getToken( user,  intoken) :

自	1.0

参数

user: string要获取令牌的用户。
intoken: string令牌的类型。

Response

string

用于移动页面的方法。

movePageByID( fromid,  to,  reason = null,  movetalk = null,  movesubpages = null,  noredirect = null,  watchlist = null,  ignorewarnings = null) :

自	1.0

参数

fromid: int要移动的页面的页面 ID。
to: string要将页面重命名为的标题。
reason: string移动的原因（可选）。
movetalk: string移动讨论页面（如果存在）。
movesubpages: string移动子页面（如果适用）。
noredirect: bool不创建重定向。
watchlist: string无条件地将页面添加到或从您的监视列表中删除。
ignorewarnings: bool忽略任何警告。

Response

object

用于移动页面的方法。

movePageByName( from,  to,  reason = null,  movetalk = null,  movesubpages = null,  noredirect = null,  watchlist = null,  ignorewarnings = null) :

自	1.0

参数

from: string要移动的页面的标题。
to: string要将页面重命名为的标题。
reason: string移动的原因（可选）。
movetalk: string移动讨论页面（如果存在）。
movesubpages: string移动子页面（如果适用）。
noredirect: bool不创建重定向。
watchlist: string无条件地将页面添加到或从您的监视列表中删除。
ignorewarnings: bool忽略任何警告。

Response

object

用于撤消对页面的最后一次编辑的方法。

rollback( title,  user,  summary = null,  markbot = null,  watchlist = null) :

自	1.0

参数

title: string要回滚的页面的标题。
user: string要回滚其编辑的用户姓名。
summary: string自定义编辑摘要。如果未设置，将使用默认摘要。
markbot: string将已还原的编辑和还原标记为机器人编辑。
watchlist: string无条件地将页面添加到或从您的监视列表中删除。

Response

object

用于还原已删除页面的某些修订的方法。

undeletePage( title,  reason = null,  timestamp = null,  watchlist = null) :

自	1.0

参数

title: string要还原的页面的标题。
reason: string还原的原因（可选）。
timestamp: string要还原的修订的时间戳。
watchlist: string无条件地将页面添加到或从您的监视列表中删除。

Response

object

用于验证响应是否有错误的方法

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

继承

自	1.0
抛出	`DomainException`

参数

response: Response来自 mediawiki 服务器的响应。

Response

SimpleXMLElement

Mediawiki 对象的选项。

继承

自	1.0

类型

Registry

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

继承

自	1.0

类型

Http