JGithub

class JGithub

Joomla Platform class for interacting with a GitHub server instance.

Methods

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

Constructor.

JGithubObject
__get( string $name)

Magic method to lazily create API objects

mixed
getOption( string $key)

Get an option from the JGitHub instance.

JGitHub
setOption( string $key, mixed $value)

Set an option for the JGitHub instance.

Details

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

Constructor.

Parameters

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

JGithubObject __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JGithubObject GitHub API object (gists, issues, pulls, etc).

Exceptions

RuntimeException

mixed getOption( string $key)

Get an option from the JGitHub instance.

Parameters

string $key The name of the option to get.

Return Value

mixed The option value.

JGitHub setOption( string $key, mixed $value)

Set an option for the JGitHub instance.

Parameters

string $key The name of the option to set.
mixed $value The option value to set.

Return Value

JGitHub This object for method chaining.