Class JGithubStatuses

Description
Description | Vars | Methods (details)

GitHub API References class for the Joomla Platform.

  • since: 12.3

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

JGithubObject
   |
   --JGithubStatuses
Method Summary
Description | Vars | Methods (details)
object create (string $user, string $repo, string $sha, string $state, [string $targetUrl = null], [string $description = null])
array getList (string $user, string $repo, string $sha)
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JGithubObject

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

Method to create a status.

  • since: 12.3
  • access: public
object create (string $user, string $repo, string $sha, string $state, [string $targetUrl = null], [string $description = null])
  • 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.
getList (line 85)

Method to list statuses for an SHA.

  • since: 12.3
  • access: public
array getList (string $user, string $repo, string $sha)
  • 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.

Inherited Methods

Inherited From JGithubObject

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

Documentation generated on Tue, 19 Nov 2013 15:14:21 +0100 by phpDocumentor 1.4.3