Hooks

Extends \Joomla\Github\AbstractPackage

GitHub API Hooks class for the Joomla Framework.

link

https://developer.github.com/v3/repos/hooks

since

1.0

Methods

__construct

Constructor.

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

1.0

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\Joomla\Http\HttpThe HTTP client object.

__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 $user, string $repo, string $name, array $config, array $events = array('push'), boolean $active = true) : object
since

1.0

throws

\DomainException

\RuntimeException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$name

stringThe name of the service being called.

$config

arrayArray containing the config for the service.

$events

arrayThe events the hook will be triggered for.

$active

booleanFlag to determine if the hook is active

Response

object

delete

Delete a hook

delete(string $user, string $repo, integer $id) : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$id

integerID of the hook to delete.

Response

object

edit

Edit a hook.

edit(string $user, string $repo, integer $id, string $name, array $config, array $events = array('push'), array $addEvents = array(), array $removeEvents = array(), boolean $active = true) : object
since

1.0

throws

\DomainException

\RuntimeException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$id

integerID of the hook to edit.

$name

stringThe name of the service being called.

$config

arrayArray containing the config for the service.

$events

arrayThe events the hook will be triggered for. This resets the currently set list

$addEvents

arrayEvents to add to the hook.

$removeEvents

arrayEvents to remove from the hook.

$active

booleanFlag to determine if the hook is active

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, integer $page, integer $limit) : string
inherited
since

1.0

note

As of 2.0 this method will return a Joomla\Uri\Uri object

Arguments

$path

stringURL to inflect

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

stringThe request URL.

get

Get single hook.

get(string $user, string $repo, integer $id) : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$id

integerID of the hook to retrieve

Response

object

getList

List hooks.

getList(string $user, string $repo) : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

Response

object

ping

Ping a hook.

ping(string $user, string $repo, integer $id) : object
since

1.4.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$id

integerID of the hook to ping

Response

object

processResponse

Process the response and decode it.

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

1.0

throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

$response

\Joomla\Http\ResponseThe response.

$expectedCode

integerThe expected "good" code.

Response

mixed

test

Test a push hook.

test(string $user, string $repo, integer $id) : object
since

1.0

throws

\DomainException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$id

integerID of the hook to test

Response

object

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\Github\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

https://developer.github.com/webhooks/#events

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