Joomla! API

下载
启动

分支

扩展自 AbstractPackage

Joomla 框架的 GitHub API 分支类。

链接
自

1.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,  org = '') :
自

1.0
抛出

DomainException

参数

所有者

stringGitHub 存储库的所有者名称。

存储库

stringGitHub 存储库的名称。

组织

string将存储库分支到的组织。默认情况下，它被分支到当前用户。

响应

对象

fetchUrl

构建并返回请求的完整请求 URL 的方法。此方法将根据需要添加适当的分页详细信息，并将 API URL 添加到请求的开头，以获得请求的完整 URL。

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

1.0

参数

路径

string要变形的 URL

页面

int要请求的页面

限制

int每页返回的结果数

响应

Uri

getList

列出分支。

getList( owner,  repo,  page,  limit) : mixed||string|int
自

1.0
抛出

DomainException

参数

所有者

stringGitHub 存储库的所有者名称。

存储库

stringGitHub 存储库的名称。

页面

int要请求的页面

限制

int每页返回的结果数

响应

array<string|int, mixed>

processResponse

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

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

1.0
抛出

UnexpectedResponseException

参数

响应

Response响应。

预期代码

int预期的“良好”代码。

响应

混合

属性

选项

GitHub 对象的选项。

继承
自

1.0

类型(s)

注册表

客户端

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

继承
自

1.0

类型(s)

Http

包

对象所在的包

继承
自

1.0

类型(s)

字符串

hookEvents

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

继承
自

1.5.2
链接
注意

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

类型(s)

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