Joomla! API

Download
Launch

JGithubPackageRepositoriesCommits

Extends \JGithubPackage

GitHub API Repositories Commits class for the Joomla Platform.

deprecated
documentation

https://developer.github.com/v3/repos/commits
since

1.7.3
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.

__get

Magic method to lazily create API objects

__get(string $name) : \JGithubPackage
inherited
since

3.3
throws

\RuntimeException

Arguments

$name

stringName of property to retrieve

Response

\JGithubPackageGitHub API package object.

compare

Method to get a diff for two commits.

compare(string $user, string $repo, string $base, string $head) : array
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

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.

get

Method to get a single commit for a repository.

get(string $user, string $repo, string $sha) : array
throws

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

Response

array

getList

Method to list commits for a repository.

getList(string $user, string $repo, string $sha = '', string $path = '', string $author = '', \JDate $since = null, \JDate $until = null) : array

A special note on pagination: Due to the way Git works, commits are paginated based on SHA instead of page number. Please follow the link headers as outlined in the pagination overview instead of constructing page links yourself.

throws

\DomainException
since

3.0.0

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$sha

stringSha or branch to start listing commits from.

$path

stringOnly commits containing this file path will be returned.

$author

stringGitHub login, name, or email by which to filter by commit author.

$since

\JDateISO 8601 Date - Only commits after this date will be returned.

$until

\JDateISO 8601 Date - Only commits before this date will be returned.

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

name

inherited
since

3.3

Type(s)

string

packages

inherited
since

3.3

Type(s)

array

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
  • \ \
  • \ JGithubPackageRepositoriesCommits