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

Fonctions membres publiques

 create ($user, $repo, $message, $tree, array $parents=array())
 
 createCommitComment ($user, $repo, $sha, $comment, $line, $filepath, $position)
 
 deleteCommitComment ($user, $repo, $id)
 
 editCommitComment ($user, $repo, $id, $comment)
 
 getCommit ($user, $repo, $sha, $page=0, $limit=0)
 
 getCommitComment ($user, $repo, $id)
 
 getCommitComments ($user, $repo, $sha, $page=0, $limit=0)
 
 getDiff ($user, $repo, $base, $head)
 
 getList ($user, $repo, $page=0, $limit=0)
 
 getListComments ($user, $repo, $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 Commits class for the Joomla Platform.

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

Documentation des fonctions membres

◆ create()

create (   $user,
  $repo,
  $message,
  $tree,
array  $parents = array() 
)

Method to create a commit.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$messageThe commit message.
string$treeSHA of the tree object this commit points to.
array$parentsArray of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided. For a merge commit, an array of more than one should be provided.
Obsolète:
use data->commits->create()
Renvoie
object
Depuis
3.0.0

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

◆ createCommitComment()

createCommitComment (   $user,
  $repo,
  $sha,
  $comment,
  $line,
  $filepath,
  $position 
)

Method to create a comment on a commit.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$shaThe SHA of the commit to comment on.
string$commentThe text of the comment.
integer$lineThe line number of the commit to comment on.
string$filepathA relative path to the file to comment on within the commit.
integer$positionLine index in the diff to comment on.
Obsolète:
use repositories->comments->create()
Renvoie
object
Depuis
3.0.0

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

◆ deleteCommitComment()

deleteCommitComment (   $user,
  $repo,
  $id 
)

Method to delete a comment on a commit.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$idThe ID of the comment to edit.
Obsolète:
use repositories->comments->delete()
Renvoie
object
Depuis
3.0.0

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

◆ editCommitComment()

editCommitComment (   $user,
  $repo,
  $id,
  $comment 
)

Method to edit a comment on a commit.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$idThe ID of the comment to edit.
string$commentThe text of the comment.
Obsolète:
use repositories->comments->edit()
Renvoie
object
Depuis
3.0.0

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

◆ getCommit()

getCommit (   $user,
  $repo,
  $sha,
  $page = 0,
  $limit = 0 
)

Method to get a single commit for a repository.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$shaThe SHA of the commit to retrieve.
integer$pagePage to request
integer$limitNumber of results to return per page
Obsolète:
use repositories->commits->get()
Renvoie
array
Depuis
3.0.0

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

◆ getCommitComment()

getCommitComment (   $user,
  $repo,
  $id 
)

Method to get a single comment on a commit.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$idID of the comment to retrieve
Obsolète:
use repositories->comments->get()
Renvoie
array
Depuis
3.0.0

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

◆ getCommitComments()

getCommitComments (   $user,
  $repo,
  $sha,
  $page = 0,
  $limit = 0 
)

Method to get a list of comments for a single commit for a repository.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$shaThe SHA of the commit to retrieve.
integer$pagePage to request
integer$limitNumber of results to return per page
Obsolète:
use repositories->comments->getList()
Renvoie
array
Depuis
3.0.0

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

◆ getDiff()

getDiff (   $user,
  $repo,
  $base,
  $head 
)

Method to get a diff for two commits.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$baseThe base of the diff, either a commit SHA or branch.
string$headThe head of the diff, either a commit SHA or branch.
Obsolète:
use repositories->commits->compare()
Renvoie
array
Depuis
3.0.0

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

◆ getList()

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

Method to list commits for a repository.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$pagePage to request
integer$limitNumber of results to return per page
Obsolète:
use repositories->commits->getList()
Renvoie
array
Depuis
3.0.0

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

◆ getListComments()

getListComments (   $user,
  $repo,
  $page = 0,
  $limit = 0 
)

Method to get a list of commit comments for a repository.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$pagePage to request
integer$limitNumber of results to return per page
Obsolète:
use repositories->comments->getListRepository()
Renvoie
array
Depuis
3.0.0

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


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