评论
扩展 AbstractPackageJoomla 框架的 GitHub API 评论类。
问题评论 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, issueId, body) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 回购
stringGitHub 存储库的名称。- issueId
int问题编号。- 主体
string评论正文文本。
响应
对象
delete
删除评论。
delete( user, repo, commentId) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 回购
stringGitHub 存储库的名称。- commentId
int要删除的评论的 ID。
响应
布尔值
edit
编辑评论。
edit( user, repo, commentId, body) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 回购
stringGitHub 存储库的名称。- commentId
int要更新的评论的 ID。- 主体
string评论的新正文文本。
响应
对象
fetchUrl
用于构建并返回请求的完整请求 URL 的方法。此方法将在必要时添加适当的分页详细信息，并将 API URL 添加到请求中，以形成完整的请求 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
get
获取单个评论。
get( owner, repo, id) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 所有者
stringGitHub 存储库所有者的名称。- 回购
stringGitHub 存储库的名称。- ID
int评论 ID。
响应
对象
getList
列出问题上的评论。
getList( owner, repo, issueId, page, limit, \DateTimeInterface since = null) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 所有者
stringGitHub 存储库所有者的名称。- 回购
stringGitHub 存储库的名称。- issueId
int问题编号。- 页
int要从中获取项目的页码。- 限制
int一页上的项目数量。- 自
DateTimeInterface|null仅返回在该时间或之后更新的评论。
响应
对象
getRepositoryList
列出存储库中的评论。
getRepositoryList( owner, repo, sort = 'created', direction = 'asc', \DateTimeInterface since = null) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 所有者
stringGitHub 存储库所有者的名称。- 回购
stringGitHub 存储库的名称。- 排序
string排序字段 - 创建或更新。- 方向
string排序顺序 - 升序或降序。在没有排序参数的情况下忽略。- 自
DateTimeInterface|null仅返回在该时间或之后更新的评论。
响应
对象
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
属性
包
对象所在的包
| 自 |
1.0 |
|---|
类型
字符串
hookEvents
包含允许的挂钩事件的数组
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| 笔记 |
从 1.4.0 到 1.5.1，此名称为 $events，由于与包子类命名冲突，因此将其重命名 |
类型
array<string|int, mixed>