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

Fonctions membres publiques

 create ($user, $repo, $sha, $state, $targetUrl=null, $description=null)
 
 getList ($user, $repo, $sha)
 
- Fonctions membres publiques hérités de JGithubObject
 __construct (Registry $options=null, JGithubHttp $client=null)
 

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)
 
- Attributs protégés hérités de JGithubObject
 $options
 
 $client
 

Description détaillée

GitHub API References class for the Joomla Platform.

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

Documentation des fonctions membres

◆ create()

create (   $user,
  $repo,
  $sha,
  $state,
  $targetUrl = null,
  $description = null 
)

Method to create a status.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$shaThe SHA1 value for which to set the status.
string$stateThe state (pending, success, error or failure).
string$targetUrlOptional target URL.
string$descriptionOptional description for the status.
Obsolète:
use repositories->statuses->create()
Renvoie
object
Depuis
3.1.4

Références $data, $description, $path, $state, $user, et json_encode.

◆ getList()

getList (   $user,
  $repo,
  $sha 
)

Method to list statuses for an SHA.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$shaSHA1 for which to get the statuses.
Obsolète:
use repositories->statuses->getList()
Renvoie
array
Depuis
3.1.4

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


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