Joomla! API

下载
启动

Hooks

扩展 AbstractPackage

Joomla 框架的 GitHub API Hooks 类。

链接
自

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

create

创建一个钩子。

create( user,  repo,  name, mixed||string|int config, mixed||string|int events = ['push'],  active = true) :
自

1.0
抛出

DomainException

RuntimeException

参数

user

stringGitHub 存储库所有者的名称。

repo

stringGitHub 存储库的名称。

name

string正在调用的服务的名称。

config

array<string|int, mixed>包含服务配置的数组。

events

array<string|int, mixed>钩子将被触发的事件。

active

bool标志，用于确定钩子是否处于活动状态

响应

object

delete

删除一个钩子

delete( user,  repo,  id) :
自

1.0
抛出

DomainException

参数

user

stringGitHub 存储库所有者的名称。

repo

stringGitHub 存储库的名称。

id

int要删除的钩子的 ID。

响应

object

edit

编辑一个钩子。

edit( user,  repo,  id,  name, mixed||string|int config, mixed||string|int events = ['push'], mixed||string|int addEvents = [], mixed||string|int removeEvents = [],  active = true) :
自

1.0
抛出

DomainException

RuntimeException

参数

user

stringGitHub 存储库所有者的名称。

repo

stringGitHub 存储库的名称。

id

int要编辑的钩子的 ID。

name

string正在调用的服务的名称。

config

array<string|int, mixed>包含服务配置的数组。

events

array<string|int, mixed>钩子将被触发的事件。这将重置当前设置的列表

addEvents

array<string|int, mixed>要添加到钩子的事件。

removeEvents

array<string|int, mixed>要从钩子中删除的事件。

active

bool标志，用于确定钩子是否处于活动状态

响应

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( user,  repo,  id) :
自

1.0
抛出

DomainException

参数

user

stringGitHub 存储库所有者的名称。

repo

stringGitHub 存储库的名称。

id

int要检索的钩子的 ID

响应

object

getList

列出钩子。

getList( user,  repo) :
自

1.0
抛出

DomainException

参数

user

stringGitHub 存储库所有者的名称。

repo

stringGitHub 存储库的名称。

响应

object

ping

Ping 一个钩子。

ping( user,  repo,  id) :
自

1.4.0
抛出

DomainException

参数

user

stringGitHub 存储库所有者的名称。

repo

stringGitHub 存储库的名称。

id

int要 Ping 的钩子的 ID

响应

object

processResponse

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

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

1.0
抛出

UnexpectedResponseException

参数

response

Response响应。

expectedCode

int预期的“良好”代码。

响应

混合

test

测试一个 push 钩子。

test( user,  repo,  id) :
自

1.0
抛出

DomainException

参数

user

stringGitHub 存储库所有者的名称。

repo

stringGitHub 存储库的名称。

id

int要测试的钩子的 ID

响应

object

属性

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>
  • \ Joomla
  • \ Github
  • \ Package
  • \ Repositories
  • \ Hooks