Référence de la classe JGithubPackageIssuesLabels

Graphe d'héritage de JGithubPackageIssuesLabels:

Fonctions membres publiques
	getList ($owner, $repo)
	get ($user, $repo, $name)
	create ($owner, $repo, $name, $color)
	update ($user, $repo, $label, $name, $color)
	delete ($owner, $repo, $name)
	getListByIssue ($owner, $repo, $number)
	add ($owner, $repo, $number, array $labels)
	removeFromIssue ($owner, $repo, $number, $name)
	replace ($owner, $repo, $number, array $labels)
	removeAllFromIssue ($owner, $repo, $number)
	getListByMilestone ($owner, $repo, $number)
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/labels/

Depuis

3.1.4

Obsolète:

4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

add()

add	(		$owner,
			$repo,
			$number,
		array	$labels
	)

Add labels to an issue.

Paramètres

string	$owner	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$number	The issue number.
array	$labels	An array of labels to add.

Depuis

3.3 (CMS)

Renvoie

object

Références $path, et json_encode.

create()

create	(		$owner,
			$repo,
			$name,
			$color
	)

Method to create a label on a repo.

Paramètres

string	$owner	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$name	The label name.
string	$color	The label color.

Exceptions

DomainException

Depuis

3.1.4

Renvoie

object

Références $color, $data, $name, $path, et json_encode.

delete()

delete	(		$owner,
			$repo,
			$name
	)

Method to delete a label on a repo.

Paramètres

string	$owner	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$name	The label name.

Exceptions

DomainException

Renvoie

object

Depuis

3.1.4

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

get()

get	(		$user,
			$repo,
			$name
	)

Method to get a specific label on a repo.

Paramètres

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$name	The label name to get.

Exceptions

DomainException

Depuis

3.1.4

Renvoie

object

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

getList()

getList	(		$owner,
			$repo
	)

Method to get the list of labels on a repo.

Paramètres

string	$owner	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.

Exceptions

DomainException

Depuis

3.1.4

Renvoie

array

Références $path.

getListByIssue()

getListByIssue	(		$owner,
			$repo,
			$number
	)

List labels on an issue.

Paramètres

string	$owner	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
integer	$number	The issue number.

Depuis

3.3 (CMS)

Renvoie

object

Références $path.

getListByMilestone()

getListByMilestone	(		$owner,
			$repo,
			$number
	)

Get labels for every issue in a milestone.

Paramètres

string	$owner	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$number	The issue number.

Depuis

3.3 (CMS)

Renvoie

object

Références $path.

removeAllFromIssue()

removeAllFromIssue	(		$owner,
			$repo,
			$number
	)

.* Remove all labels from an issue.

Paramètres

string	$owner	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$number	The issue number.

Depuis

3.3 (CMS)

Renvoie

object

Références $path.

removeFromIssue()

removeFromIssue	(		$owner,
			$repo,
			$number,
			$name
	)

Remove a label from an issue.

Paramètres

string	$owner	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$number	The issue number.
string	$name	The name of the label to remove.

Depuis

3.3 (CMS)

Renvoie

object

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

replace()

replace	(		$owner,
			$repo,
			$number,
		array	$labels
	)

Replace all labels for an issue.

Sending an empty array ([]) will remove all Labels from the Issue.

Paramètres

string	$owner	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$number	The issue number.
array	$labels	New labels

Depuis

3.3 (CMS)

Renvoie

object

Références $path, et json_encode.

update()

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

Method to update a label on a repo.

Paramètres

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$label	The label name.
string	$name	The new label name.
string	$color	The new label color.

Exceptions

DomainException

Depuis

3.1.4

Renvoie

object

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

---

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

• labels.php