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

Fonctions membres publiques

 getListRepository ($user, $repo, $page=0, $limit=0)
 
 getList ($user, $repo, $sha, $page=0, $limit=0)
 
 get ($user, $repo, $id)
 
 edit ($user, $repo, $id, $comment)
 
 delete ($user, $repo, $id)
 
 create ($user, $repo, $sha, $comment, $line, $filepath, $position)
 
- 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 Repositories Comments class for the Joomla Platform.

https://developer.github.com/v3/repos/comments

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

Documentation des fonctions membres

◆ create()

create (   $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.
Renvoie
object
Depuis
3.0.0

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

◆ delete()

delete (   $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.
Renvoie
object
Depuis
3.0.0

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

◆ edit()

edit (   $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.
Renvoie
object
Depuis
3.0.0

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

◆ get()

get (   $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
Renvoie
array
Depuis
3.0.0

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

◆ getList()

getList (   $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
Renvoie
array
Depuis
3.0.0

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

◆ getListRepository()

getListRepository (   $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
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 :