Class Github\Api\Issue\Labels

InheritanceGithub\Api\Issue\Labels » Github\Api\AbstractApi
ImplementsGithub\Api\ApiInterface

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Github\Api\AbstractApi
add() Add a label to an issue. Github\Api\Issue\Labels
all() Get all labels for a repository or the labels for a specific issue. Github\Api\Issue\Labels
clear() Remove all labels from an issue. Github\Api\Issue\Labels
configure() Github\Api\AbstractApi
create() Create a label for a repository. Github\Api\Issue\Labels
deleteLabel() Delete a label for a repository. Github\Api\Issue\Labels
getPerPage() Github\Api\AbstractApi
remove() Remove a label for an issue Github\Api\Issue\Labels
replace() Replace labels for an issue. Github\Api\Issue\Labels
setPerPage() Github\Api\AbstractApi
update() Edit a label for a repository Github\Api\Issue\Labels

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
createJsonBody() Create a JSON encoded version of an array of parameters. Github\Api\AbstractApi
delete() Send a DELETE request with JSON-encoded parameters. Github\Api\AbstractApi
get() Send a GET request with query parameters. Github\Api\AbstractApi
head() Send a HEAD request with query parameters. Github\Api\AbstractApi
patch() Send a PATCH request with JSON-encoded parameters. Github\Api\AbstractApi
post() Send a POST request with JSON-encoded parameters. Github\Api\AbstractApi
postRaw() Send a POST request with raw data. Github\Api\AbstractApi
put() Send a PUT request with JSON-encoded parameters. Github\Api\AbstractApi

Method Details

add() public method

Add a label to an issue.

public array add ( $username, $repository, $issue, $labels )
$username string
$repository string
$issue int
$labels string
all() public method

Get all labels for a repository or the labels for a specific issue.

public array all ( $username, $repository, $issue null )
$username string
$repository string
$issue int|null
clear() public method

Remove all labels from an issue.

public null clear ( $username, $repository, $issue )
$username string
$repository string
$issue string
create() public method

Create a label for a repository.

public array create ( $username, $repository, array $params )
$username string
$repository string
$params array
throws Github\Exception\MissingArgumentException
deleteLabel() public method

Delete a label for a repository.

public array deleteLabel ( $username, $repository, $label )
$username string
$repository string
$label string
remove() public method

Remove a label for an issue

public null remove ( $username, $repository, $issue, $label )
$username string
$repository string
$issue string
$label string
replace() public method

Replace labels for an issue.

public array replace ( $username, $repository, $issue, array $params )
$username string
$repository string
$issue int
$params array
update() public method

Edit a label for a repository

public array update ( $username, $repository, $label, $newName, $color )
$username string
$repository string
$label string
$newName string
$color string