Search

扩展自 AbstractPackage

Joomla 框架的 GitHub API 搜索类。

link
since

1.0

package

Joomla 框架

方法

__construct

构造函数。

__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) : 
继承
since

1.0

参数

options

Registry|nullGitHub 选项对象。

client

Http|nullHTTP 客户端对象。

响应

混合类型

__get

延迟创建 API 对象的魔术方法

__get( name) : \Joomla\Github\AbstractPackage
继承
since

1.0

抛出

InvalidArgumentException

参数

name

string要检索的属性名称

响应

AbstractPackageGitHub API 包对象。

email

电子邮件搜索。

email( email) : 
已弃用

仅出于兼容性原因添加此 API 调用。无法保证始终可以使用完整的电子邮件搜索。地址中的 @ 字符必须保持未编码状态。仅针对公共电子邮件地址(在用户的 GitHub 个人资料中配置)进行搜索。

since

1.0

已弃用

旧版 API 已弃用

参数

email

string电子邮件地址。

响应

对象

fetchUrl

构建并返回请求的完整请求 URL 的方法。此方法将在必要时添加适当的分页详细信息,并将 API URL 作为前缀以获得请求的完整 URL。

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

1.0

参数

path

string要添加前缀的 URL

page

int要请求的页码

limit

int每页返回的结果数

响应

Uri

issues

搜索问题。

issues( owner,  repo,  state,  keyword) : 
已弃用
since

1.0

抛出

UnexpectedValueException

已弃用

旧版 API 已弃用

参数

owner

string存储库所有者的名称。

repo

string存储库的名称。

state

string状态 - 打开或关闭。

keyword

string搜索词。

响应

对象

processResponse

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

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

1.0

抛出

UnexpectedResponseException

参数

response

Response响应。

expectedCode

int预期的“正常”代码。

响应

混合类型

repositories

搜索存储库。

repositories( keyword,  language = '',  startPage) : 
已弃用

按关键词查找存储库。请注意,此旧版方法不遵循 v3 分页模式。此方法最多返回每页 100 个结果,并且可以使用 start_page 参数获取页面。

since

1.0

已弃用

旧版 API 已弃用

参数

keyword

string搜索词。

language

string按语言过滤结果 https://github.com/languages

startPage

int要获取的页码

响应

对象

users

搜索用户。

users( keyword,  startPage) : 
已弃用

按关键词查找用户。

since

1.0

已弃用

旧版 API 已弃用

参数

keyword

string搜索词。

startPage

int要获取的页码

响应

对象

属性

options

GitHub 对象的选项。

继承
since

1.0

类型

Registry

client

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

继承
since

1.0

类型

Http

package

对象所在的包

继承
since

1.0

类型

string

hookEvents

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

继承
since

1.5.2

link
注意

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

类型

array<string|int, mixed>