Followers

扩展 AbstractPackage

Joomla 框架的 GitHub API Followers 类。

链接

1.0

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

check

检查您是否正在关注用户。

check( user) : 

1.0

抛出

UnexpectedValueException

参数

用户

string用户名。

响应

布尔值

checkUserFollowing

检查一个用户是否关注另一个用户。

checkUserFollowing( user,  target) : 

1.4.0

抛出

UnexpectedValueException

参数

用户

string用户名。

目标

string要检查是否正在被关注的用户名。

响应

布尔值

fetchUrl

用于构建并返回请求的完整请求 URL 的方法。此方法将在必要时添加适当的分页详细信息,并也添加 API url 前缀,以使请求具有完整的 URL。

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

1.0

参数

路径

string要变形的 URL

页面

int要请求的页面

限制

int每页返回的结果数

响应

URI

follow

关注用户。

follow( user) : 

关注用户需要用户使用基本身份验证或带有 user:follow 范围的 OAuth 登录并经过身份验证。

1.0

参数

用户

string用户名。

响应

对象

getList

列出用户的关注者。

getList( user = '') : 

1.0

参数

用户

string用户名。如果未设置,将使用当前经过身份验证的用户。

响应

对象

getListFollowedBy

列出另一个用户关注的用户。

getListFollowedBy( user = '') : 

1.0

参数

用户

string用户名。如果未设置,将使用当前经过身份验证的用户。

响应

对象

processResponse

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

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

1.0

抛出

UnexpectedResponseException

参数

响应

Response响应。

预期代码

int预期的“良好”代码。

响应

混合

unfollow

取消关注用户。

unfollow( user) : 

取消关注用户需要用户使用基本身份验证或带有 user:follow 范围的 OAuth 登录并经过身份验证。

1.0

参数

用户

string用户名。

响应

对象

属性

选项

GitHub 对象的选项。

继承

1.0

类型

注册表

客户端

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

继承

1.0

类型

Http

对象所在的包

继承

1.0

类型

字符串

hookEvents

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

继承

1.5.2

链接
注意

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

类型

array<string|int, mixed>