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

Fonctions membres publiques

 getList ($owner, $repo, $issueId, $page=0, $limit=0)
 
 getRepositoryList ($owner, $repo, $sort='created', $direction='asc', JDate $since=null)
 
 get ($owner, $repo, $id)
 
 edit ($user, $repo, $commentId, $body)
 
 create ($user, $repo, $issueId, $body)
 
 delete ($user, $repo, $commentId)
 
- 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 Comments class for the Joomla Platform.

The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.

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

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

Documentation des fonctions membres

◆ create()

create (   $user,
  $repo,
  $issueId,
  $body 
)

Method to create a comment on an issue.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$issueIdThe issue number.
string$bodyThe comment body text.
Exceptions
DomainException
Depuis
1.7.3
Renvoie
object

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

◆ delete()

delete (   $user,
  $repo,
  $commentId 
)

Method to delete a comment on an issue.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$commentIdThe id of the comment to delete.
Exceptions
DomainException
Depuis
1.7.3
Renvoie
boolean

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

◆ edit()

edit (   $user,
  $repo,
  $commentId,
  $body 
)

Method to update a comment on an issue.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$commentIdThe id of the comment to update.
string$bodyThe new body text for the comment.
Depuis
1.7.3
Exceptions
DomainException
Renvoie
object

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

◆ get()

get (   $owner,
  $repo,
  $id 
)

Method to get a single comment.

Paramètres
string$ownerThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$idThe comment id.
Renvoie
mixed

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

◆ getList()

getList (   $owner,
  $repo,
  $issueId,
  $page = 0,
  $limit = 0 
)

Method to get the list of comments on an issue.

Paramètres
string$ownerThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$issueIdThe issue number.
integer$pageThe page number from which to get items.
integer$limitThe number of items on a page.
Exceptions
DomainException
Depuis
1.7.3
Renvoie
array

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

◆ getRepositoryList()

getRepositoryList (   $owner,
  $repo,
  $sort = 'created',
  $direction = 'asc',
JDate  $since = null 
)

Method to get the list of comments in a repository.

Paramètres
string$ownerThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$sortThe sort field - created or updated.
string$directionThe sort order- asc or desc. Ignored without sort parameter.
JDate$sinceA timestamp in ISO 8601 format.
Exceptions
UnexpectedValueException
DomainException
Depuis
1.7.3
Renvoie
array

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


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