Categories
扩展自 AbstractMediawikiObjectMediaWiki API 分类类。
| 自 |
1.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Mediawiki\Http client = null) :
buildParameter
用于从字符串数组构建请求参数的方法。
buildParameter(mixed||string|int params) :
| 自 |
1.0 |
|---|
参数
- params
array<string|int, mixed>包含参数的字符串数组
Response
string请求参数
enumerateCategories
枚举所有分类的方法。
enumerateCategories( acfrom = null, acto = null, acprefix = null, acdir = null, acmin = null, acmax = null, aclimit = null, array acprop = null) :
| 自 |
1.0 |
|---|
参数
- acfrom
string开始枚举的分类。- acto
string停止枚举的分类。- acprefix
string搜索所有以该值为开头的分类标题。- acdir
string排序方向。- acmin
int分类成员的最小数量。- acmax
int分类成员的最大数量。- aclimit
int要返回的分类数量。- acprop
array<string|int, mixed>|null要获取的属性。
Response
object
fetchUrl
用于为请求构建并返回完整请求 URL 的方法。
fetchUrl( path) :
| 自 |
1.0 |
|---|
参数
- path
string要影响的 URL
Response
string请求 URL。
getCategories
列出页面所属的所有分类的方法。
getCategories(mixed||string|int titles, array clprop = null, array clshow = null, int cllimit = null, clcontinue = false, array clcategories = null, string cldir = null) :
| 自 |
1.0 |
|---|
参数
- titles
array<string|int, mixed>要检索分类的页面标题。- clprop
array<string|int, mixed>|null要获取的其他属性列表。- clshow
array<string|int, mixed>|null要显示的分类类型。- cllimit
int|null要返回的分类数量。- clcontinue
bool当有更多结果可用时继续。- clcategories
array<string|int, mixed>|null仅列出这些分类。- cldir
string|null列表方向。
Response
object
getCategoriesInfo
获取给定分类信息的方法。
getCategoriesInfo(mixed||string|int titles, clcontinue = false) :
| 自 |
1.0 |
|---|
参数
- titles
array<string|int, mixed>要检索分类的页面标题。- clcontinue
bool当有更多结果可用时继续。
Response
object
getCategoriesUsed
获取所有已用分类信息的方法。
getCategoriesUsed(mixed||string|int titles) :
| 自 |
1.0 |
|---|
参数
- titles
array<string|int, mixed>要检索分类的页面标题。
Response
object
getCategoryMembers
获取分类中页面信息的方法
getCategoryMembers( cmtitle = null, cmpageid = null, cmlimit = null, array cmprop = null, array cmnamespace = null, array cmtype = null, cmstart = null, cmend = null, cmstartsortkey = null, cmendsortkey = null, cmstartsortkeyprefix = null, cmendsortkeyprefix = null, cmsort = null, cmdir = null, cmcontinue = null) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- cmtitle
string分类标题，必须包含“Category:”前缀，不能与 $cmpageid 同时使用- cmpageid
string分类的页面 ID，不能与 $cmtitle 同时使用- cmlimit
string要检索的页面最大数量- cmprop
array<string|int, mixed>|null要检索的属性数组- cmnamespace
array<string|int, mixed>|null要从中检索页面的命名空间- cmtype
array<string|int, mixed>|null要包含的分类成员数组，如果 $cmsort 设置为“timestamp”，则忽略- cmstart
string开始列出的时间戳，仅当 $cmsort 设置为“timestamp”时使用- cmend
string结束列出的时间戳，仅当 $cmsort 设置为“timestamp”时使用- cmstartsortkey
string开始列出的十六进制键，仅当 $cmsort 设置为“sortkey”时使用- cmendsortkey
string结束列出的十六进制键，仅当 $cmsort 设置为“sortkey”时使用- cmstartsortkeyprefix
string开始列出的十六进制键前缀，仅当 $cmsort 设置为“sortkey”时使用，覆盖 $cmstartsortkey- cmendsortkeyprefix
string结束列出之前的十六进制键前缀，仅当 $cmsort 设置为“sortkey”时使用，覆盖 $cmendsortkey- cmsort
string要排序的属性- cmdir
string排序方向- cmcontinue
string用于继续先前的请求
Response
object
getChangeTags
列出更改标签的方法。
getChangeTags(array tgprop = null, tglimit = null) :
| 自 |
1.0 |
|---|
参数
- tgprop
array<string|int, mixed>|null要获取的属性列表。- tglimit
string要限制的标签的最大数量。
Response
object
validateResponse
验证响应是否存在错误的方法
validateResponse(\Joomla\Http\Response response) : \SimpleXMLElement