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 JGithubPackageDataRefs
+ Graphe d'héritage de JGithubPackageDataRefs:

Fonctions membres publiques

 get ($user, $repo, $ref)
 
 getList ($user, $repo, $namespace='', $page=0, $limit=0)
 
 create ($user, $repo, $ref, $sha)
 
 edit ($user, $repo, $ref, $sha, $force=false)
 
 delete ($owner, $repo, $ref)
 
- 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)
 

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 JGithubPackage
 $name = ''
 
 $packages = array()
 
- Attributs protégés hérités de JGithubObject
 $options
 
 $client
 

Description détaillée

GitHub API References class for the Joomla Platform.

https://developer.github.com/v3/git/refs/

Depuis
11.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 a ref.

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.
Exceptions
DomainException
Depuis
11.3
Renvoie
object

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

◆ delete()

delete (   $owner,
  $repo,
  $ref 
)

Delete a Reference

Paramètres
string$ownerThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$refThe reference to update.
Depuis
3.3 (CMS)
Renvoie
object

Références $path.

◆ 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.
boolean$forceWhether the update should be forced. Default to false.
Exceptions
DomainException
Depuis
11.3
Renvoie
object

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.
Renvoie
object
Depuis
11.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
Renvoie
array
Depuis
11.3

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


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