Starring
扩展自 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
继承
check
检查您是否正在收藏仓库。
check( owner, repo) :
需要用户进行身份验证。
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 所有者
string仓库所有者。- 仓库
string仓库名称。
响应
布尔值
fetchUrl
构建并返回请求完整 URL 的方法。此方法将根据需要添加适当的分页详细信息，并将 API URL 添加到请求的开头，以获取请求的完整 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
继承
getList
列出 Stargazers。
getList( owner, repo) :
| 自 |
1.0 |
|---|
参数
- 所有者
string仓库所有者。- 仓库
string仓库名称。
响应
混合
getRepositories
列出正在收藏的仓库。
getRepositories( user = '', sort = 'created', direction = 'desc') :
列出用户正在收藏的仓库。
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
string用户名。- 排序
stringcreated（收藏仓库的时间）或updated（上次推送的时间）之一。- 方向
stringasc（升序）或desc（降序）之一。
响应
对象
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
继承
star
收藏仓库。
star( owner, repo) :
需要用户进行身份验证。
| 自 |
1.0 |
|---|
参数
- 所有者
string仓库所有者。- 仓库
string仓库名称。
响应
对象
unstar
取消收藏仓库。
unstar( owner, repo) :
需要用户进行身份验证。
| 自 |
1.0 |
|---|
参数
- 所有者
string仓库所有者。- 仓库
string仓库名称。
响应
对象
属性
包
对象所在的包
继承
| 自 |
1.0 |
|---|
类型
字符串
hookEvents
包含允许的挂钩事件的数组
继承
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| 注释 |
从 1.4.0 到 1.5.1，此名称为 $events，由于与包子类的命名冲突，因此已重命名 |
类型
array<string|int, mixed>