JGithubPackageIssuesComments
Extends \JGithubPackageGitHub API Comments class for the Joomla Platform.
The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.
| documentation | |
|---|---|
| since |
3.1.4 |
| deprecated |
4.0 Use the |
| package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null)
| since |
1.7.3 |
|---|
Arguments
- $options
\Joomla\Registry\RegistryGitHub options object.- $client
\JGithubHttpThe HTTP client object.
__get
Magic method to lazily create API objects
__get(string $name) : \JGithubPackage
| since |
3.3 |
|---|---|
| throws |
|
Arguments
- $name
stringName of property to retrieve
Response
\JGithubPackageGitHub API package object.
create
Method to create a comment on an issue.
create(string $user, string $repo, integer $issueId, string $body) : object
| throws |
|
|---|---|
| since |
1.7.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
delete
Method to delete a comment on an issue.
delete(string $user, string $repo, integer $commentId) : boolean
| throws |
|
|---|---|
| since |
1.7.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.
Response
boolean
edit
Method to update a comment on an issue.
edit(string $user, string $repo, integer $commentId, string $body) : object
| since |
1.7.3 |
|---|---|
| throws |
|
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 |
1.7.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 comment.
get(string $owner, string $repo, integer $id) : mixed
Arguments
- $owner
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $id
integerThe comment id.
Response
mixed
getList
Method to get the list of comments on an issue.
getList(string $owner, string $repo, integer $issueId, integer $page, integer $limit) : array
| throws |
|
|---|---|
| since |
1.7.3 |
Arguments
- $owner
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
getRepositoryList
Method to get the list of comments in a repository.
getRepositoryList(string $owner, string $repo, string $sort = 'created', string $direction = 'asc', \JDate $since = null) : array
| throws |
|
|---|---|
| since |
1.7.3 |
Arguments
- $owner
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $sort
stringThe sort field - created or updated.- $direction
stringThe sort order- asc or desc. Ignored without sort parameter.- $since
\JDateA timestamp in ISO 8601 format.
Response
array
processResponse
Process the response and decode it.
processResponse(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
| throws |
|
|---|---|
| since |
3.3.0 |
Arguments
- $response
\JHttpResponseThe response.- $expectedCode
integerThe expected "good" code.- $decode
booleanIf the should be response be JSON decoded.
Response
mixed
Properties
name
| since |
3.3 |
|---|
Type(s)
string
packages
| since |
3.3 |
|---|
Type(s)
array
client
The HTTP client object to use in sending HTTP requests.