提交
扩展自 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
compare
比较两个提交。
compare( user, repo, base, head) :
| 自 |
1.0 |
|---|
参数
- 用户
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。- 基础
string差异的基础，可以是提交 SHA 或分支。- 头部
string差异的头部，可以是提交 SHA 或分支。
响应
对象
fetchUrl
用于构建和返回请求完整 URL 的方法。此方法将根据需要添加适当的分页详细信息，并将 API URL 添加到请求的开头，以获得完整的请求 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
get
获取单个提交。
get( user, repo, sha) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。- sha
string要检索的提交的 SHA。
响应
对象
getList
列出存储库上的提交。
getList( user, repo, sha = '', path = '', author = '', \DateTimeInterface since = null, \DateTimeInterface until = null) :
关于分页的特别说明：由于 Git 的工作方式，提交是基于 SHA 而不是页码进行分页的。请按照分页概述中概述的链接标头操作，而不是自己构建页面链接。
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。- sha
string要开始列出提交的 Sha 或分支。- 路径
string仅返回包含此文件路径的提交。- 作者
string用于按提交作者筛选的 GitHub 登录名、名称或电子邮件。- 自
DateTimeInterface|nullISO 8601 日期 - 仅返回此日期之后的提交。- 直到
DateTimeInterface|nullISO 8601 日期 - 仅返回此日期之前的提交。
响应
对象
getSha
获取提交引用的 SHA-1。
getSha( user, repo, ref) :
| 自 |
1.4.0 |
|---|---|
| 抛出 |
参数
- 用户
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。- 引用
string提交引用
响应
字符串
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
属性
包
对象所在的包
| 自 |
1.0 |
|---|
类型(s)
字符串
hookEvents
包含允许的挂钩事件的数组
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| 注意 |
从 1.4.0 到 1.5.1，此名称为 $events，由于与包子类的命名冲突，因此将其重命名 |
类型(s)
array<string|int, mixed>