Class JGithub

Joomla Platform class for interacting with a GitHub server instance.

Package: Joomla\Platform\GitHub
Deprecated: 4.0 Use the joomla/github package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.3
Located at joomla/github/github.php

Methods summary

`public`	# `__construct( Joomla\Registry\Registry $options = null, JGithubHttp $client = null )` Constructor. Constructor. Parameters `$options` `Joomla\Registry\Registry` - $options GitHub options object. `$client` `JGithubHttp` - $client The HTTP client object. Since 11.3
`public JGithubObject`	# `__get( string $name )` Magic method to lazily create API objects Magic method to lazily create API objects Parameters `$name` `string` - $name Name of property to retrieve Returns `JGithubObject` - GitHub API object (gists, issues, pulls, etc). Throws `RuntimeException` Since 11.3
`public mixed`	# `getOption( string $key )` Get an option from the JGitHub instance. Get an option from the JGitHub instance. Parameters `$key` `string` - $key The name of the option to get. Returns `mixed` - The option value. Since 11.3
`public JGitHub`	# `setOption( string $key, mixed $value )` Set an option for the JGitHub instance. Set an option for the JGitHub instance. Parameters `$key` `string` - $key The name of the option to set. `$value` `mixed` - $value The option value to set. Returns `JGitHub` - This object for method chaining. Since 11.3

Magic methods summary

Properties summary

`protected Joomla\Registry\Registry`	`$options`	# Options for the GitHub object. Options for the GitHub object. Since 11.3
`protected JGithubHttp`	`$client`	# The HTTP client object to use in sending HTTP requests. The HTTP client object to use in sending HTTP requests. Since 11.3
`protected array`	`$packages`	# List of known packages. List of known packages. Since 3.3 (CMS)
`protected array`	`$legacyPackages`	# List of known legacy packages. List of known legacy packages. Since 3.3 (CMS)

Magic properties

`public read-only JGithubPackageActivity`	`$activity`	# GitHub API object for activity. GitHub API object for activity.
`public read-only JGithubPackageAuthorization`	`$authorization`	# GitHub API object for authorizations. GitHub API object for authorizations.
`public read-only JGithubPackageData`	`$data`	# GitHub API object for data. GitHub API object for data.
`public read-only JGithubPackageGists`	`$gists`	# GitHub API object for gists. GitHub API object for gists.
`public read-only JGithubPackageGitignore`	`$gitignore`	# GitHub API object for gitignore. GitHub API object for gitignore.
`public read-only JGithubPackageIssues`	`$issues`	# GitHub API object for issues. GitHub API object for issues.
`public read-only JGithubPackageMarkdown`	`$markdown`	# GitHub API object for markdown. GitHub API object for markdown.
`public read-only JGithubPackageOrgs`	`$orgs`	# GitHub API object for orgs. GitHub API object for orgs.
`public read-only JGithubPackagePulls`	`$pulls`	# GitHub API object for pulls. GitHub API object for pulls.
`public read-only JGithubPackageRepositories`	`$repositories`	# GitHub API object for repositories. GitHub API object for repositories.
`public read-only JGithubPackageSearch`	`$search`	# GitHub API object for search. GitHub API object for search.
`public read-only JGithubPackageUsers`	`$users`	# GitHub API object for users. GitHub API object for users.
`public read-only JGithubRefs`	`$refs`	# Deprecated GitHub API object for referencess. Deprecated GitHub API object for referencess.
`public read-only JGithubForks`	`$forks`	# Deprecated GitHub API object for forks. Deprecated GitHub API object for forks.
`public read-only JGithubCommits`	`$commits`	# Deprecated GitHub API object for commits. Deprecated GitHub API object for commits.
`public read-only JGithubMilestones`	`$milestones`	# Deprecated GitHub API object for commits. Deprecated GitHub API object for commits.
`public read-only JGithubStatuses`	`$statuses`	# Deprecated GitHub API object for commits. Deprecated GitHub API object for commits.
`public read-only JGithubAccount`	`$account`	# Deprecated GitHub API object for account references. Deprecated GitHub API object for account references.
`public read-only JGithubHooks`	`$hooks`	# Deprecated GitHub API object for hooks. Deprecated GitHub API object for hooks.
`public read-only JGithubMeta`	`$meta`	# Deprecated GitHub API object for meta. Deprecated GitHub API object for meta.

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithub

Methods summary

Parameters

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since

Magic properties