评论
扩展自 AbstractPackageJoomla 框架的 GitHub API Pull 评论类。
| 链接 | |
|---|---|
| 自 |
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, pullId, body, commitId, filePath, position) :
| 自 |
1.0 |
|---|
参数
- user
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- pullId
int拉取请求编号。- body
string评论正文文本。- commitId
string要评论的提交的 SHA1 哈希值。- filePath
string要评论的文件的相对路径。- position
string要评论的差异中的行索引。
响应
object
createReply
用于在回复另一条评论时创建评论的方法。
createReply( user, repo, pullId, body, inReplyTo) :
| 自 |
1.0 |
|---|
参数
- user
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- pullId
int拉取请求编号。- body
string评论正文文本。- inReplyTo
int要回复的评论的 ID。
响应
object
delete
删除评论。
delete( user, repo, commentId) :
| 自 |
1.0 |
|---|
参数
- user
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- commentId
int要删除的评论的 ID。
响应
void
edit
编辑评论。
edit( user, repo, commentId, body) :
| 自 |
1.0 |
|---|
参数
- user
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- commentId
int要更新的评论的 ID。- body
string评论的新正文文本。
响应
object
fetchUrl
用于构建并返回请求的完整请求 URL 的方法。此方法将根据需要添加适当的分页详细信息，并将 API URL 添加到前面以获得请求的完整 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
get
获取单个评论。
get( user, repo, commentId) :
| 自 |
1.0 |
|---|
参数
- user
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- commentId
int要获取的评论 ID。
响应
object
getList
列出拉取请求上的评论。
getList( user, repo, pullId, page, limit) : mixed||string|int
| 自 |
1.0 |
|---|
参数
- user
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- pullId
int拉取请求编号。- page
int要从中获取项目的页码。- limit
int每页的项目数。
响应
array<string|int, mixed>
getListForRepo
列出存储库中的评论。
getListForRepo( user, repo, page, limit) : mixed||string|int
| 自 |
1.4.0 |
|---|
参数
- user
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- page
int要从中获取项目的页码。- limit
int每页的项目数。
响应
array<string|int, mixed>
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
属性
包
对象所在的包
| 自 |
1.0 |
|---|
类型
string
hookEvents
包含允许的钩子事件的数组
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| note |
从 1.4.0 到 1.5.1，该属性名为 $events，由于与包子类的命名冲突，因此将其重命名 |
类型
array<string|int, mixed>