里程碑
扩展自 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, title, state = null, description = null, dueOn = null) :
| 注意 |
从 2.0 开始，$dueOn 参数将被类型提示为 \DateTime 对象 |
|---|---|
| 自 |
1.0 |
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。- 标题
int里程碑的标题。- 状态
string可以是 open（默认）或 closed。- 描述
string里程碑的可选描述。- 截止日期
string里程碑截止日期。这是 ISO 8601 格式的时间戳。
响应
对象
delete
删除里程碑。
delete( user, repo, milestoneId) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。- 里程碑 ID
int要删除的里程碑的 ID。
响应
空
edit
更新里程碑。
edit( user, repo, milestoneId, title = null, state = null, description = null, dueOn = null) :
| 注意 |
从 2.0 开始，$dueOn 参数将被类型提示为 \DateTime 对象 |
|---|---|
| 自 |
1.0 |
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。- 里程碑 ID
int要更新的注释的 ID。- 标题
int里程碑的可选标题。- 状态
string可以是 open（默认）或 closed。- 描述
string里程碑的可选描述。- 截止日期
string里程碑截止日期。这是 ISO 8601 格式的时间戳。
响应
对象
fetchUrl
构建并返回请求的完整请求 URL 的方法。此方法将在必要时添加适当的分页详细信息，并将 API URL 添加到请求的开头，以获得完整的请求 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
get
获取单个里程碑。
get( user, repo, milestoneId) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。- 里程碑 ID
int要获取的里程碑 ID。
响应
对象
getList
列出存储库的里程碑。
getList( user, repo, state = 'open', sort = 'due_date', direction = 'desc', page, limit) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 存储库
stringGitHub 存储库的名称。- 状态
string要检索的里程碑状态。Open（默认）或 closed。- 排序
string排序可以是 due_date（默认）或 completeness。- 方向
string方向是 asc 或 desc（默认）。- 页码
int要从中获取项目的页码。- 限制
int每页的项目数。
响应
对象
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
属性
包
对象所在的包
| 自 |
1.0 |
|---|
类型(s)
字符串
hookEvents
包含允许的挂钩事件的数组
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| 注意 |
从 1.4.0 到 1.5.1，它被称为 $events，由于与包子类的命名冲突，它被重命名了 |
类型(s)
array<string|int, mixed>