Comments
Extends AbstractPackageGitHub API Comments class for the Joomla Framework.
The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.
| link | |
|---|---|
| since |
1.0 |
| 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 a comment.
create( user, repo, issueId, body) :
| 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.- body
stringThe comment body text.
Response
object
delete
Delete a comment.
delete( user, repo, commentId) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- commentId
intThe id of the comment to delete.
Response
bool
edit
Edit a comment.
edit( user, repo, commentId, body) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- commentId
intThe 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( 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 comment.
get( owner, repo, id) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- owner
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- id
intThe comment id.
Response
object
getList
List comments on an issue.
getList( owner, repo, issueId, page, limit, \DateTimeInterface since = null) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- owner
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- issueId
intThe issue number.- page
intThe page number from which to get items.- limit
intThe number of items on a page.- since
DateTimeInterface|nullOnly comments updated at or after this time are returned.
Response
object
getRepositoryList
List comments in a repository.
getRepositoryList( owner, repo, sort = 'created', direction = 'asc', \DateTimeInterface since = null) :
| since |
1.0 |
|---|---|
| throws |
|
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
DateTimeInterface|nullOnly comments updated at or after this time are returned.
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
Properties
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>