Docs For Class JGithubObject

Description

GitHub API object class for the Joomla Platform.

abstract:
since: 11.3

Located in /libraries/joomla/github/object.php (line 19)

Direct descendents

Class	Description
JGithubAccount	GitHub API Account class for the Joomla Platform.
JGithubCommits	GitHub API Commits class for the Joomla Platform.
JGithubForks	GitHub API Forks class for the Joomla Platform.
JGithubGists	GitHub API Gists class for the Joomla Platform.
JGithubHooks	GitHub API Hooks class for the Joomla Platform.
JGithubIssues	GitHub API Issues class for the Joomla Platform.
JGithubMeta	GitHub API Meta class.
JGithubMilestones	GitHub API Milestones class for the Joomla Platform.
JGithubPulls	GitHub API Pull Requests class for the Joomla Platform.
JGithubRefs	GitHub API References class for the Joomla Platform.
JGithubStatuses	GitHub API References class for the Joomla Platform.
JGithubUsers	GitHub API References class for the Joomla Platform.

Variable Summary

JGithubHttp $client

JRegistry $options

Method Summary

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

string fetchUrl (string $path, [integer $page = 0], [integer $limit = 0])

mixed processResponse (JHttpResponse $response, [integer $expectedCode = 200])

Variables

JGithubHttp $client (line 31)

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

JRegistry $options (line 25)

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

Methods

Constructor __construct (line 41)

Constructor.

since: 11.3
access: public

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

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

fetchUrl (line 60)

Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.

return: The request URL.
since: 11.3
access: protected

string fetchUrl (string $path, [integer $page = 0], [integer $limit = 0])

string $path: URL to inflect
integer $page: Page to request
integer $limit: Number of results to return per page

processResponse (line 109)

Process the response and decode it.

throws: DomainException
access: protected

mixed processResponse (JHttpResponse $response, [integer $expectedCode = 200])

JHttpResponse $response: The response.
integer $expectedCode: The expected "good" code.