Joomla! API

下载
启动

Meta

扩展自 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

getMeta

获取服务的授权 IP 地址的方法

getMeta() : mixed||string|int
自

1.0

响应

array<string|int, mixed>以 CIDR 格式表示的授权 IP 地址

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
link
note

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

类型

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