Référence de la classe JGithubUsers

Graphe d'héritage de JGithubUsers:

Graphe de collaboration de JGithubUsers:

Liste de tous les membres

Fonctions membres publiques
	getUser ($user)
	getAuthenticatedUser ()
	updateUser ($name= '', $email= '', $blog= '', $company= '', $location= '', $hireable= '', $bio= '')
	getUsers ($since=0)
Fonctions membres publiques inherited from JGithubObject
	__construct (JRegistry $options=null, JGithubHttp $client=null)

Additional Inherited Members
Fonctions membres protégées inherited from JGithubObject
	fetchUrl ($path, $page=0, $limit=0)
	processResponse (JHttpResponse $response, $expectedCode=200)
Attributs protégés inherited from JGithubObject
	$options
	$client

---

Description détaillée

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

---

Documentation des fonctions membres

JGithubUsers::getAuthenticatedUser

(

)

Get the current authenticated user.

Exceptions:

DomainException

Renvoie:

mixed

Définition à la ligne 56 du fichier users.php.

        {
                // Build the request path.
                $path = '/user';

                // Send the request.
                $response = $this->client->get($this->fetchUrl($path));

                // Validate the response code.
                if ($response->code != 200)
                {
                        // 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);
        }

JGithubUsers::getUser

(

$user

)

Get a single user.

Paramètres:

string

$user

The users login name.

Exceptions:

DomainException

Renvoie:

mixed

Définition à la ligne 30 du fichier users.php.

        {
                // Build the request path.
                $path = '/users/' . $user;

                // Send the request.
                $response = $this->client->get($this->fetchUrl($path));

                // Validate the response code.
                if ($response->code != 200)
                {
                        // 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);
        }

JGithubUsers::getUsers

(

$since = 0

)

Get all users.

This provides a dump of every user, in the order that they signed up for GitHub.

Paramètres:

integer

$since

The integer ID of the last User that you’ve seen.

Exceptions:

DomainException

Renvoie:

mixed

Définition à la ligne 129 du fichier users.php.

        {
                // Build the request path.
                $path = '/users';

                $path .= ($since) ? '?since=' . $since : '';

                // Send the request.
                $response = $this->client->get($this->fetchUrl($path));

                // Validate the response code.
                if ($response->code != 200)
                {
                        // 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);
        }

JGithubUsers::updateUser	(		$name = '',
			$email = '',
			$blog = '',
			$company = '',
			$location = '',
			$hireable = '',
			$bio = ''
	)

Update a user.

Paramètres:

string	$name	The full name
string	$email	The email
string	$blog	The blog
string	$company	The company
string	$location	The location
string	$hireable	If he is unemplayed :P
string	$bio	The biometrical DNA fingerprint (or smthng...)

Exceptions:

DomainException

Renvoie:

mixed

Définition à la ligne 90 du fichier users.php.

        {
                $data = array(
                        'name'     => $name,
                        'email'    => $email,
                        'blog'     => $blog,
                        'company'  => $company,
                        'location' => $location,
                        'hireable' => $hireable,
                        'bio'      => $bio
                );

                // Build the request path.
                $path = '/user';

                // Send the request.
                $response = $this->client->patch($this->fetchUrl($path), json_encode($data));

                // Validate the response code.
                if ($response->code != 200)
                {
                        // 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);
        }

---

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

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