Merging

扩展 AbstractPackage

Joomla 框架的 GitHub API 存储库合并类。

链接
自从

1.0

Joomla 框架

方法

__construct

构造函数。

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

1.0

参数

options

Registry|nullGitHub 选项对象。

client

Http|nullHTTP 客户端对象。

响应

混合

__get

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

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

1.0

抛出

InvalidArgumentException

参数

name

string要检索的属性名称

响应

AbstractPackageGitHub API 包对象。

fetchUrl

用于构建和返回请求的完整请求 URL 的方法。此方法将在必要时添加适当的分页详细信息,并将 API URL 添加到前面以获得请求的完整 URL。

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

1.0

参数

path

string要变形的 URL

page

int要请求的页面

limit

int每页返回的结果数量

响应

Uri

perform

执行合并。

perform( owner,  repo,  base,  head,  commitMessage = '') : 
自从

1.0

抛出

UnexpectedValueException

参数

owner

stringGitHub 存储库所有者的名称。

repo

stringGitHub 存储库的名称。

base

string将要合并 HEAD 的基础分支的名称。

head

string要合并的 HEAD。这可以是分支名称或提交 SHA1。

commitMessage

string要用于合并提交的提交消息。如果省略,将使用默认消息。

响应

bool

processResponse

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

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

1.0

抛出

UnexpectedResponseException

参数

response

Response响应。

expectedCode

int预期的“良好”代码。

响应

混合

属性

options

GitHub 对象的选项。

继承
自从

1.0

类型

Registry

client

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

继承
自从

1.0

类型

Http

对象所在的包

继承
自从

1.0

类型

string

hookEvents

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

继承
自从

1.5.2

链接
note

从 1.4.0 到 1.5.1,它被称为 $events,由于与包子类的命名冲突,它被重命名了

类型

array<string|int, mixed>