Joomla! API

Download
Launch

Labels

Extends AbstractPackage

GitHub API Milestones class for the Joomla Framework.

documentation

http://developer.github.com/v3/issues/labels/
since

1.0
package

Joomla Framework

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) : mixed
inherited
since

1.0

Arguments

options

\Joomla\Registry\RegistryGitHub options object.

client

\Joomla\Http\HttpThe HTTP client object.

Response

mixed

__get

Magic method to lazily create API objects

__get(string name) : \Joomla\Github\AbstractPackage
inherited
since

1.0
throws

\InvalidArgumentException

Arguments

name

stringName of property to retrieve

Response

\Joomla\Github\AbstractPackageGitHub API package object.

add

Add labels to an issue.

add(string owner, string repo, string number, array labels) : object
since

1.0

Arguments

owner

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

number

stringThe issue number.

labels

arrayAn array of labels to add.

Response

object

create

Create a label.

create(string owner, string repo, string name, string color) : object
since

1.0
throws

\DomainException

Arguments

owner

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

name

stringThe label name.

color

stringThe label color.

Response

object

delete

Delete a label.

delete(string owner, string repo, string name) : object
since

1.0

Arguments

owner

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

name

stringThe label name.

Response

object

fetchUrl

Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.

fetchUrl(string path, int page, int limit) : \Joomla\Uri\Uri
inherited
since

1.0

Arguments

path

stringURL to inflect

page

intPage to request

limit

intNumber of results to return per page

Response

\Joomla\Uri\Uri

get

Get a single label.

get(string user, string repo, string name) : object
since

1.0

Arguments

user

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

name

stringThe label name to get.

Response

object

getList

List all labels for this repository.

getList(string owner, string repo) : array
since

1.0

Arguments

owner

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

Response

array

getListByIssue

List labels on an issue.

getListByIssue(string owner, string repo, int number) : object
since

1.0

Arguments

owner

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

number

intThe issue number.

Response

object

getListByMilestone

Get labels for every issue in a milestone.

getListByMilestone(string owner, string repo, string number) : object
since

1.0

Arguments

owner

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

number

stringThe issue number.

Response

object

processResponse

Process the response and decode it.

processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
inherited
since

1.0
throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

response

\Joomla\Http\ResponseThe response.

expectedCode

intThe expected "good" code.

Response

mixed

removeAllFromIssue

Remove all labels from an issue.

removeAllFromIssue(string owner, string repo, string number) : object
since

1.0

Arguments

owner

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

number

stringThe issue number.

Response

object

removeFromIssue

Remove a label from an issue.

removeFromIssue(string owner, string repo, string number, string name) : object
since

1.0

Arguments

owner

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

number

stringThe issue number.

name

stringThe name of the label to remove.

Response

object

replace

Replace all labels for an issue.

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

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

since

1.0

Arguments

owner

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

number

stringThe issue number.

labels

arrayNew labels

Response

object

update

Update a label.

update(string user, string repo, string label, string name, string color) : object
since

1.0

Arguments

user

stringThe name of the owner of the GitHub repository.

repo

stringThe name of the GitHub repository.

label

stringThe label name.

name

stringThe new label name.

color

stringThe new label color.

Response

object

Properties

options

Options for the GitHub object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Http\Http

package

The package the object resides in

inherited
since

1.0

Type(s)

string

hookEvents

Array containing the allowed hook events

inherited
since

1.5.2
link
note

From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses

Type(s)

array
  • \ Joomla
  • \ Github
  • \ Package
  • \ Issues
  • \ Labels