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

Fonctions membres publiques

 create ($user, $repo, $title, $body=null, $assignee=null, $milestone=null, array $labels=null)
 
 edit ($user, $repo, $issueId, $state=null, $title=null, $body=null, $assignee=null, $milestone=null, array $labels=null)
 
 get ($user, $repo, $issueId)
 
 getList ($filter=null, $state=null, $labels=null, $sort=null, $direction=null, JDate $since=null, $page=0, $limit=0)
 
 getListByRepository ($user, $repo, $milestone=null, $state=null, $assignee=null, $mentioned=null, $labels=null, $sort=null, $direction=null, JDate $since=null, $page=0, $limit=0)
 
 createComment ($user, $repo, $issueId, $body)
 
 createLabel ($user, $repo, $name, $color)
 
 deleteComment ($user, $repo, $commentId)
 
 deleteLabel ($user, $repo, $label)
 
 editComment ($user, $repo, $commentId, $body)
 
 editLabel ($user, $repo, $label, $name, $color)
 
 getComment ($user, $repo, $commentId)
 
 getComments ($user, $repo, $issueId, $page=0, $limit=0)
 
 getLabel ($user, $repo, $name)
 
 getLabels ($user, $repo)
 
- 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)
 

Attributs protégés

 $name = 'Issues'
 
 $packages = array('assignees', 'comments', 'events', 'labels', 'milestones')
 
- Attributs protégés hérités de JGithubPackage
 $name = ''
 
 $packages = array()
 
- Attributs protégés hérités de JGithubObject
 $options
 
 $client
 

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)
 

Documentation des fonctions membres

◆ create()

create (   $user,
  $repo,
  $title,
  $body = null,
  $assignee = null,
  $milestone = null,
array  $labels = null 
)

Method to create an issue.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$titleThe title of the new issue.
string$bodyThe body text for the new issue.
string$assigneeThe login for the GitHub user that this issue should be assigned to.
integer$milestoneThe milestone to associate this issue with.
array$labelsThe labels to associate with this issue.
Exceptions
DomainException
Depuis
11.3
Renvoie
object

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

◆ createComment()

createComment (   $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.
Obsolète:
use issues->comments->create()
Renvoie
object
Depuis
11.3

Références $user.

◆ createLabel()

createLabel (   $user,
  $repo,
  $name,
  $color 
)

Method to create a label on a repo.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$nameThe label name.
string$colorThe label color.
Obsolète:
use issues->labels->create()
Renvoie
object
Depuis
12.3

Références $color, $name, et $user.

◆ deleteComment()

deleteComment (   $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.
Obsolète:
use issues->comments->delete()
Renvoie
void
Depuis
11.3

Références $user.

◆ deleteLabel()

deleteLabel (   $user,
  $repo,
  $label 
)

Method to delete a label on a repo.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$labelThe label name.
Obsolète:
use issues->labels->delete()
Renvoie
object
Depuis
12.3

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

◆ edit()

edit (   $user,
  $repo,
  $issueId,
  $state = null,
  $title = null,
  $body = null,
  $assignee = null,
  $milestone = null,
array  $labels = null 
)

Method to update 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$stateThe optional new state for the issue. [open, closed]
string$titleThe title of the new issue.
string$bodyThe body text for the new issue.
string$assigneeThe login for the GitHub user that this issue should be assigned to.
integer$milestoneThe milestone to associate this issue with.
array$labelsThe labels to associate with this issue.
Exceptions
DomainException
Depuis
11.3
Renvoie
object

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

◆ editComment()

editComment (   $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.
Obsolète:
use issues->comments->edit()
Renvoie
object
Depuis
11.3

Références $user.

◆ editLabel()

editLabel (   $user,
  $repo,
  $label,
  $name,
  $color 
)

Method to update a label on a repo.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$labelThe label name.
string$nameThe label name.
string$colorThe label color.
Obsolète:
use issues->labels->update()
Renvoie
object
Depuis
12.3

Références $color, $label, $name, et $user.

◆ get()

get (   $user,
  $repo,
  $issueId 
)

Method to get a single issue.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$issueIdThe issue number.
Exceptions
DomainException
Depuis
11.3
Renvoie
object

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

◆ getComment()

getComment (   $user,
  $repo,
  $commentId 
)

Method to get a specific 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 comment id to get.
Obsolète:
use issues->comments->get()
Renvoie
object
Depuis
11.3

Références $user.

◆ getComments()

getComments (   $user,
  $repo,
  $issueId,
  $page = 0,
  $limit = 0 
)

Method to get the list of comments 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.
integer$pageThe page number from which to get items.
integer$limitThe number of items on a page.
Obsolète:
use issues->comments->getList()
Renvoie
array
Depuis
11.3

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

◆ getLabel()

getLabel (   $user,
  $repo,
  $name 
)

Method to get a specific label on a repo.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$nameThe label name to get.
Obsolète:
use issues->labels->get()
Renvoie
object
Depuis
12.3

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

◆ getLabels()

getLabels (   $user,
  $repo 
)

Method to get the list of labels on a repo.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
Obsolète:
use issues->labels->getList()
Renvoie
array
Depuis
12.3

Références $user.

◆ getList()

getList (   $filter = null,
  $state = null,
  $labels = null,
  $sort = null,
  $direction = null,
JDate  $since = null,
  $page = 0,
  $limit = 0 
)

Method to list an authenticated user's issues.

Paramètres
string$filterThe filter type: assigned, created, mentioned, subscribed.
string$stateThe optional state to filter requests by. [open, closed]
string$labelsThe list of comma separated Label names. Example: bug,ui,.
string$sortThe sort order: created, updated, comments, default: created.
string$directionThe list direction: asc or desc, default: desc.
JDate$sinceThe date/time since when issues should be returned.
integer$pageThe page number from which to get items.
integer$limitThe number of items on a page.
Exceptions
DomainException
Depuis
11.3
Renvoie
array

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

◆ getListByRepository()

getListByRepository (   $user,
  $repo,
  $milestone = null,
  $state = null,
  $assignee = null,
  $mentioned = null,
  $labels = null,
  $sort = null,
  $direction = null,
JDate  $since = null,
  $page = 0,
  $limit = 0 
)

Method to list issues.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$milestoneThe milestone number, 'none', or *.
string$stateThe optional state to filter requests by. [open, closed]
string$assigneeThe assignee name, 'none', or *.
string$mentionedThe GitHub user name.
string$labelsThe list of comma separated Label names. Example: bug,ui,.
string$sortThe sort order: created, updated, comments, default: created.
string$directionThe list direction: asc or desc, default: desc.
JDate$sinceThe date/time since when issues should be returned.
integer$pageThe page number from which to get items.
integer$limitThe number of items on a page.
Exceptions
DomainException
Depuis
11.3
Renvoie
array

Références $direction, $limit, $path, $state, $uri, et $user.

Documentation des champs

◆ $name

$name = 'Issues'
protected

◆ $packages

$packages = array('assignees', 'comments', 'events', 'labels', 'milestones')
protected

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