Statuses
扩展 AbstractPackageJoomla 框架的 GitHub API 参考类。
| 链接 | |
|---|---|
| 自 |
1.0 |
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
继承
__get
延迟创建 API 对象的魔术方法
__get( name) : \Joomla\Github\AbstractPackage
继承
create
创建状态。
create( user, repo, sha, state, targetUrl = null, description = null, context = null) :
| 抛出 |
|
|---|---|
| 自 |
1.0 |
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- sha
string要设置状态的 SHA1 值。- 状态
string状态（pending、success、error 或 failure）。- 目标 URL
string可选目标 URL。- 描述
string状态的可选描述。- 上下文
string一个字符串标签，用于区分此状态与其他系统的状态。默认值：“default”
响应
对象
fetchUrl
用于构建并返回请求的完整请求 URL 的方法。此方法将根据需要添加适当的分页详细信息，并将 API URL 添加到请求的完整 URL 前。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
继承
getCombinedStatus
获取特定 Ref 的组合状态。
getCombinedStatus( user, repo, sha) : mixed||string|int
| 自 |
1.4.0 |
|---|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- sha
string要获取组合状态的 SHA1。
响应
array<string|int, mixed>
getList
列出特定 Ref 的状态。
getList( user, repo, sha) : mixed||string|int
| 自 |
1.0 |
|---|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- sha
string要获取状态的 SHA1。
响应
array<string|int, mixed>
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
继承
属性
包
对象所在的包
继承
| 自 |
1.0 |
|---|
类型
string
挂钩事件
包含允许的挂钩事件的数组
继承
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| 注意 |
从 1.4.0 到 1.5.1，它被命名为 $events，由于与包子类的命名冲突，它被重命名了 |
类型
array<string|int, mixed>