Comments
Extends AbstractPackageGitHub API Repositories Comments class for the Joomla Framework.
| link | |
|---|---|
| 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\RegistryGitHub options object.- client
\Joomla\Http\HttpThe 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
stringName of property to retrieve
Response
\Joomla\Github\AbstractPackageGitHub API package object.
create
Create a commit comment.
create(string user, string repo, string sha, string comment, int line, string filepath, int position) : object
| since |
1.0 |
|---|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- sha
stringThe SHA of the commit to comment on.- comment
stringThe text of the comment.- line
intThe line number of the commit to comment on.- filepath
stringA relative path to the file to comment on within the commit.- position
intLine index in the diff to comment on.
Response
object
delete
Delete a commit comment.
delete(string user, string repo, string id) : object
| since |
1.0 |
|---|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- id
stringThe ID of the comment to edit.
Response
object
edit
Update a commit comment.
edit(string user, string repo, string id, string comment) : object
| since |
1.0 |
|---|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- id
stringThe ID of the comment to edit.- comment
stringThe text of 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, int page, int 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
\Joomla\Uri\Uri
get
Get a single commit comment.
get(string user, string repo, int id) : array
| since |
1.0 |
|---|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- id
intID of the comment to retrieve
Response
array
getList
List comments for a single commit.
getList(string user, string repo, string sha, int page, int limit) : array
| since |
1.0 |
|---|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- sha
stringThe SHA of the commit to retrieve.- page
intPage to request- limit
intNumber of results to return per page
Response
array
getListRepository
List commit comments for a repository.
getListRepository(string user, string repo, int page, int limit) : array
| since |
1.0 |
|---|
Arguments
- user
stringThe name of the owner of the GitHub repository.- repo
stringThe name of the GitHub repository.- page
intPage to request- limit
intNumber of results to return per page
Response
array
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- response
\Joomla\Http\ResponseThe response.- expectedCode
intThe expected "good" code.
Response
mixed
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