Commits

Extends \Joomla\Github\AbstractPackage

GitHub API Repositories Commits class for the Joomla Framework.

link

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

since

1.0

Methods

__construct

Constructor.

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

1.0

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\Joomla\Http\HttpThe HTTP client object.

__get

Magic method to lazily create API objects

__get(string $name) : \Joomla\Github\AbstractPackage
inherited
since

1.0

throws

\InvalidArgumentException

Arguments

$name

stringName of property to retrieve

Response

\Joomla\Github\AbstractPackageGitHub API package object.

compare

Compare two commits.

compare(string $user, string $repo, string $base, string $head) : object
since

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

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

note

As of 2.0 this method will return a Joomla\Uri\Uri object

Arguments

$path

stringURL to inflect

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

stringThe request URL.

get

Get a single commit.

get(string $user, string $repo, string $sha) : object
since

1.0

throws

\DomainException

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

object

getList

List commits on a repository.

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

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.

since

1.0

throws

\DomainException

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

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

$until

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

Response

object

getSha

Get the SHA-1 of a commit reference.

getSha(string $user, string $repo, string $ref) : string
since

1.4.0

throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

$user

stringThe name of the owner of the GitHub repository.

$repo

stringThe name of the GitHub repository.

$ref

stringThe commit reference

Response

string

processResponse

Process the response and decode it.

processResponse(\Joomla\Http\Response $response, integer $expectedCode = 200) : mixed
inherited
since

1.0

throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

$response

\Joomla\Http\ResponseThe response.

$expectedCode

integerThe expected "good" code.

Response

mixed

Properties

options

Options for the GitHub object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Github\Http

package

The package the object resides in

inherited
since

1.0

Type(s)

string

hookEvents

Array containing the allowed hook events

inherited
since

1.5.2

link

https://developer.github.com/webhooks/#events

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