Joomla! API

下载
启动

部署

扩展自 AbstractPackage

Joomla 框架的 GitHub API 部署类。

文档

https://developer.github.com/v3/repos/deployments
自

1.4.0
包

Joomla 框架

方法

__construct

构造函数。

__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
继承
自

1.0

参数

选项

Registry|nullGitHub 选项对象。

客户端

Http|nullHTTP 客户端对象。

响应

混合

__get

魔术方法，用于延迟创建 API 对象

__get( name) : \Joomla\Github\AbstractPackage
继承
自

1.0
抛出

InvalidArgumentException

参数

名称

string要检索的属性名称

响应

AbstractPackageGitHub API 包对象。

create

创建部署。

create( owner,  repo,  ref,  task = '',  autoMerge = true, array|null requiredContexts = null,  payload = '',  environment = '',  description = '') :
自

1.4.0
抛出

RuntimeException

参数

所有者

stringGitHub 存储库所有者的名称。

存储库

stringGitHub 存储库的名称。

引用

string要部署的引用。可以是分支、标签或 SHA。

任务

string可选参数，用于指定要执行的任务。

自动合并

bool可选参数，如果默认分支落后于请求的引用，则将其合并到请求的引用中。

必需上下文

array<string|int, mixed>|null可选的状态上下文数组，针对提交状态检查进行验证。如果从参数中省略此参数，则在创建部署之前将验证所有唯一上下文。要完全绕过检查，请传递一个空数组。默认为所有唯一上下文。

有效负载

string有关部署的额外信息的可选 JSON 有效负载。

环境

string目标部署环境的可选名称。

描述

string可选的简短描述。

响应

对象

createStatus

创建部署状态。

createStatus( owner,  repo,  id,  state,  targetUrl = '',  description = '') :
自

1.4.0
抛出

InvalidArgumentException

参数

所有者

stringGitHub 存储库所有者的名称。

存储库

stringGitHub 存储库的名称。

ID

int要从中列出状态的部署 ID。

状态

string状态的状态。

目标 URL

string与此状态关联的目标 URL。此 URL 应包含输出，以在任务运行时保持用户更新，或作为部署中发生情况的历史信息。

描述

string状态的简短描述。最大长度为 140 个字符。

响应

对象

fetchUrl

构建并返回请求的完整请求 URL 的方法。此方法将根据需要添加适当的分页详细信息，并将 API url 作为前缀，以获取请求的完整 URL。

fetchUrl( path,  page,  limit) : \Joomla\Uri\Uri
继承
自

1.0

参数

路径

string要变形的 URL

页面

int要请求的页面

限制

int每页返回的结果数

响应

Uri

getDeploymentStatuses

列出部署状态。

getDeploymentStatuses( owner,  repo,  id,  page,  limit) :
自

1.4.0

参数

所有者

stringGitHub 存储库所有者的名称。

存储库

stringGitHub 存储库的名称。

ID

int要从中列出状态的部署 ID。

页面

int要从中获取项目的页面编号。

限制

int页面上的项目数。

响应

对象

getList

列出部署。

getList( owner,  repo,  sha = '',  ref = '',  task = '',  environment = '',  page,  limit) :
自

1.4.0

参数

所有者

stringGitHub 存储库所有者的名称。

存储库

stringGitHub 存储库的名称。

sha

string在创建时间时记录的 SHA。

引用

string引用的名称。可以是分支、标签或 SHA。

任务

string部署的任务名称。

环境

string已部署到的环境的名称。

页面

int要从中获取项目的页面编号。

限制

int页面上的项目数。

响应

对象

processResponse

处理响应并对其进行解码。

processResponse(\Joomla\Http\Response response,  expectedCode = 200) :
继承
自

1.0
抛出

UnexpectedResponseException

参数

响应

Response响应。

预期代码

int预期的“良好”代码。

响应

混合

属性

选项

GitHub 对象的选项。

继承
自

1.0

类型

注册表

客户端

用于发送 HTTP 请求的 HTTP 客户端对象。

继承
自

1.0

类型

Http

包

对象所在的包

继承
自

1.0

类型

字符串

hookEvents

包含允许的挂钩事件的数组

继承
自

1.5.2
链接
注释

从 1.4.0 到 1.5.1，此名称为 $events，由于与包子类的命名冲突，因此已重命名

类型

array<string|int, mixed>
  • \ Joomla
  • \ Github
  • \ Package
  • \ Repositories
  • \ Deployments