Joomla! API

下载
启动

Orgs

扩展自 AbstractPackage

Joomla 框架的 GitHub API 活动类。

自

1.0
文档

http://developer.github.com/v3/orgs/
只读属性 Hooks

用于钩子的 GitHub API 对象。

用于成员的 GitHub API 对象。

用于团队的 GitHub API 对象。
包

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

edit

编辑组织。

edit( org,  billingEmail = '',  company = '',  email = '',  location = '',  name = '') :
自

1.0

参数

org

string组织名称。

billingEmail

string账单电子邮件地址。此地址不会公开。

company

string公司名称。

email

string电子邮件地址。

location

string位置名称。

name

string名称。

响应

object

fetchUrl

用于构建并返回请求的完整请求 URL 的方法。如果需要，此方法会添加适当的分页详细信息，并还会在 API URL 前面加上请求的完整 URL。

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

1.0

参数

path

string要变形的 URL

page

int要请求的页面

limit

int每页要返回的结果数

响应

Uri

get

获取组织。

get( org) :
自

1.0

参数

org

string组织名称。

响应

object

getList

列出用户组织。

getList( user = '') :

如果给出用户名，将列出经过身份验证用户的公共和私有组织。

自

1.0

参数

user

string用户名。

响应

object

processResponse

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

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

1.0
抛出

UnexpectedResponseException

参数

response

Response响应。

expectedCode

int预期“良好”代码。

响应

混合

属性

hooks

用于钩子的 GitHub API 对象。

类型

Hooks

members

用于成员的 GitHub API 对象。

类型

Members

teams

用于团队的 GitHub API 对象。

类型

Teams

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
  • \ Orgs