Github
Joomla Framework class for interacting with a GitHub server instance.
| property-read Activity |
GitHub API object for the activity package. GitHub API object for the authorizations package. GitHub API object for the data package. GitHub API object for the emojis package. GitHub API object for the gists package. GitHub API object for the gitignore package. GitHub API object for the GraphQL v4 API. GitHub API object for the issues package. GitHub API object for the markdown package. GitHub API object for the meta package. GitHub API object for the orgs package. GitHub API object for the pulls package. GitHub API object for the repositories package. GitHub API object for the search package. GitHub API object for the users package. GitHub API object for the zen package. |
|---|---|
| since |
1.0 |
| package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) : mixed
| since |
1.0 |
|---|
Arguments
- options
\Joomla\Registry\RegistryGitHub options object.- client
\Joomla\Http\HttpThe HTTP client object.
Response
mixed
__get
Magic method to lazily create API objects
__get(string name) : \Joomla\Github\AbstractGithubObject
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- name
stringName of property to retrieve
Response
\Joomla\Github\AbstractGithubObjectGitHub API object (gists, issues, pulls, etc).
getOption
Get an option from the GitHub instance.
getOption(string key) : mixed
| since |
1.0 |
|---|
Arguments
- key
stringThe name of the option to get.
Response
mixedThe option value.
setOption
Set an option for the GitHub instance.
setOption(string key, mixed value) : \Joomla\Github\GitHub
| since |
1.0 |
|---|
Arguments
- key
stringThe name of the option to set.- value
mixedThe option value to set.
Response
\Joomla\Github\GitHubThis object for method chaining.
Properties
options
Options for the GitHub object.
| since |
1.0 |
|---|
Type(s)
array
client
The HTTP client object to use in sending HTTP requests.
| since |
1.0 |
|---|
Type(s)
\Joomla\Http\Http
activity
GitHub API object for the activity package.
Type(s)
\Joomla\Github\Package\Activity
authorization
GitHub API object for the authorizations package.
Type(s)
\Joomla\Github\Package\Authorization
data
GitHub API object for the data package.
Type(s)
\Joomla\Github\Package\Data
emojis
GitHub API object for the emojis package.
Type(s)
\Joomla\Github\Package\Emojis
gists
GitHub API object for the gists package.
Type(s)
\Joomla\Github\Package\Gists
gitignore
GitHub API object for the gitignore package.
Type(s)
\Joomla\Github\Package\Gitignore
graphql
GitHub API object for the GraphQL v4 API.
Type(s)
\Joomla\Github\Package\Graphql
issues
GitHub API object for the issues package.
Type(s)
\Joomla\Github\Package\Issues
markdown
GitHub API object for the markdown package.
Type(s)
\Joomla\Github\Package\Markdown
meta
GitHub API object for the meta package.
Type(s)
\Joomla\Github\Package\Meta
orgs
GitHub API object for the orgs package.
Type(s)
\Joomla\Github\Package\Orgs
pulls
GitHub API object for the pulls package.
Type(s)
\Joomla\Github\Package\Pulls
repositories
GitHub API object for the repositories package.
Type(s)
\Joomla\Github\Package\Repositories
search
GitHub API object for the search package.
Type(s)
\Joomla\Github\Package\Search
users
GitHub API object for the users package.
Type(s)
\Joomla\Github\Package\Users
zen
GitHub API object for the zen package.
Type(s)
\Joomla\Github\Package\Zen