Référence de la classe JGithubObject

Graphe d'héritage de JGithubObject:

Liste de tous les membres

Fonctions membres publiques
	__construct (JRegistry $options=null, JGithubHttp $client=null)

Fonctions membres protégées
	fetchUrl ($path, $page=0, $limit=0)
	processResponse (JHttpResponse $response, $expectedCode=200)

Attributs protégés
	$options
	$client

---

Description détaillée

Définition à la ligne 19 du fichier object.php.

---

Documentation des constructeurs et destructeur

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

Constructor.

Paramètres:

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

Depuis:

11.3

Définition à la ligne 41 du fichier object.php.

        {
                $this->options = isset($options) ? $options : new JRegistry;
                $this->client = isset($client) ? $client : new JGithubHttp($this->options);
        }

---

Documentation des fonctions membres

JGithubObject::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	$path	URL to inflect
integer	$page	Page to request
integer	$limit	Number of results to return per page

Renvoie:

string The request URL.

Depuis:

11.3

Définition à la ligne 60 du fichier object.php.

Références JUri\setVar().

        {
                // Get a new JUri object fousing the api url and given path.
                $uri = new JUri($this->options->get('api.url') . $path);

                if ($this->options->get('gh.token', false))
                {
                        // Use oAuth authentication - @todo set in request header ?
                        $uri->setVar('access_token', $this->options->get('gh.token'));
                }
                else
                {
                        // Use basic authentication
                        if ($this->options->get('api.username', false))
                        {
                                $uri->setUser($this->options->get('api.username'));
                        }

                        if ($this->options->get('api.password', false))
                        {
                                $uri->setPass($this->options->get('api.password'));
                        }
                }

                // If we have a defined page number add it to the JUri object.
                if ($page > 0)
                {
                        $uri->setVar('page', (int) $page);
                }

                // If we have a defined items per page add it to the JUri object.
                if ($limit > 0)
                {
                        $uri->setVar('per_page', (int) $limit);
                }

                return (string) $uri;
        }

Voici le graphe d'appel pour cette fonction :

JGithubObject::processResponse ( JHttpResponse  $response,   $expectedCode = 200  )

protected

Process the response and decode it.

Paramètres:

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

Exceptions:

DomainException

Renvoie:

mixed

Définition à la ligne 109 du fichier object.php.

        {
                // Validate the response code.
                if ($response->code != $expectedCode)
                {
                        // Decode the error response and throw an exception.
                        $error = json_decode($response->body);
                        throw new DomainException($error->message, $response->code);
                }

                return json_decode($response->body);
        }

---

Documentation des données membres

JGithubObject::$client

protected

Définition à la ligne 31 du fichier object.php.

JGithubObject::$options

protected

Définition à la ligne 25 du fichier object.php.

---

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

• jplatform-13.1/joomla/github/object.php