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

Fonctions membres publiques

 get ($owner, $repo, $sha)
 
 create ($owner, $repo, $tag, $message, $object, $type, $taggerName, $taggerEmail, $taggerDate)
 
- 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 Data Tags class for the Joomla Platform.

This tags API only deals with tag objects - so only annotated tags, not lightweight tags.

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

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

Documentation des fonctions membres

◆ create()

create (   $owner,
  $repo,
  $tag,
  $message,
  $object,
  $type,
  $taggerName,
  $taggerEmail,
  $taggerDate 
)

Create a Tag Object

Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you simply have to create the reference - this call would be unnecessary.

Paramètres
string$ownerThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$tagThe tag string.
string$messageThe tag message.
string$objectThe SHA of the git object this is tagging.
string$typeThe type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.
string$taggerNameThe name of the author of the tag.
string$taggerEmailThe email of the author of the tag.
string$taggerDateTimestamp of when this object was tagged.
Depuis
3.3 (CMS)
Renvoie
object

Références $data, $message, $path, $type, et json_encode.

◆ get()

get (   $owner,
  $repo,
  $sha 
)

Get a Tag.

Paramètres
string$ownerThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$shaThe SHA1 value to set the reference to.
Depuis
3.3 (CMS)
Renvoie
object

Références $path.


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