1. class
  2. PCIT
  3. \
  4. GitHub
  5. \
  6. Service
  7. \
  8. Issue
  9. \
  10. LabelsClient

LabelsClient

class LabelsClient

Class Labels.

Traits

CICommon

Properties

protected $curl from CICommon
protected $api_url from CICommon

Methods

__construct(Curl $curl, string $api_url)

CICommon constructor.

from CICommon
mixed
all(string $repo_full_name)

List all labels for this repository.

mixed
find(string $repo_full_name, string $label_name)

Get a single label.

mixed
create(string $repo_full_name, string $name, string $color, string $description)

Create a label.

mixed
update(string $repo_full_name, string $label_current_name, string $name, string $color, string $description)

Update a label.

mixed
delete(string $repo_full_name, string $label_name)

Delete a label.

mixed
listLabelsOnIssue(string $repo_full_name, int $issue_number)

List labels on an issue.

mixed
addLabelsOnIssue(string $repo_full_name, int $issue_number, array $label)

Add labels to an issue.

mixed
removeLabelOnIssue(string $repo_full_name, int $issue_number, string $label_name)

Remove a label from an issue.

mixed
replaceAllLabelsForIssue(string $repo_full_name, int $issue_number, array $labels = [])

Replace all labels for an issue.

mixed
removeAllLabelsFromIssue(string $repo_full_name, int $issue_number)

Remove all labels from an issue.

mixed
getLabelsForEveryIssueInMilestone(string $repo_full_name, int $milestones_number)

Get labels for every issue in a milestone.

Details

in CICommon at line 18
__construct(Curl $curl, string $api_url)

CICommon constructor.

Parameters

Curl $curl
string $api_url

at line 25
mixed all(string $repo_full_name)

List all labels for this repository.

Parameters

string $repo_full_name

Return Value

mixed

Exceptions

Exception

at line 39
mixed find(string $repo_full_name, string $label_name)

Get a single label.

Parameters

string $repo_full_name
string $label_name

Return Value

mixed

Exceptions

Exception

at line 57
mixed create(string $repo_full_name, string $name, string $color, string $description)

Create a label.

post 201

Parameters

string $repo_full_name
string $name
string $color
string $description

Return Value

mixed

Exceptions

Exception

at line 75
mixed update(string $repo_full_name, string $label_current_name, string $name, string $color, string $description)

Update a label.

patch

Parameters

string $repo_full_name
string $label_current_name
string $name
string $color
string $description

Return Value

mixed

Exceptions

Exception

at line 95
mixed delete(string $repo_full_name, string $label_name)

Delete a label.

204

Parameters

string $repo_full_name
string $label_name

Return Value

mixed

Exceptions

Exception

at line 109
mixed listLabelsOnIssue(string $repo_full_name, int $issue_number)

List labels on an issue.

Parameters

string $repo_full_name
int $issue_number

Return Value

mixed

Exceptions

Exception

at line 123
mixed addLabelsOnIssue(string $repo_full_name, int $issue_number, array $label)

Add labels to an issue.

Parameters

string $repo_full_name
int $issue_number
array $label

Return Value

mixed

Exceptions

Exception

at line 137
mixed removeLabelOnIssue(string $repo_full_name, int $issue_number, string $label_name)

Remove a label from an issue.

Parameters

string $repo_full_name
int $issue_number
string $label_name

Return Value

mixed

Exceptions

Exception

at line 151
mixed replaceAllLabelsForIssue(string $repo_full_name, int $issue_number, array $labels = [])

Replace all labels for an issue.

Parameters

string $repo_full_name
int $issue_number
array $labels

Return Value

mixed

Exceptions

Exception

at line 167
mixed removeAllLabelsFromIssue(string $repo_full_name, int $issue_number)

Remove all labels from an issue.

204

Parameters

string $repo_full_name
int $issue_number

Return Value

mixed

Exceptions

Exception

at line 181
mixed getLabelsForEveryIssueInMilestone(string $repo_full_name, int $milestones_number)

Get labels for every issue in a milestone.

Parameters

string $repo_full_name
int $milestones_number

Return Value

mixed

Exceptions

Exception