Joomla! API

Download
Launch

JGithubCommits

Extends \JGithubObject

GitHub API Commits class for the Joomla Platform.

deprecated
since

3.0.0
deprecated

4.0 Use the joomla/github package via Composer instead
package

Joomla.Platform

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null)
inherited
since

1.7.3

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\JGithubHttpThe HTTP client object.

create

Method to create a commit.

create(string $user, string $repo, string $message, string $tree, array $parents = array()) : object
deprecated
deprecated

use data->commits->create()
since

3.0.0

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$message

stringThe commit message.

$tree

stringSHA of the tree object this commit points to.

$parents

arrayArray 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
deprecated

use repositories->comments->create()
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

deleteCommitComment

Method to delete a comment on a commit.

deleteCommitComment(string $user, string $repo, string $id) : object
deprecated
deprecated

use repositories->comments->delete()
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

editCommitComment

Method to edit a comment on a commit.

editCommitComment(string $user, string $repo, string $id, string $comment) : object
deprecated
deprecated

use repositories->comments->edit()
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
inherited
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.

getCommit

Method to get a single commit for a repository.

getCommit(string $user, string $repo, string $sha, integer $page, integer $limit) : array
deprecated
deprecated

use repositories->commits->get()
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

getCommitComment

Method to get a single comment on a commit.

getCommitComment(string $user, string $repo, integer $id) : array
deprecated
deprecated

use repositories->comments->get()
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

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
deprecated

use repositories->comments->getList()
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

getDiff

Method to get a diff for two commits.

getDiff(string $user, string $repo, string $base, string $head) : array
deprecated
deprecated

use repositories->commits->compare()
since

3.0.0

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$base

stringThe base of the diff, either a commit SHA or branch.

$head

stringThe 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
deprecated

use repositories->commits->getList()
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

getListComments

Method to get a list of commit comments for a repository.

getListComments(string $user, string $repo, integer $page, integer $limit) : array
deprecated
deprecated

use repositories->comments->getListRepository()
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
inherited
throws

\DomainException
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

options

Options for the GitHub object.

inherited
since

1.7.3

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.7.3

Type(s)

\JGithubHttp
  • \ \
  • \ JGithubCommits