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

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, $due_on=null)
 
 edit ($user, $repo, $milestoneId, $title=null, $state=null, $description=null, $due_on=null)
 
 delete ($user, $repo, $milestoneId)
 
- 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 Milestones class for the Joomla Platform.

Depuis
12.3
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,
  $due_on = 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$due_onOptional ISO 8601 time.
Obsolète:
use issues->milestones->create()
Renvoie
object
Depuis
12.3

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.
Obsolète:
use issues->milestones->delete()
Renvoie
void
Depuis
12.3

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

◆ edit()

edit (   $user,
  $repo,
  $milestoneId,
  $title = null,
  $state = null,
  $description = null,
  $due_on = 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$due_onOptional ISO 8601 time.
Obsolète:
use issues->milestones->edit()
Renvoie
object
Depuis
12.3

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.
Obsolète:
use issues->milestones->get()
Renvoie
object
Depuis
12.3

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.
Obsolète:
use issues->milestones->getList()
Renvoie
array
Depuis
12.3

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


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