Class JGithubPackageRepositoriesStatistics

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.

JGithubObject

JGithubPackage

JGithubPackageRepositoriesStatistics

Package: Joomla\Platform\GitHub
Deprecated: 4.0 Use the joomla/github package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 3.3 (CMS)
Documentation: https://developer.github.com/v3/repos/statistics
Located at joomla/github/package/repositories/statistics.php

Methods summary

`public object`	# `getListContributors( string $owner, string $repo )` Get contributors list with additions, deletions, and commit counts. 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 Parameters `$owner` `string` - $owner The owner of the repository. `$repo` `string` - $repo The repository name. Returns `object` Since 1.0
`public object`	# `getActivityData( string $owner, string $repo )` Get the last year of commit activity data. 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. Parameters `$owner` `string` - $owner The owner of the repository. `$repo` `string` - $repo The repository name. Returns `object` Since 1.0
`public object`	# `getCodeFrequency( string $owner, string $repo )` Get the number of additions and deletions per week. 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. Parameters `$owner` `string` - $owner The owner of the repository. `$repo` `string` - $repo The repository name. Returns `object` Since 1.0
`public object`	# `getParticipation( string $owner, string $repo )` Get the weekly commit count for the repo owner and everyone else. 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. Parameters `$owner` `string` - $owner The owner of the repository. `$repo` `string` - $repo The repository name. Returns `object` Since 1.0
`public object`	# `getPunchCard( string $owner, string $repo )` Get the number of commits per hour in each day. 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. Parameters `$owner` `string` - $owner The owner of the repository. `$repo` `string` - $repo The repository name. Returns `object` Since 1.0
`protected mixed`	# `processResponse( JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true )` Process the response and decode it. Process the response and decode it. Parameters `$response` `JHttpResponse` - $response The response. `$expectedCode` `integer` - $expectedCode The expected "good" code. `$decode` `boolean` - $decode If the should be response be JSON decoded. Returns `mixed` Throws `DomainException` Since 1.0 Overrides `JGithubObject::processResponse`

Methods inherited from JGithubPackage

__get()

Methods inherited from JGithubObject

__construct(), fetchUrl()

Magic methods summary

Properties summary

Properties inherited from JGithubPackage

$name, $packages

Properties inherited from JGithubObject

$client, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithubPackageRepositoriesStatistics

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Overrides

Methods inherited from JGithubPackage

Methods inherited from JGithubObject

Magic methods summary

Properties summary

Properties inherited from JGithubPackage

Properties inherited from JGithubObject