class JGithubPackageRepositoriesStatuses extends JGithubPackage

GitHub API References class for the Joomla Platform.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

__get( string $name)

Magic method to lazily create API objects

object
create( string $user, string $repo, string $sha, string $state, string $targetUrl = null, string $description = null)

Method to create a status.

array
getList( string $user, string $repo, string $sha)

Method to list statuses for an SHA.

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

JGithubPackage __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JGithubPackage GitHub API package object.

Exceptions

RuntimeException

object create( string $user, string $repo, string $sha, string $state, string $targetUrl = null, string $description = null)

Method to create a status.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $sha The SHA1 value for which to set the status.
string $state The state (pending, success, error or failure).
string $targetUrl Optional target URL.
string $description Optional description for the status.

Return Value

object

Exceptions

InvalidArgumentException
DomainException

array getList( string $user, string $repo, string $sha)

Method to list statuses for an SHA.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $sha SHA1 for which to get the statuses.

Return Value

array