Joomla! API

Download
Launch

JGithub

Joomla Platform class for interacting with a GitHub server instance.

deprecated
property-read

GitHub API object for activity.

GitHub API object for authorizations.

GitHub API object for data.

GitHub API object for gists.

GitHub API object for gitignore.

GitHub API object for issues.

GitHub API object for markdown.

GitHub API object for orgs.

GitHub API object for pulls.

GitHub API object for repositories.

GitHub API object for search.

GitHub API object for users.

Deprecated GitHub API object for references.

Deprecated GitHub API object for forks.

Deprecated GitHub API object for commits.

Deprecated GitHub API object for commits.

Deprecated GitHub API object for commits.

Deprecated GitHub API object for account references.

Deprecated GitHub API object for hooks.

Deprecated GitHub API object for meta.
since

1.7.3
deprecated

4.0 Use the joomla/github package via Composer instead
package

Joomla.Platform

Methods

__construct

Constructor.

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

1.7.3

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\JGithubHttpThe HTTP client object.

__get

Magic method to lazily create API objects

__get(string $name) : \JGithubObject
throws

\RuntimeException
since

1.7.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

1.7.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

1.7.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

1.7.3

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

since

1.7.3

Type(s)

\JGithubHttp

packages

List of known packages.

since

3.3

Type(s)

array

legacyPackages

List of known legacy packages.

since

3.3

Type(s)

array

activity

GitHub API object for activity.

Type(s)

\JGithubPackageActivity

authorization

GitHub API object for authorizations.

Type(s)

\JGithubPackageAuthorization

data

GitHub API object for data.

Type(s)

\JGithubPackageData

gists

GitHub API object for gists.

Type(s)

\JGithubPackageGists

gitignore

GitHub API object for gitignore.

Type(s)

\JGithubPackageGitignore

issues

GitHub API object for issues.

Type(s)

\JGithubPackageIssues

markdown

GitHub API object for markdown.

Type(s)

\JGithubPackageMarkdown

orgs

GitHub API object for orgs.

Type(s)

\JGithubPackageOrgs

pulls

GitHub API object for pulls.

Type(s)

\JGithubPackagePulls

repositories

GitHub API object for repositories.

Type(s)

\JGithubPackageRepositories

search

GitHub API object for search.

Type(s)

\JGithubPackageSearch

users

GitHub API object for users.

Type(s)

\JGithubPackageUsers

refs

Deprecated GitHub API object for references.

Type(s)

\JGithubRefs

forks

Deprecated GitHub API object for forks.

Type(s)

\JGithubForks

commits

Deprecated GitHub API object for commits.

Type(s)

\JGithubCommits

milestones

Deprecated GitHub API object for commits.

Type(s)

\JGithubMilestones

statuses

Deprecated GitHub API object for commits.

Type(s)

\JGithubStatuses

account

Deprecated GitHub API object for account references.

Type(s)

\JGithubAccount

hooks

Deprecated GitHub API object for hooks.

Type(s)

\JGithubHooks

meta

Deprecated GitHub API object for meta.

Type(s)

\JGithubMeta
  • \ \
  • \ JGithub