Keys

扩展自 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 包对象。

create

创建公钥

create( title,  key) : 

1.0

参数

title

string密钥的标题。

key

string密钥。

响应

对象

delete

删除公钥。

delete( id) : 

1.0

参数

id

int密钥的 ID。

响应

对象

edit

更新公钥。

edit( id,  title,  key) : 

1.0

参数

id

int密钥的 ID。

title

string密钥的标题。

key

string密钥。

响应

对象

fetchUrl

构建并返回请求完整 URL 的方法。如果需要,此方法会添加适当的分页详细信息,并添加 API URL 前缀以获取请求的完整 URL。

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

1.0

参数

path

string要变形的 URL

page

int要请求的页码

limit

int每页返回的结果数

响应

Uri

get

获取单个公钥。

get( id) : 

1.0

参数

id

int密钥的 ID。

响应

对象

getList

列出你的公钥。

getList() : 

列出当前用户的密钥。通过 API 管理公钥需要您通过基本身份验证或 OAuth 以及“用户”范围进行身份验证。

1.0

响应

对象

getListUser

列出用户的公钥。

getListUser( user) : 

列出用户的已验证公钥。任何人都可以访问此信息。

1.0

参数

user

string用户的名称。

响应

对象

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

链接
注意

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

类型

array<string|int, mixed>