Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe JGithubPackageRepositoriesHooks
+ Graphe d'héritage de JGithubPackageRepositoriesHooks:

Fonctions membres publiques

 create ($user, $repo, $name, $config, array $events=array('push'), $active=true)
 
 delete ($user, $repo, $id)
 
 edit ($user, $repo, $id, $name, $config, array $events=array('push'), array $addEvents=array(), array $removeEvents=array(), $active=true)
 
 get ($user, $repo, $id)
 
 getList ($user, $repo)
 
 test ($user, $repo, $id)
 
- Fonctions membres publiques hérités de JGithubPackage
 __get ($name)
 
- Fonctions membres publiques hérités de JGithubObject
 __construct (Registry $options=null, JGithubHttp $client=null)
 

Attributs protégés

 $events
 
- Attributs protégés hérités de JGithubPackage
 $name = ''
 
 $packages = array()
 
- Attributs protégés hérités de JGithubObject
 $options
 
 $client
 

Membres hérités additionnels

- Fonctions membres protégées hérités de JGithubObject
 fetchUrl ($path, $page=0, $limit=0)
 
 processResponse (JHttpResponse $response, $expectedCode=200, $decode=true)
 

Description détaillée

GitHub API Hooks class for the Joomla Platform.

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

Depuis
12.3
Obsolète:
4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

◆ create()

create (   $user,
  $repo,
  $name,
  $config,
array  $events = array('push'),
  $active = true 
)

Method to create a hook on a repository.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$nameThe name of the service being called.
array$configArray containing the config for the service.
array$eventsThe events the hook will be triggered for.
boolean$activeFlag to determine if the hook is active
Renvoie
object
Depuis
12.3
Exceptions
DomainException
RuntimeException

Références $active, $config, $data, $name, $path, $user, et json_encode.

◆ delete()

delete (   $user,
  $repo,
  $id 
)

Method to delete a hook

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$idID of the hook to delete.
Renvoie
object
Depuis
12.3
Exceptions
DomainException

Références $id, $path, et $user.

◆ edit()

edit (   $user,
  $repo,
  $id,
  $name,
  $config,
array  $events = array('push'),
array  $addEvents = array(),
array  $removeEvents = array(),
  $active = true 
)

Method to edit a hook.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$idID of the hook to edit.
string$nameThe name of the service being called.
array$configArray containing the config for the service.
array$eventsThe events the hook will be triggered for. This resets the currently set list
array$addEventsEvents to add to the hook.
array$removeEventsEvents to remove from the hook.
boolean$activeFlag to determine if the hook is active
Renvoie
object
Depuis
12.3
Exceptions
DomainException
RuntimeException

Références $active, $config, $data, $id, $name, $path, $user, et json_encode.

◆ get()

get (   $user,
  $repo,
  $id 
)

Method to get details about a single hook for the repository.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$idID of the hook to retrieve
Renvoie
object
Depuis
12.3
Exceptions
DomainException

Références $id, $path, et $user.

◆ getList()

getList (   $user,
  $repo 
)

Method to list hooks for a repository.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
Renvoie
object
Depuis
12.3
Exceptions
DomainException

Références $path, et $user.

◆ test()

test (   $user,
  $repo,
  $id 
)

Method to test a hook against the latest repository commit

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$idID of the hook to delete
Renvoie
object
Depuis
12.3
Exceptions
DomainException

Références $id, $path, $user, et json_encode.

Documentation des champs

◆ $events

$events
protected
Valeur initiale :
= array(
'push',
'issues',
'issue_comment',
'commit_comment',
'pull_request',
'gollum',
'watch',
'download',
'fork',
'fork_apply',
'member',
'public',
'status',
)

La documentation de cette classe a été générée à partir du fichier suivant :