JGithubHooks
Extends \JGithubObjectGitHub API Hooks class for the Joomla Platform.
since |
3.1.4 |
---|---|
deprecated |
4.0 Use the |
package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null)
since |
1.7.3 |
---|
Arguments
- $options
\Joomla\Registry\Registry
GitHub options object.- $client
\JGithubHttp
The HTTP client object.
create
Method to create a hook on a repository.
create(string $user, string $repo, string $name, array $config, array $events = array('push'), boolean $active = true) : object
deprecated |
use repositories->hooks->create() |
---|---|
since |
3.1.4 |
throws |
|
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $name
string
The name of the service being called.- $config
array
Array containing the config for the service.- $events
array
The events the hook will be triggered for.- $active
boolean
Flag to determine if the hook is active
Response
object
delete
Method to delete a hook
delete(string $user, string $repo, integer $id) : object
deprecated |
use repositories->hooks->delete() |
---|---|
since |
3.1.4 |
throws |
|
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $id
integer
ID of the hook to delete.
Response
object
edit
Method to 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
deprecated |
use repositories->hooks->edit() |
---|---|
since |
3.1.4 |
throws |
|
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $id
integer
ID of the hook to edit.- $name
string
The name of the service being called.- $config
array
Array containing the config for the service.- $events
array
The events the hook will be triggered for. This resets the currently set list- $addEvents
array
Events to add to the hook.- $removeEvents
array
Events to remove from the hook.- $active
boolean
Flag 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
since |
1.7.3 |
---|
Arguments
- $path
string
URL to inflect- $page
integer
Page to request- $limit
integer
Number of results to return per page
Response
string
The request URL.
get
Method to get details about a single hook for the repository.
get(string $user, string $repo, integer $id) : object
deprecated |
use repositories->hooks->get() |
---|---|
since |
3.1.4 |
throws |
|
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $id
integer
ID of the hook to retrieve
Response
object
getList
Method to list hooks for a repository.
getList(string $user, string $repo, integer $page, integer $limit) : object
deprecated |
use repositories->hooks->getList() |
---|---|
since |
3.1.4 |
throws |
|
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $page
integer
Page to request- $limit
integer
Number of results to return per page
Response
object
processResponse
Process the response and decode it.
processResponse(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
throws |
|
---|---|
since |
3.3.0 |
Arguments
- $response
\JHttpResponse
The response.- $expectedCode
integer
The expected "good" code.- $decode
boolean
If the should be response be JSON decoded.
Response
mixed
test
Method to test a hook against the latest repository commit
test(string $user, string $repo, integer $id) : object
deprecated |
use repositories->hooks->test() |
---|---|
since |
3.1.4 |
throws |
|
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $id
integer
ID of the hook to delete
Response
object
Properties
events
Array containing the allowed hook events
since |
3.1.4 |
---|
Type(s)
array
client
The HTTP client object to use in sending HTTP requests.