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

Fonctions membres publiques

 getList ($user, $repo, $state='open', $sort='due_date', $direction='desc', $page=0, $limit=0)
 
 get ($user, $repo, $milestoneId)
 
 create ($user, $repo, $title, $state=null, $description=null, $dueOn=null)
 
 edit ($user, $repo, $milestoneId, $title=null, $state=null, $description=null, $dueOn=null)
 
 delete ($user, $repo, $milestoneId)
 
- 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 Milestones class for the Joomla Platform.

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

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

Documentation des fonctions membres

◆ create()

create (   $user,
  $repo,
  $title,
  $state = null,
  $description = null,
  $dueOn = null 
)

Method to create a milestone for a repository.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$titleThe title of the milestone.
string$stateCan be open (default) or closed.
string$descriptionOptional description for milestone.
string$dueOnOptional ISO 8601 time.
Exceptions
DomainException
Renvoie
object
Depuis
3.1.4

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

◆ delete()

delete (   $user,
  $repo,
  $milestoneId 
)

Method to delete a milestone.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$milestoneIdThe id of the milestone to delete.
Exceptions
DomainException
Renvoie
void
Depuis
3.1.4

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

◆ edit()

edit (   $user,
  $repo,
  $milestoneId,
  $title = null,
  $state = null,
  $description = null,
  $dueOn = null 
)

Method to update a milestone.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$milestoneIdThe id of the comment to update.
integer$titleOptional title of the milestone.
string$stateCan be open (default) or closed.
string$descriptionOptional description for milestone.
string$dueOnOptional ISO 8601 time.
Exceptions
DomainException
Renvoie
object
Depuis
3.1.4

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

◆ get()

get (   $user,
  $repo,
  $milestoneId 
)

Method to get a specific milestone.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
integer$milestoneIdThe milestone id to get.
Exceptions
DomainException
Renvoie
object
Depuis
3.1.4

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

◆ getList()

getList (   $user,
  $repo,
  $state = 'open',
  $sort = 'due_date',
  $direction = 'desc',
  $page = 0,
  $limit = 0 
)

Method to get the list of milestones for a repo.

Paramètres
string$userThe name of the owner of the GitHub repository.
string$repoThe name of the GitHub repository.
string$stateThe milestone state to retrieved. Open (default) or closed.
string$sortSort can be due_date (default) or completeness.
string$directionDirection is asc or desc (default).
integer$pageThe page number from which to get items.
integer$limitThe number of items on a page.
Exceptions
DomainException
Depuis
3.1.4
Renvoie
array

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


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