评论
扩展 AbstractPackageJoomla 框架的 GitHub API Gists 评论类。
| 链接 | |
|---|---|
| 自 |
1.0 |
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
继承
__get
延迟创建 API 对象的魔术方法
__get( name) : \Joomla\Github\AbstractPackage
继承
create
创建评论。
create( gistId, body) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- gistId
intGist 编号。- body
string评论正文文本。
响应
object
delete
删除评论。
delete( commentId) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- commentId
int要删除的评论的 ID。
响应
void
edit
编辑评论。
edit( commentId, body) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- commentId
int要更新的评论的 ID。- body
string评论的新正文文本。
响应
object
fetchUrl
用于构建和返回请求完整 URL 的方法。此方法将在必要时添加适当的分页详细信息，并将 API URL 添加到请求的完整 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
继承
get
获取单个评论。
get( commentId) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- commentId
int要获取的评论 ID。
响应
object
getList
列出 Gist 上的评论。
getList( gistId, page, limit) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- gistId
intGist 编号。- page
int要从中获取项目的页面编号。- limit
int每页的项目数量。
响应
object
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>