活动

继承自 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

getByUser

列出用户执行的事件。

getByUser( user) : 

如果您以给定用户的身份进行身份验证,您将看到您的私人事件。否则,您只会看到公开事件。

1.0

参数

user

string用户名。

响应

object

getByUserPublic

列出用户执行的公开事件。

getByUserPublic( user) : 

1.0

参数

user

string用户名。

响应

object

getIssue

列出存储库的事件问题。

getIssue( owner,  repo) : 

1.0

参数

owner

string存储库所有者。

repo

string存储库名称。

响应

object

getNetwork

列出存储库网络的公开事件。

getNetwork( owner,  repo) : 

1.0

参数

owner

string存储库所有者。

repo

string存储库名称。

响应

object

getOrg

列出组织的公开事件。

getOrg( org) : 

1.0

参数

org

string组织。

响应

object

getPublic

列出公开事件。

getPublic() : 

1.0

响应

object

getRepository

列出存储库事件。

getRepository( owner,  repo) : 

1.0

参数

owner

string存储库所有者。

repo

string存储库名称。

响应

object

getUser

列出用户收到的事件。

getUser( user) : 

这些是您通过关注存储库和关注用户收到的事件。如果您以给定用户的身份进行身份验证,您将看到私人事件。否则,您只会看到公开事件。

1.0

参数

user

string用户名。

响应

object

getUserOrg

列出组织的事件。

getUserOrg( user,  org) : 

这是用户的组织仪表板。您必须以用户的身份进行身份验证才能查看此内容。

1.0

参数

user

string用户名。

org

string组织。

响应

object

getUserPublic

列出用户收到的公开事件。

getUserPublic( user) : 

1.0

参数

user

string用户名。

响应

object

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

链接
note

从 1.4.0 到 1.5.1,它名为 $events,由于与包子类的命名冲突而被重命名。

类型

array<string|int, mixed>