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, $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 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

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	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$title	The title of the milestone.
string	$state	Can be open (default) or closed.
string	$description	Optional description for milestone.
string	$dueOn	Optional ISO 8601 time.

Obsolète:

use issues->milestones->create()

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	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$milestoneId	The id of the milestone to delete.

Obsolète:

use issues->milestones->delete()

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	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$milestoneId	The id of the comment to update.
integer	$title	Optional title of the milestone.
string	$state	Can be open (default) or closed.
string	$description	Optional description for milestone.
string	$dueOn	Optional ISO 8601 time.

Obsolète:

use issues->milestones->edit()

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	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$milestoneId	The milestone id to get.

Obsolète:

use issues->milestones->get()

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	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$state	The milestone state to retrieved. Open (default) or closed.
string	$sort	Sort can be due_date (default) or completeness.
string	$direction	Direction is asc or desc (default).
integer	$page	The page number from which to get items.
integer	$limit	The number of items on a page.

Obsolète:

use issues->milestones->getList()

Renvoie

array

Depuis

3.1.4

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

---

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

• milestones.php