Hooks

Extends AbstractPackage

GitHub API Orgs Hooks class for the Joomla Framework.

All actions against organization webhooks require the authenticated user to be an admin of the organization being managed. Additionally, OAuth tokens require the "admin:org_hook" scope.

link
since

1.4.0

package

Joomla Framework

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) : mixed
inherited
since

1.0

Arguments

options

\Joomla\Registry\RegistryGitHub options object.

client

\Joomla\Http\HttpThe HTTP client object.

Response

mixed

__get

Magic method to lazily create API objects

__get(string name) : \Joomla\Github\AbstractPackage
inherited
since

1.0

throws

\InvalidArgumentException

Arguments

name

stringName of property to retrieve

Response

\Joomla\Github\AbstractPackageGitHub API package object.

create

Create a hook.

create(string org, string url, string contentType = 'form', string secret = null, bool insecureSsl = false, array events = ['push'], bool active = true) : object
since

1.4.0

throws

\UnexpectedValueException

Arguments

org

stringThe name of the organization.

url

stringThe URL to which the payloads will be delivered.

contentType

stringThe media type used to serialize the payloads. Supported values include "json" and "form".

secret

stringIf provided, payloads will be delivered with an X-Hub-Signature header. The value of this header is computed as the [HMAC hex digest of the body, using the secret as the key][hub-signature].

insecureSsl

boolDetermines whether the SSL certificate of the host for url will be verified when delivering payloads. If false, verification is performed. If true, verification is not performed.

events

arrayDetermines what events the hook is triggered for.

active

boolDetermines whether the hook is actually triggered on pushes.

Response

object

delete

Delete a hook.

delete(string org, int id) : object
since

1.4.0

Arguments

org

stringThe name of the organization

id

intID of the hook to delete

Response

object

edit

Edit a hook.

edit(string org, string url, string contentType = null, string secret = null, bool insecureSsl = null, array events = [], bool active = null) : object
since

1.4.0

throws

\UnexpectedValueException

Arguments

org

stringThe name of the organization.

url

stringThe URL to which the payloads will be delivered.

contentType

stringThe media type used to serialize the payloads. Supported values include "json" and "form".

secret

stringIf provided, payloads will be delivered with an X-Hub-Signature header. The value of this header is computed as the [HMAC hex digest of the body, using the secret as the key][hub-signature].

insecureSsl

boolDetermines whether the SSL certificate of the host for url will be verified when delivering payloads. If false, verification is performed. If true, verification is not performed.

events

arrayDetermines what events the hook is triggered for.

active

boolDetermines whether the hook is actually triggered on pushes.

Response

object

fetchUrl

Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.

fetchUrl(string path, int page, int limit) : \Joomla\Uri\Uri
inherited
since

1.0

Arguments

path

stringURL to inflect

page

intPage to request

limit

intNumber of results to return per page

Response

\Joomla\Uri\Uri

get

Get single hook.

get(string org, int id) : object
since

1.4.0

Arguments

org

stringThe name of the organization.

id

intThe hook id.

Response

object

getList

List hooks.

getList(string org) : object
since

1.4.0

Arguments

org

stringThe name of the organization.

Response

object

ping

Ping a hook.

ping(string org, int id) : object
since

1.4.0

throws

\DomainException

Arguments

org

stringThe name of the organization

id

intID of the hook to ping

Response

object

processResponse

Process the response and decode it.

processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
inherited
since

1.0

throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

response

\Joomla\Http\ResponseThe response.

expectedCode

intThe expected "good" code.

Response

mixed

Properties

options

Options for the GitHub object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Http\Http

package

The package the object resides in

inherited
since

1.0

Type(s)

string

hookEvents

Array containing the allowed hook events

inherited
since

1.5.2

link
note

From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses

Type(s)

array