Class JGithub

Description

Joomla Platform class for interacting with a GitHub server instance.

  • since: 11.3

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


	
			
Variable Summary
Method Summary
JGithub __construct ([JRegistry $options = null], [JGithubHttp $client = null])
mixed getOption (string $key)
JGitHub setOption (string $key, mixed $value)
JGithubObject __get (string $name)
Variables
JGithubHttp $client (line 31)
  • var: The HTTP client object to use in sending HTTP requests.
  • since: 11.3
  • access: protected
JGithubForks $forks (line 61)
  • var: GitHub API object for forks.
  • since: 11.3
  • access: protected
JGithubGists $gists (line 37)
  • var: GitHub API object for gists.
  • since: 11.3
  • access: protected
JGithubIssues $issues (line 43)
  • var: GitHub API object for issues.
  • since: 11.3
  • access: protected
JRegistry $options (line 25)
  • var: Options for the GitHub object.
  • since: 11.3
  • access: protected
JGithubPulls $pulls (line 49)
  • var: GitHub API object for pulls.
  • since: 11.3
  • access: protected
JGithubRefs $refs (line 55)
  • var: GitHub API object for referencess.
  • since: 11.3
  • access: protected
Methods
Constructor __construct (line 71)

Constructor.

  • since: 11.3
  • access: public
JGithub __construct ([JRegistry $options = null], [JGithubHttp $client = null])
getOption (line 146)

Get an option from the JGitHub instance.

  • return: The option value.
  • since: 11.3
  • access: public
mixed getOption (string $key)
  • string $key: The name of the option to get.
setOption (line 161)

Set an option for the JGitHub instance.

  • return: This object for method chaining.
  • since: 11.3
  • access: public
JGitHub setOption (string $key, mixed $value)
  • string $key: The name of the option to set.
  • mixed $value: The option value to set.
__get (line 89)

Magic method to lazily create API objects

  • return: GitHub API object (gists, issues, pulls, etc).
  • since: 11.3
  • access: public
JGithubObject __get (string $name)
  • string $name: Name of property to retrieve

Documentation generated on Mon, 25 Jun 2012 13:55:04 -0500 by phpDocumentor 1.4.4