Référence de la classe JGithubPackageRepositoriesStatistics

Graphe d'héritage de JGithubPackageRepositoriesStatistics:

Fonctions membres publiques
	getListContributors ($owner, $repo)
	getActivityData ($owner, $repo)
	getCodeFrequency ($owner, $repo)
	getParticipation ($owner, $repo)
	getPunchCard ($owner, $repo)
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)

Fonctions membres protégées
	processResponse (JHttpResponse $response, $expectedCode=200, $decode=true)
Fonctions membres protégées hérités de JGithubObject
	fetchUrl ($path, $page=0, $limit=0)
	processResponse (JHttpResponse $response, $expectedCode=200, $decode=true)

Membres hérités additionnels
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 class for the Joomla Platform.

The Repository Statistics API allows you to fetch the data that GitHub uses for visualizing different types of repository activity.

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

Depuis

3.3 (CMS)

Obsolète:

4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

getActivityData()

getActivityData	(		$owner,
			$repo
	)

Get the last year of commit activity data.

Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.

Paramètres

string	$owner	The owner of the repository.
string	$repo	The repository name.

Depuis

1.0

Renvoie

object

Références $path.

getCodeFrequency()

getCodeFrequency	(		$owner,
			$repo
	)

Get the number of additions and deletions per week.

Response returns a weekly aggregate of the number of additions and deletions pushed to a repository.

Paramètres

string	$owner	The owner of the repository.
string	$repo	The repository name.

Depuis

1.0

Renvoie

object

Références $path.

getListContributors()

getListContributors	(		$owner,
			$repo
	)

Get contributors list with additions, deletions, and commit counts.

Response include: total - The Total number of commits authored by the contributor.

Weekly Hash

w - Start of the week a - Number of additions d - Number of deletions c - Number of commits

Paramètres

string	$owner	The owner of the repository.
string	$repo	The repository name.

Depuis

1.0

Renvoie

object

Références $path.

getParticipation()

getParticipation	(		$owner,
			$repo
	)

Get the weekly commit count for the repo owner and everyone else.

Returns the total commit counts for the "owner" and total commit counts in "all". "all" is everyone combined, including the owner in the last 52 weeks. If you’d like to get the commit counts for non-owners, you can subtract all from owner.

The array order is oldest week (index 0) to most recent week.

Paramètres

string	$owner	The owner of the repository.
string	$repo	The repository name.

Depuis

1.0

Renvoie

object

Références $path.

getPunchCard()

getPunchCard	(		$owner,
			$repo
	)

Get the number of commits per hour in each day.

Response Each array contains the day number, hour number, and number of commits:

0-6: Sunday - Saturday 0-23: Hour of day Number of commits

For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

Paramètres

string	$owner	The owner of the repository.
string	$repo	The repository name.

Depuis

1.0

Renvoie

object

Références $path.

processResponse()

processResponse ( JHttpResponse  $response,   $expectedCode = 200,   $decode = true  )

protected

Process the response and decode it.

Paramètres

JHttpResponse	$response	The response.
integer	$expectedCode	The expected "good" code.
boolean	$decode	If the should be response be JSON decoded.

Renvoie

mixed

Depuis

1.0

Exceptions

---

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

• libraries/joomla/github/package/repositories/statistics.php