JGithubPackageIssuesLabels

class JGithubPackageIssuesLabels extends JGithubPackage

GitHub API Milestones class for the Joomla Platform.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

from JGithubObject
JGithubPackage
__get( string $name)

Magic method to lazily create API objects

from JGithubPackage
array
getList( string $owner, string $repo)

Method to get the list of labels on a repo.

object
get( string $user, string $repo, string $name)

Method to get a specific label on a repo.

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

Method to create a label on a repo.

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

Method to update a label on a repo.

object
delete( string $owner, string $repo, string $name)

Method to delete a label on a repo.

object
getListByIssue( string $owner, string $repo, integer $number)

List labels on an issue.

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

Add labels to an issue.

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

Remove a label from an issue.

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

Replace all labels for an issue.

object
removeAllFromIssue( string $owner, string $repo, string $number)

No description

object
getListByMilestone( string $owner, string $repo, string $number)

Get labels for every issue in a milestone.

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

JGithubPackage __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JGithubPackage GitHub API package object.

Exceptions

RuntimeException

array getList( string $owner, string $repo)

Method to get the list of labels on a repo.

Parameters

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

Return Value

array

Exceptions

DomainException

object get( string $user, string $repo, string $name)

Method to get a specific label on a repo.

Parameters

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.

Return Value

object

Exceptions

DomainException

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

Method to create a label on a repo.

Parameters

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.

Return Value

object

Exceptions

DomainException

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

Method to update a label on a repo.

Parameters

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.

Return Value

object

Exceptions

DomainException

object delete( string $owner, string $repo, string $name)

Method to delete a label on a repo.

Parameters

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

Return Value

object

Exceptions

DomainException

object getListByIssue( string $owner, string $repo, integer $number)

List labels on an issue.

Parameters

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

Return Value

object

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

Add labels to an issue.

Parameters

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.

Return Value

object

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

Remove a label from an issue.

Parameters

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.

Return Value

object

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

Replace all labels for an issue.

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

Parameters

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

Return Value

object

object removeAllFromIssue( string $owner, string $repo, string $number)

.* Remove all labels from an issue.

Parameters

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

Return Value

object

object getListByMilestone( string $owner, string $repo, string $number)

Get labels for every issue in a milestone.

Parameters

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

Return Value

object