JGithubPackageRepositoriesComments
Extends \JGithubPackageGitHub API Repositories Comments class for the Joomla Platform.
| documentation | |
|---|---|
| since |
1.7.3 |
| 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 a commit.
create(string $user, string $repo, string $sha, string $comment, integer $line, string $filepath, integer $position) : object
| since |
3.0.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
integerThe line number of the commit to comment on.- $filepath
stringA relative path to the file to comment on within the commit.- $position
integerLine index in the diff to comment on.
Response
object
delete
Method to delete a comment on a commit.
delete(string $user, string $repo, string $id) : object
| since |
3.0.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
Method to edit a comment on a commit.
edit(string $user, string $repo, string $id, string $comment) : object
| since |
3.0.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, 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 on a commit.
get(string $user, string $repo, integer $id) : array
| since |
3.0.0 |
|---|
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $id
integerID of the comment to retrieve
Response
array
getList
Method to get a list of comments for a single commit for a repository.
getList(string $user, string $repo, string $sha, integer $page, integer $limit) : array
| since |
3.0.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
integerPage to request- $limit
integerNumber of results to return per page
Response
array
getListRepository
Method to get a list of commit comments for a repository.
getListRepository(string $user, string $repo, integer $page, integer $limit) : array
| since |
3.0.0 |
|---|
Arguments
- $user
stringThe name of the owner of the GitHub repository.- $repo
stringThe name of the GitHub repository.- $page
integerPage to request- $limit
integerNumber of results to return per page
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.