JGithub
Joomla Platform class for interacting with a GitHub server instance.
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 |
package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null)
since |
1.7.3 |
---|
Arguments
- $options
\Joomla\Registry\Registry
GitHub options object.- $client
\JGithubHttp
The HTTP client object.
__get
Magic method to lazily create API objects
__get(string $name) : \JGithubObject
throws |
|
---|---|
since |
1.7.3 |
Arguments
- $name
string
Name of property to retrieve
Response
\JGithubObject
GitHub API object (gists, issues, pulls, etc).
getOption
Get an option from the JGitHub instance.
getOption(string $key) : mixed
since |
1.7.3 |
---|
Arguments
- $key
string
The name of the option to get.
Response
mixed
The option value.
setOption
Set an option for the JGitHub instance.
setOption(string $key, mixed $value) : \JGitHub
since |
1.7.3 |
---|
Arguments
- $key
string
The name of the option to set.- $value
mixed
The option value to set.
Response
\JGitHub
This object for method chaining.
Properties
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