Référence de la classe JGithubPackageRepositoriesCommits

Graphe d'héritage de JGithubPackageRepositoriesCommits:

Fonctions membres publiques
	getList ($user, $repo, $sha='', $path='', $author='', JDate $since=null, JDate $until=null)
	get ($user, $repo, $sha)
	compare ($user, $repo, $base, $head)
Fonctions membres publiques hérités de JGithubPackage
	__get ($name)
Fonctions membres publiques hérités de JGithubObject
	__construct (Registry $options=null, JGithubHttp $client=null)

Membres hérités additionnels
Fonctions membres protégées hérités de JGithubObject
	fetchUrl ($path, $page=0, $limit=0)
	processResponse (JHttpResponse $response, $expectedCode=200, $decode=true)
Attributs protégés hérités de JGithubPackage
	$name = ''
	$packages = array()
Attributs protégés hérités de JGithubObject
	$options
	$client

Description détaillée

GitHub API Repositories Commits class for the Joomla Platform.

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

Depuis

1.7.3

Obsolète:

4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

compare()

compare	(		$user,
			$repo,
			$base,
			$head
	)

Method to get a diff for two commits.

Paramètres

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$base	The base of the diff, either a commit SHA or branch.
string	$head	The head of the diff, either a commit SHA or branch.

Renvoie

array

Depuis

3.0.0

Références $base, $path, et $user.

get()

get	(		$user,
			$repo,
			$sha
	)

Method to get a single commit for a repository.

Paramètres

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$sha	The SHA of the commit to retrieve.

Exceptions

DomainException

Depuis

3.0.0

Renvoie

array

Références $path, et $user.

getList()

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

Method to list commits for a repository.

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.

Paramètres

string	$user	The name of the owner of the GitHub repository.
string	$repo	The name of the GitHub repository.
string	$sha	Sha or branch to start listing commits from.
string	$path	Only commits containing this file path will be returned.
string	$author	GitHub login, name, or email by which to filter by commit author.
JDate	$since	ISO 8601 Date - Only commits after this date will be returned.
JDate	$until	ISO 8601 Date - Only commits before this date will be returned.

Exceptions

DomainException

Depuis

3.0.0

Renvoie

array

Références $author, $path, et $user.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• package/repositories/commits.php