Class JGithubObject

GitHub API object class for the Joomla Platform.

Direct known subclasses

JGithubAccount, JGithubCommits, JGithubForks, JGithubHooks, JGithubMeta, JGithubMilestones, JGithubPackage, JGithubRefs, JGithubStatuses

Indirect known subclasses

Abstract
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/object.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
`protected string`	# `fetchUrl( string $path, integer $page = 0, integer $limit = 0 )` 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. 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. Parameters `$path` `string` - $path URL to inflect `$page` `integer` - $page Page to request `$limit` `integer` - $limit Number of results to return per page Returns `string` - The request URL. Since 11.3
`protected mixed`	# `processResponse( JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true )` Process the response and decode it. Process the response and decode it. Parameters `$response` `JHttpResponse` - $response The response. `$expectedCode` `integer` - $expectedCode The expected "good" code. `$decode` `boolean` - $decode If the should be response be JSON decoded. Returns `mixed` Throws `DomainException` Since 12.4

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

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithubObject

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Magic methods summary

Properties summary

Since

Since