Docs For Class JGithub

JGithub

Description

Joomla Platform class for interacting with a GitHub server instance.

property-read: JGithubGists $gists: GitHub API object for gists.
property-read: JGithubIssues $issues: GitHub API object for issues.
property-read: JGithubPulls $pulls: GitHub API object for pulls.
property-read: JGithubRefs $refs: GitHub API object for referencess.
property-read: JGithubForks $forks: GitHub API object for forks.
property-read: JGithubCommits $commits: GitHub API object for commits.
property-read: JGithubMilestones $milestones: GitHub API object for commits.
property-read: JGithubStatuses $statuses: GitHub API object for commits.
property-read: JGithubAccount $account: GitHub API object for account references.
property-read: JGithubHooks $hooks: GitHub API object for hooks.
property-read: JGithubUsers $users: GitHub API object for users.
property-read: JGithubMeta $meta: GitHub API object for meta.
since: 11.3

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

Variable Summary

JGithubAccount $account

JGithubHttp $client

JGithubCommits $commits

JGithubForks $forks

JGithubGists $gists

JGithubHooks $hooks

JGithubIssues $issues

JGithubMeta $meta

JGithubMilestones $milestones

JRegistry $options

JGithubPulls $pulls

JGithubRefs $refs

JGithubStatuses $statuses

JGithubUsers $users

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

JGithubAccount $account (line 98)

var: GitHub API object for account references.
since: 12.3
access: protected

JGithubHttp $client (line 44)

var: The HTTP client object to use in sending HTTP requests.
since: 11.3
access: protected

JGithubCommits $commits (line 80)

var: GitHub API object for commits.
since: 12.1
access: protected

JGithubForks $forks (line 74)

var: GitHub API object for forks.
since: 11.3
access: protected

JGithubGists $gists (line 50)

var: GitHub API object for gists.
since: 11.3
access: protected

JGithubHooks $hooks (line 104)

var: GitHub API object for hooks.
since: 12.3
access: protected

JGithubIssues $issues (line 56)

var: GitHub API object for issues.
since: 11.3
access: protected

JGithubMeta $meta (line 116)

var: GitHub API object for meta.
since: 13.1
access: protected

JGithubMilestones $milestones (line 86)

var: GitHub API object for milestones.
since: 12.3
access: protected

JRegistry $options (line 38)

var: Options for the GitHub object.
since: 11.3
access: protected

JGithubPulls $pulls (line 62)

var: GitHub API object for pulls.
since: 11.3
access: protected

JGithubRefs $refs (line 68)

var: GitHub API object for referencess.
since: 11.3
access: protected

JGithubStatuses $statuses (line 92)

var: GitHub API object for statuses.
since: 12.3
access: protected

JGithubUsers $users (line 110)

var: GitHub API object for users.
since: 12.4
access: protected

Methods

Constructor __construct (line 126)

Constructor.

since: 11.3
access: public

JGithub __construct ([JRegistry $options = null], [JGithubHttp $client = null])

JRegistry $options: GitHub options object.
JGithubHttp $client: The HTTP client object.

getOption (line 171)

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 186)

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 145)

Magic method to lazily create API objects

return: GitHub API object (gists, issues, pulls, etc).
since: 11.3
throws: InvalidArgumentException
access: public

JGithubObject __get (string $name)

string $name: Name of property to retrieve

Documentation generated on Tue, 19 Nov 2013 15:04:00 +0100 by phpDocumentor 1.4.3