JGithub

Joomla Platform class for interacting with a GitHub server instance.

package

Joomla.Platform

subpackage

GitHub

since

11.3

Methods

__construct

Constructor.

__construct(\JRegistry $options = null, \JGithubHttp $client = null) 
since

11.3

Arguments

$options

\JRegistryGitHub options object.

$client

\JGithubHttpThe HTTP client object.

__get

Magic method to lazily create API objects

__get(string $name) : \JGithubObject
since

11.3

Arguments

$name

stringName of property to retrieve

Response

\JGithubObjectGitHub API object (gists, issues, pulls, etc).

getOption

Get an option from the JGitHub instance.

getOption(string $key) : mixed
since

11.3

Arguments

$key

stringThe name of the option to get.

Response

mixedThe option value.

setOption

Set an option for the JGitHub instance.

setOption(string $key, mixed $value) : \JGitHub
since

11.3

Arguments

$key

stringThe name of the option to set.

$value

mixedThe option value to set.

Response

\JGitHubThis object for method chaining.

Properties

options

Options for the GitHub object.

since

11.3

Type(s)

\JRegistry

client

The HTTP client object to use in sending HTTP requests.

since

11.3

Type(s)

\JGithubHttp

gists

GitHub API object for gists.

since

11.3

Type(s)

\JGithubGists

issues

GitHub API object for issues.

since

11.3

Type(s)

\JGithubIssues

pulls

GitHub API object for pulls.

since

11.3

Type(s)

\JGithubPulls

refs

GitHub API object for referencess.

since

11.3

Type(s)

\JGithubRefs

forks

GitHub API object for forks.

since

11.3

Type(s)

\JGithubForks