Pulls
扩展 AbstractPackageJoomla 框架的 GitHub API 拉取请求类。
| 链接 | |
|---|---|
| 自 |
1.0 |
| 属性读取 Comments |
用于评论的 GitHub API 对象。 |
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
用于延迟创建 API 对象的魔术方法
__get( name) : \Joomla\Github\AbstractPackage
create
创建拉取请求。
create( user, repo, title, base, head, body = '') :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 标题
string新拉取请求的标题。- 基础
string您希望将更改拉入的分支（或 Git 引用）。这应该是当前存储库上的现有分支。您无法提交一个拉取请求到一个存储库，请求合并到另一个存储库的基础。- 头部
string实现更改的分支（或 Git 引用）。- 正文
string新拉取请求的正文文本。
响应
对象
createFromIssue
从现有问题创建拉取请求的方法。
createFromIssue( user, repo, issueId, base, head) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 问题 ID
int要附加新拉取请求的问题编号。- 基础
string您希望将更改拉入的分支（或 Git 引用）。这应该是当前存储库上的现有分支。您无法提交一个拉取请求到一个存储库，请求合并到另一个存储库的基础。- 头部
string实现更改的分支（或 Git 引用）。
响应
对象
edit
更新拉取请求。
edit( user, repo, pullId, title = null, body = null, state = null, base = null) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 拉取请求 ID
int拉取请求编号。- 标题
string拉取请求的可选新标题。- 正文
string拉取请求的可选新正文文本。- 状态
string拉取请求的可选新状态。[open, closed]- 基础
string拉取请求的可选新基础分支。
响应
对象
fetchUrl
用于构建和返回请求的完整请求 URL 的方法。如果需要，此方法将添加适当的分页详细信息，并将 API URL 前缀到完整的请求 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
get
获取单个拉取请求。
get( user, repo, pullId) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 拉取请求 ID
int拉取请求编号。
响应
对象
getCommits
列出拉取请求上的提交。
getCommits( user, repo, pullId, page, limit) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 拉取请求 ID
int拉取请求编号。- 页面
int要获取项目的页码。- 限制
int一页上的项目数量。
响应
对象
getFiles
列出拉取请求文件。
getFiles( user, repo, pullId, page, limit) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 拉取请求 ID
int拉取请求编号。- 页面
int要获取项目的页码。- 限制
int一页上的项目数量。
响应
对象
getList
列出拉取请求。
getList( user, repo, state = 'open', page, limit) : mixed||string|int
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 状态
string要按其过滤请求的可选状态。[open, closed]- 页面
int要获取项目的页码。- 限制
int一页上的项目数量。
响应
array<string|int, mixed>
isMerged
获取拉取请求是否已合并。
isMerged( user, repo, pullId) :
| 自 |
1.0 |
|---|---|
| 抛出 |
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 拉取请求 ID
int拉取请求编号。拉取请求编号。
响应
bool如果拉取请求已合并，则为 True
merge
合并拉取请求（合并按钮）。
merge( user, repo, pullId, message = '') :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 拉取请求 ID
int拉取请求编号。- 消息
string将用于合并提交的消息。
响应
对象
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>