class JGithubRefs extends JGithubObject

GitHub API References class for the Joomla Platform.

Methods

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

Constructor.

object
create( string $user, string $repo, string $ref, string $sha)

Method to create an issue.

object
edit( string $user, string $repo, string $ref, string $sha, string $force = false)

Method to update a reference.

object
get( string $user, string $repo, string $ref)

Method to get a reference.

array
getList( string $user, string $repo, string $namespace = '', integer $page, integer $limit)

Method to list references for a repository.

Details

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

Constructor.

Parameters

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

object create( string $user, string $repo, string $ref, string $sha)

Method to create an issue.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $ref The name of the fully qualified reference.
string $sha The SHA1 value to set this reference to.

Return Value

object

object edit( string $user, string $repo, string $ref, string $sha, string $force = false)

Method to update a reference.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $ref The reference to update.
string $sha The SHA1 value to set the reference to.
string $force Whether the update should be forced. Default to false.

Return Value

object

object get( string $user, string $repo, string $ref)

Method to get a reference.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $ref The reference to get.

Return Value

object

array getList( string $user, string $repo, string $namespace = '', integer $page, integer $limit)

Method to list references for a repository.

Parameters

string $user The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $namespace Optional sub-namespace to limit the returned references.
integer $page Page to request
integer $limit Number of results to return per page

Return Value

array