Refs
扩展自 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, ref, sha) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 引用
string完全限定引用的名称。- sha
string要将此引用设置为的 SHA1 值。
响应
对象
delete
删除引用
delete( owner, repo, ref) :
| 自 |
1.0 |
|---|
参数
- 所有者
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 引用
string要更新的引用。
响应
对象
edit
更新引用。
edit( user, repo, ref, sha, force = false) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 引用
string要更新的引用。- sha
string要将引用设置为的 SHA1 值。- 强制
bool是否强制更新。默认为 false。
响应
对象
fetchUrl
用于构建和返回请求的完整请求 URL 的方法。此方法将在必要时添加适当的分页详细信息，并将 API url 添加到请求中，以获得完整的请求 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
继承的
get
获取引用。
get( user, repo, ref) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 引用
string要获取的引用。
响应
对象
getList
获取所有引用。
getList( user, repo, namespace = '', page, limit) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 命名空间
string可选的子命名空间，用于限制返回的引用。- 页面
int要请求的页面- 限制
int每页返回的结果数
响应
对象
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
继承的
属性
包
对象所在的包
继承的
| 自 |
1.0 |
|---|
类型
string
hookEvents
包含允许的钩子事件的数组
继承的
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| 备注 |
从 1.4.0 到 1.5.1，它被称为 $events，由于与包子类的命名冲突，它被重命名了 |
类型
array<string|int, mixed>