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é
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JGithubRefs
+ Graphe d'héritage de JGithubRefs:

Fonctions membres publiques

 create ($user, $repo, $ref, $sha)
 
 edit ($user, $repo, $ref, $sha, $force=false)
 
 get ($user, $repo, $ref)
 
 getList ($user, $repo, $namespace='', $page=0, $limit=0)
 
- 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
1.7.3
Obsolète:
4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

◆ create()

create (   $user,
  $repo,
  $ref,
  $sha 
)

Method to create an issue.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$refThe name of the fully qualified reference.
string$shaThe SHA1 value to set this reference to.
Obsolète:
use data->refs->create()
Renvoie
object
Depuis
1.7.3

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

◆ edit()

edit (   $user,
  $repo,
  $ref,
  $sha,
  $force = false 
)

Method to update a reference.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$refThe reference to update.
string$shaThe SHA1 value to set the reference to.
string$forceWhether the update should be forced. Default to false.
Obsolète:
use data->refs->edit()
Renvoie
object
Depuis
1.7.3

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

◆ get()

get (   $user,
  $repo,
  $ref 
)

Method to get a reference.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$refThe reference to get.
Obsolète:
use data->refs->get()
Renvoie
object
Depuis
1.7.3

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

◆ getList()

getList (   $user,
  $repo,
  $namespace = '',
  $page = 0,
  $limit = 0 
)

Method to list references for a repository.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$namespaceOptional sub-namespace to limit the returned references.
integer$pagePage to request
integer$limitNumber of results to return per page
Obsolète:
use data->refs->getList()
Renvoie
array
Depuis
1.7.3

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


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