Class JGithubHooks
GitHub API Hooks class for the Joomla Platform.
-
JGithubObject
-
JGithubHooks
Methods summary
public
object
|
#
create( string $user, string $repo, string $name, array $config, array $events = array('push'), boolean $active = true )
Method to create a hook on a repository.
Method to create a hook on a repository.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $name
string - $name The name of the service being called.- $config
array - $config Array containing the config for the service.- $events
array - $events The events the hook will be triggered for.- $active
boolean - $active Flag to determine if the hook is active Returns
object
Throws
Since
12.3
|
public
object
|
#
delete( string $user, string $repo, integer $id )
Method to delete a hook
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $id
integer - $id ID of the hook to delete. Returns
object
Throws
Since
12.3
|
public
object
|
#
edit( string $user, string $repo, integer $id, string $name, array $config, array $events = array('push'), array $addEvents = array(), array $removeEvents = array(), boolean $active = true )
Method to edit a hook.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $id
integer - $id ID of the hook to edit.- $name
string - $name The name of the service being called.- $config
array - $config Array containing the config for the service.- $events
array - $events The events the hook will be triggered for. This resets the currently set
list- $addEvents
array - $addEvents Events to add to the hook.- $removeEvents
array - $removeEvents Events to remove from the hook.- $active
boolean - $active Flag to determine if the hook is active Returns
object
Throws
Since
12.3
|
public
object
|
#
get( string $user, string $repo, integer $id )
Method to get details about a single hook for the repository.
Method to get details about a single hook for the repository.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $id
integer - $id ID of the hook to retrieve Returns
object
Throws
Since
12.3
|
public
object
|
#
getList( string $user, string $repo, integer $page = 0, integer $limit = 0 )
Method to list hooks for a repository.
Method to list hooks for a repository.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $page
integer - $page Page to request- $limit
integer - $limit Number of results to return per page Returns
object
Throws
Since
12.3
|
public
object
|
#
test( string $user, string $repo, integer $id )
Method to test a hook against the latest repository commit
Method to test a hook against the latest repository commit
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $id
integer - $id ID of the hook to delete Returns
object
Throws
Since
12.3
|
__construct(),
fetchUrl(),
processResponse()
Magic methods summary
Properties summary
protected
array
|
$events
|
#
Array containing the allowed hook events
Array containing the allowed hook events
Since
12.3
|
$client,
$options
