JGithubCommits
Extends \JGithubObjectGitHub API Commits class for the Joomla Platform.
since |
3.0.0 |
---|---|
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\Registry
GitHub options object.- $client
\JGithubHttp
The HTTP client object.
create
Method to create a commit.
create(string $user, string $repo, string $message, string $tree, array $parents = array()) : object
deprecated |
use data->commits->create() |
---|---|
since |
3.0.0 |
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $message
string
The commit message.- $tree
string
SHA of the tree object this commit points to.- $parents
array
Array of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided. For a merge commit, an array of more than one should be provided.
Response
object
createCommitComment
Method to create a comment on a commit.
createCommitComment(string $user, string $repo, string $sha, string $comment, integer $line, string $filepath, integer $position) : object
deprecated |
use repositories->comments->create() |
---|---|
since |
3.0.0 |
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $sha
string
The SHA of the commit to comment on.- $comment
string
The text of the comment.- $line
integer
The line number of the commit to comment on.- $filepath
string
A relative path to the file to comment on within the commit.- $position
integer
Line index in the diff to comment on.
Response
object
deleteCommitComment
Method to delete a comment on a commit.
deleteCommitComment(string $user, string $repo, string $id) : object
deprecated |
use repositories->comments->delete() |
---|---|
since |
3.0.0 |
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $id
string
The ID of the comment to edit.
Response
object
editCommitComment
Method to edit a comment on a commit.
editCommitComment(string $user, string $repo, string $id, string $comment) : object
deprecated |
use repositories->comments->edit() |
---|---|
since |
3.0.0 |
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $id
string
The ID of the comment to edit.- $comment
string
The 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
string
URL to inflect- $page
integer
Page to request- $limit
integer
Number of results to return per page
Response
string
The request URL.
getCommit
Method to get a single commit for a repository.
getCommit(string $user, string $repo, string $sha, integer $page, integer $limit) : array
deprecated |
use repositories->commits->get() |
---|---|
since |
3.0.0 |
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $sha
string
The SHA of the commit to retrieve.- $page
integer
Page to request- $limit
integer
Number of results to return per page
Response
array
getCommitComment
Method to get a single comment on a commit.
getCommitComment(string $user, string $repo, integer $id) : array
deprecated |
use repositories->comments->get() |
---|---|
since |
3.0.0 |
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $id
integer
ID of the comment to retrieve
Response
array
getCommitComments
Method to get a list of comments for a single commit for a repository.
getCommitComments(string $user, string $repo, string $sha, integer $page, integer $limit) : array
deprecated |
use repositories->comments->getList() |
---|---|
since |
3.0.0 |
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $sha
string
The SHA of the commit to retrieve.- $page
integer
Page to request- $limit
integer
Number of results to return per page
Response
array
getDiff
Method to get a diff for two commits.
getDiff(string $user, string $repo, string $base, string $head) : array
deprecated |
use repositories->commits->compare() |
---|---|
since |
3.0.0 |
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $base
string
The base of the diff, either a commit SHA or branch.- $head
string
The head of the diff, either a commit SHA or branch.
Response
array
getList
Method to list commits for a repository.
getList(string $user, string $repo, integer $page, integer $limit) : array
deprecated |
use repositories->commits->getList() |
---|---|
since |
3.0.0 |
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $page
integer
Page to request- $limit
integer
Number of results to return per page
Response
array
getListComments
Method to get a list of commit comments for a repository.
getListComments(string $user, string $repo, integer $page, integer $limit) : array
deprecated |
use repositories->comments->getListRepository() |
---|---|
since |
3.0.0 |
Arguments
- $user
string
The name of the owner of the GitHub repository.- $repo
string
The name of the GitHub repository.- $page
integer
Page to request- $limit
integer
Number 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
\JHttpResponse
The response.- $expectedCode
integer
The expected "good" code.- $decode
boolean
If the should be response be JSON decoded.
Response
mixed
Properties
client
The HTTP client object to use in sending HTTP requests.