Class JGithubRefs

Description
Description | Vars | Methods (details)

GitHub API References class for the Joomla Platform.

  • since: 11.3

Located in /libraries/joomla/github/refs.php (line 19) 

JGithubObject
   |
   --JGithubRefs
Method Summary
Description | Vars | Methods (details)
object create (string $user, string $repo, string $ref, string $sha)
object edit (string $user, string $repo, string $ref, string $sha, [string $force = false])
object get (string $user, string $repo, string $ref)
array getList (string $user, string $repo, [string $namespace = ''], [integer $page = 0], [integer $limit = 0])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JGithubObject

JGithubObject::$client
 JGithubObject::$options
Methods
Description | Vars Methods (details)
create (line 33)

Method to create an issue.

  • since: 11.3
  • access: public
object create (string $user, string $repo, string $ref, string $sha)
  • 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.
edit (line 73)

Method to update a reference.

  • since: 11.3
  • access: public
object edit (string $user, string $repo, string $ref, string $sha, [string $force = false])
  • 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.
get (line 117)

Method to get a reference.

  • since: 11.3
  • access: public
object get (string $user, string $repo, string $ref)
  • 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.
getList (line 149)

Method to list references for a repository.

  • since: 11.3
  • access: public
array getList (string $user, string $repo, [string $namespace = ''], [integer $page = 0], [integer $limit = 0])
  • 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

Inherited Methods

Inherited From JGithubObject

JGithubObject::__construct()
JGithubObject::fetchUrl()
JGithubObject::processResponse()

Documentation generated on Tue, 19 Nov 2013 15:11:39 +0100 by phpDocumentor 1.4.3