Joomla! API

下载
启动

用户

扩展自 AbstractPackage

Joomla 框架的 GitHub API 参考类。

链接
自

1.0
属性只读 Emails

电子邮件的 GitHub API 对象。

关注者的 GitHub API 对象。

密钥的 GitHub API 对象。
包

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

edit

更新已认证的用户。

edit( name = '',  email = '',  blog = '',  company = '',  location = '',  hireable = '',  bio = '') :
自

1.0
抛出

DomainException

参数

名称

string完整姓名

电子邮件

string电子邮件

博客

string博客

公司

string公司

位置

string位置

可雇用

string如果他失业了 :P

生物信息

string生物特征 DNA 指纹（或其他东西...）

响应

混合

fetchUrl

用于构建和返回请求的完整 URL 的方法。此方法将添加适当的分页详细信息（如果需要），并将 API URL 添加到请求的完整 URL 中。

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

1.0

参数

路径

string要变形的 URL

页面

int要请求的页面

限制

int每页返回的结果数

响应

Uri

get

获取单个用户。

get( user) :
自

1.0
抛出

DomainException

参数

用户

string用户的登录名。

响应

对象

getAuthenticatedUser

获取已认证的用户。

getAuthenticatedUser() :
自

1.0
抛出

DomainException

响应

混合

getList

获取所有用户。

getList( since) :

这提供所有用户的转储，按他们在 GitHub 上注册的顺序排列。

自

1.0
抛出

DomainException

参数

自

int您看到的最后一个用户的整数 ID。

响应

对象

processResponse

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

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

1.0
抛出

UnexpectedResponseException

参数

响应

Response响应。

预期代码

int预期的“良好”代码。

响应

混合

属性

电子邮件

电子邮件的 GitHub API 对象。

类型

电子邮件

关注者

关注者的 GitHub API 对象。

类型

关注者

密钥

密钥的 GitHub API 对象。

类型

密钥

选项

GitHub 对象的选项。

继承
自

1.0

类型

注册表

客户端

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

继承
自

1.0

类型

Http

包

对象所在的包

继承
自

1.0

类型

string

hookEvents

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

继承
自

1.5.2
链接
注意

从 1.4.0 到 1.5.1，它被称为 $events，由于与包子类的命名冲突，它被重命名了

类型

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