Comments
扩展自 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, sha, comment, line, filepath, position) :
| 自 |
1.0 |
|---|
参数
- user
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- sha
string要评论的提交的 SHA。- comment
string评论的文本。- line
int要评论的提交的行号。- filepath
string提交内要评论的文件的相对路径。- position
int要评论的 diff 中的行索引。
响应
object
delete
删除提交评论。
delete( user, repo, id) :
| 自 |
1.0 |
|---|
参数
- user
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- id
string要编辑的评论的 ID。
响应
object
edit
更新提交评论。
edit( user, repo, id, comment) :
| 自 |
1.0 |
|---|
参数
- user
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- id
string要编辑的评论的 ID。- comment
string评论的文本。
响应
object
fetchUrl
用于构建并返回请求的完整请求 URL 的方法。此方法将根据需要添加适当的分页详细信息，并将 API URL 添加到请求的完整 URL 中。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
get
获取单个提交评论。
get( user, repo, id) : mixed||string|int
| 自 |
1.0 |
|---|
参数
- user
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- id
int要检索的评论的 ID
响应
array<string|int, mixed>
getList
列出单个提交的评论。
getList( user, repo, sha, page, limit) : mixed||string|int
| 自 |
1.0 |
|---|
参数
- user
stringGitHub 存储库所有者的名称。- repo
stringGitHub 存储库的名称。- sha
string要检索的提交的 SHA。- page
int要请求的页码- limit
int每页返回的结果数
响应
array<string|int, mixed>
getListRepository
列出存储库的提交评论。
getListRepository( user, repo, page, limit) : mixed||string|int
| 自 |
1.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>