Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JGithubObject
+ Graphe d'héritage de JGithubObject:

Fonctions membres publiques

 __construct (Registry $options=null, JGithubHttp $client=null)
 

Fonctions membres protégées

 fetchUrl ($path, $page=0, $limit=0)
 
 processResponse (JHttpResponse $response, $expectedCode=200, $decode=true)
 

Attributs protégés

 $options
 
 $client
 

Description détaillée

GitHub API object class for the Joomla Platform.

Depuis
1.7.3
Obsolète:
4.0 Use the joomla/github package via Composer instead

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Registry  $options = null,
JGithubHttp  $client = null 
)

Constructor.

Paramètres
Registry$optionsGitHub options object.
JGithubHttp$clientThe HTTP client object.
Depuis
1.7.3

Références $client, et $options.

Documentation des fonctions membres

◆ fetchUrl()

fetchUrl (   $path,
  $page = 0,
  $limit = 0 
)
protected

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.

Paramètres
string$pathURL to inflect
integer$pagePage to request
integer$limitNumber of results to return per page
Renvoie
string The request URL.
Depuis
1.7.3

Références $limit, $password, $path, et $uri.

◆ processResponse()

processResponse ( JHttpResponse  $response,
  $expectedCode = 200,
  $decode = true 
)
protected

Process the response and decode it.

Paramètres
JHttpResponse$responseThe response.
integer$expectedCodeThe expected "good" code.
boolean$decodeIf the should be response be JSON decoded.
Exceptions
DomainException
Depuis
3.3.0
Renvoie
mixed

Références $message.

Documentation des champs

◆ $client

$client
protected

◆ $options

$options
protected

La documentation de cette classe a été générée à partir du fichier suivant :