Commits

扩展 AbstractPackage

Joomla 框架的 GitHub API 数据提交类。

link
since

1.0

package

Joomla 框架

方法

__construct

构造函数。

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

1.0

参数

options

Registry|nullGitHub 选项对象。

client

Http|nullHTTP 客户端对象。

响应

mixed

__get

懒加载创建 API 对象的魔术方法

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

1.0

抛出

InvalidArgumentException

参数

name

string要检索的属性的名称

响应

AbstractPackageGitHub API 包对象。

create

创建提交。

create( owner,  repo,  message,  tree, mixed||string|int parents = []) : 
since

1.0

参数

owner

stringGitHub 仓库所有者的名称。

repo

stringGitHub 仓库的名称。

message

string提交消息。

tree

string此提交指向的树对象的 SHA。

parents

array<string|int, mixed>此提交父级提交的 SHA 数组。如果省略或为空,则提交将被写入为根提交。对于单个父级,应提供一个 SHA 数组。对于合并提交,应提供多个 SHA 数组。

响应

object

fetchUrl

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

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

1.0

参数

path

string要变形的 URL

page

int要请求的页码

limit

int每页返回的结果数量

响应

Uri

get

获取提交。

get( owner,  repo,  sha) : 

参数

owner

stringGitHub 仓库所有者的名称。

repo

stringGitHub 仓库的名称。

sha

string提交 SHA。

响应

object

processResponse

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

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

1.0

抛出

UnexpectedResponseException

参数

response

Response响应。

expectedCode

int预期的“良好”代码。

响应

mixed

属性

options

GitHub 对象的选项。

继承
since

1.0

类型

Registry

client

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

继承
since

1.0

类型

Http

package

对象所在的包

继承
since

1.0

类型

string

hookEvents

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

继承
since

1.5.2

link
note

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

类型

array<string|int, mixed>