Keys

扩展自 AbstractPackage

Joomla 框架的 GitHub API Forks 类。

链接

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,  title,  key) : 

1.0

参数

所有者

stringGitHub 仓库所有者的名称。

仓库

stringGitHub 仓库的名称。

标题

string密钥标题。

密钥

string密钥。

响应

对象

delete

删除部署密钥。

delete( owner,  repo,  id) : 

1.0

参数

所有者

stringGitHub 仓库所有者的名称。

仓库

stringGitHub 仓库的名称。

ID

int密钥的 ID。

响应

布尔值

edit

编辑部署密钥。

edit( owner,  repo,  id,  title,  key) : 

1.0

参数

所有者

stringGitHub 仓库所有者的名称。

仓库

stringGitHub 仓库的名称。

ID

int密钥的 ID。

标题

string密钥标题。

密钥

string密钥。

响应

对象

fetchUrl

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

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

1.0

参数

路径

string要变形的 URL

页面

int要请求的页面

限制

int每页返回的结果数

响应

Uri

get

获取部署密钥。

get( owner,  repo,  id) : 

1.0

参数

所有者

stringGitHub 仓库所有者的名称。

仓库

stringGitHub 仓库的名称。

ID

int密钥的 ID。

响应

对象

getList

列出部署密钥。

getList( owner,  repo) : 

1.0

参数

所有者

stringGitHub 仓库所有者的名称。

仓库

stringGitHub 仓库的名称。

响应

对象

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>