JGithubIssues
Extends \JGithubObjectGitHub API Issues class for the Joomla Platform.
| package |
Joomla.Platform |
|---|---|
| subpackage |
GitHub |
| since |
11.3 |
Methods
__construct
Constructor.
__construct(\JRegistry &$options = null, \JGithubHttp $client = null)
create
Method to create an issue.
create(string $user, string $repo, string $title, string $body = null, string $assignee = null, integer $milestone = null, array $labels = null) : object
| since |
11.3 |
|---|
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
integerThe milestone to associate this issue with.- $labels
arrayThe labels to associate with this issue.
Response
object
createComment
Method to create a comment on an issue.
createComment(string $user, string $repo, integer $issueId, string $body) : object
| since |
11.3 |
|---|
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $issueId
integerThe issue number.- $body
stringThe comment body text.
Response
object
deleteComment
Method to delete a comment on an issue.
deleteComment(string $user, string $repo, integer $commentId) : void
| since |
11.3 |
|---|
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $commentId
integerThe id of the comment to delete.
edit
Method to update an issue.
edit(string $user, string $repo, integer $issueId, string $state = null, string $title = null, string $body = null, string $assignee = null, integer $milestone = null, array $labels = null) : object
| since |
11.3 |
|---|
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $issueId
integerThe 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
integerThe milestone to associate this issue with.- $labels
arrayThe labels to associate with this issue.
Response
object
editComment
Method to update a comment on an issue.
editComment(string $user, string $repo, integer $commentId, string $body) : object
| since |
11.3 |
|---|
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $commentId
integerThe id of the comment to update.- $body
stringThe new body text for the comment.
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, integer $page, integer $limit) : string
| since |
11.3 |
|---|
Arguments
- $path
stringURL to inflect- $page
integerPage to request- $limit
integerNumber of results to return per page
Response
stringThe request URL.
get
Method to get a single issue.
get(string $user, string $repo, integer $issueId) : object
| since |
11.3 |
|---|
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $issueId
integerThe issue number.
Response
object
getComment
Method to get a specific comment on an issue.
getComment(string $user, string $repo, integer $commentId) : object
| since |
11.3 |
|---|
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $commentId
integerThe comment id to get.
Response
object
getComments
Method to get the list of comments on an issue.
getComments(string $user, string $repo, integer $issueId, integer $page, integer $limit) : array
| since |
11.3 |
|---|
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $issueId
integerThe issue number.- $page
integerThe page number from which to get items.- $limit
integerThe number of items on a page.
Response
array
getList
Method to list an authenticated user's issues.
getList(string $filter = null, string $state = null, string $labels = null, string $sort = null, string $direction = null, \JDate $since = null, integer $page, integer $limit) : array
| since |
11.3 |
|---|
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
\JDateThe date/time since when issues should be returned.- $page
integerThe page number from which to get items.- $limit
integerThe number of items on a page.
Response
array
getListByRepository
Method to list issues.
getListByRepository(string $user, string $repo, string $milestone = null, string $state = null, string $assignee = null, string $mentioned = null, string $labels = null, string $sort = null, string $direction = null, \JDate $since = null, integer $page, integer $limit) : array
| since |
11.3 |
|---|
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
\JDateThe date/time since when issues should be returned.- $page
integerThe page number from which to get items.- $limit
integerThe number of items on a page.
Response
array
Properties
client
The HTTP client object to use in sending HTTP requests.