协作者
扩展自 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
继承
add
添加用户作为协作者。
add( owner, repo, user) :
| 自 |
1.0 |
|---|
参数
- 所有者
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。- 用户
stringGitHub 用户的名称。
响应
对象
fetchUrl
构建并返回请求完整 URL 的方法。此方法将在必要时添加适当的分页详细信息，并将 API URL 添加到请求的完整 URL 前缀。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
继承
get
检查用户是否为协作者。
get( owner, repo, user) :
| 抛出 |
|
|---|---|
| 自 |
1.0 |
参数
- 所有者
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。- 用户
stringGitHub 用户的名称。
响应
布尔值
getList
列出协作者。
getList( owner, repo) :
当以组织所有者的身份对组织拥有的存储库进行身份验证时，所有组织所有者都包含在协作者列表中。否则，仅在协作者列表中返回有权访问存储库的用户。
| 自 |
1.0 |
|---|
参数
- 所有者
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。
响应
对象
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
继承
remove
删除用户作为协作者。
remove( owner, repo, user) :
| 自 |
1.0 |
|---|
参数
- 所有者
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。- 用户
stringGitHub 用户的名称。
响应
对象
属性
包
对象所在的包
继承
| 自 |
1.0 |
|---|
类型(s)
字符串
hookEvents
包含允许的挂钩事件的数组
继承
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| 注释 |
从 1.4.0 到 1.5.1，此名称为 $events，由于与包子类的命名冲突，因此将其重命名 |
类型(s)
array<string|int, mixed>