Labels
Extends AbstractPackageGitHub 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
since |
1.0 |
---|
Arguments
- options
\Joomla\Registry\Registry
GitHub options object.- client
\Joomla\Http\Http
The HTTP client object.
Response
mixed
__get
Magic method to lazily create API objects
__get(string name) : \Joomla\Github\AbstractPackage
since |
1.0 |
---|---|
throws |
|
Arguments
- name
string
Name of property to retrieve
Response
\Joomla\Github\AbstractPackage
GitHub API package object.
add
Add labels to an issue.
add(string owner, string repo, string number, array labels) : object
since |
1.0 |
---|
Arguments
- owner
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- number
string
The issue number.- labels
array
An 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 |
|
Arguments
- owner
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- name
string
The label name.- color
string
The label color.
Response
object
delete
Delete a label.
delete(string owner, string repo, string name) : object
since |
1.0 |
---|
Arguments
- owner
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- name
string
The 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
since |
1.0 |
---|
Arguments
- path
string
URL to inflect- page
int
Page to request- limit
int
Number 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
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- name
string
The label name to get.
Response
object
getList
List all labels for this repository.
getList(string owner, string repo) : array
since |
1.0 |
---|
Arguments
- owner
string
The name of the owner of the GitHub repository.- repo
string
The 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
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- number
int
The 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
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- number
string
The issue number.
Response
object
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
since |
1.0 |
---|---|
throws |
|
Arguments
- response
\Joomla\Http\Response
The response.- expectedCode
int
The 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
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- number
string
The 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
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- number
string
The issue number.- name
string
The 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
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- number
string
The issue number.- labels
array
New labels
Response
object
update
Update a label.
update(string user, string repo, string label, string name, string color) : object
since |
1.0 |
---|
Arguments
- user
string
The name of the owner of the GitHub repository.- repo
string
The name of the GitHub repository.- label
string
The label name.- name
string
The new label name.- color
string
The new label color.
Response
object
Properties
options
Options for the GitHub object.
since |
1.0 |
---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
since |
1.0 |
---|
Type(s)
\Joomla\Http\Http
package
The package the object resides in
since |
1.0 |
---|
Type(s)
string
hookEvents
Array containing the allowed hook events
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