Joomla! API

Download
Launch

JGithubObject

GitHub API object class for the Joomla Platform.

abstract
package

Joomla.Platform
subpackage

GitHub
since

11.3

Methods

__construct

Constructor.

__construct(\JRegistry &$options = null, \JGithubHttp $client = null)
since

11.3

Arguments

$options

\JRegistry

$client

\JGithubHttpThe HTTP client object.

fetchUrl

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.

fetchUrl(string $path, integer $page, integer $limit) : string
since

11.3

Arguments

$path

stringURL to inflect

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

stringThe request URL.

Properties

options

Options for the GitHub object.

since

11.3

Type(s)

\JRegistry

client

The HTTP client object to use in sending HTTP requests.

since

11.3

Type(s)

\JGithubHttp
  • \ \
  • \ JGithubObject