Issues
Extends AbstractPackageGitHub API Issues class for the Joomla Framework.
| link | |
|---|---|
| since |
1.0 |
| property-read Assignees |
GitHub API object for assignees. GitHub API object for comments. GitHub API object for events. GitHub API object for labels. GitHub API object for milestones. |
| package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
Magic method to lazily create API objects
__get( name) : \Joomla\Github\AbstractPackage
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- name
stringName of property to retrieve
Response
AbstractPackageGitHub API package object.
create
Create an issue.
create( user, repo, title, body = null, assignee = null, milestone = null, string||string|int labels = [], string||string|int assignees = []) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- title
stringThe title of the new issue.- body
stringThe body text for the new issue.- assignee
stringThe login for the GitHub user that this issue should be assigned to.- milestone
intThe milestone to associate this issue with.- labels
array<string|int, string>The labels to associate with this issue.- assignees
array<string|int, string>The logins for GitHub users to assign to this issue.
Response
object
edit
Edit an issue.
edit( user, repo, issueId, state = null, title = null, body = null, assignee = null, milestone = null, mixed||string|int labels = []) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- issueId
intThe issue number.- state
stringThe optional new state for the issue. [open, closed]- title
stringThe title of the new issue.- body
stringThe body text for the new issue.- assignee
stringThe login for the GitHub user that this issue should be assigned to.- milestone
intThe milestone to associate this issue with.- labels
array<string|int, mixed>The labels to associate with this issue.
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( path, page, limit) : \Joomla\Uri\Uri
| since |
1.0 |
|---|
Arguments
- path
stringURL to inflect- page
intPage to request- limit
intNumber of results to return per page
Response
get
Get a single issue.
get( user, repo, issueId) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- issueId
intThe issue number.
Response
object
getList
List issues.
getList( filter = null, state = null, labels = null, sort = null, direction = null, \DateTimeInterface since = null, page, limit) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- filter
stringThe filter type: assigned, created, mentioned, subscribed.- state
stringThe optional state to filter requests by. [open, closed]- labels
stringThe list of comma separated Label names. Example: bug,ui,@high.- sort
stringThe sort order: created, updated, comments, default: created.- direction
stringThe list direction: asc or desc, default: desc.- since
DateTimeInterface|nullOnly issues updated at or after this time are returned.- page
intThe page number from which to get items.- limit
intThe number of items on a page.
Response
object
getListByRepository
List issues for a repository.
getListByRepository( user, repo, milestone = null, state = null, assignee = null, mentioned = null, labels = null, sort = null, direction = null, \DateTimeInterface since = null, page, limit) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- milestone
stringThe milestone number, 'none', or *.- state
stringThe optional state to filter requests by. [open, closed]- assignee
stringThe assignee name, 'none', or *.- mentioned
stringThe GitHub user name.- labels
stringThe list of comma separated Label names. Example: bug,ui,@high.- sort
stringThe sort order: created, updated, comments, default: created.- direction
stringThe list direction: asc or desc, default: desc.- since
DateTimeInterface|nullOnly issues updated at or after this time are returned.- page
intThe page number from which to get items.- limit
intThe number of items on a page.
Response
object
lock
Lock an issue.
lock( user, repo, issueId) :
| since |
1.4.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- issueId
intThe issue number.
Response
object
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- response
ResponseThe response.- expectedCode
intThe expected "good" code.
Response
mixed
unlock
Unlock an issue.
unlock( user, repo, issueId) :
| since |
1.4.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- issueId
intThe issue number.
Response
object
Properties
assignees
comments
events
labels
milestones
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<string|int, mixed>