Référence de la classe JGithubPackageUsers

Graphe d'héritage de JGithubPackageUsers:

Fonctions membres publiques
	get ($user)
	getAuthenticatedUser ()
	edit ($name='', $email='', $blog='', $company='', $location='', $hireable='', $bio='')
	getList ($since=0)
	getUser ($user)
	updateUser ($name='', $email='', $blog='', $company='', $location='', $hireable='', $bio='')
	getUsers ($since=0)
Fonctions membres publiques hérités de JGithubPackage
	__get ($name)
Fonctions membres publiques hérités de JGithubObject
	__construct (Registry $options=null, JGithubHttp $client=null)

Attributs protégés
	$name = 'Users'
	$packages = array('emails', 'followers', 'keys')
Attributs protégés hérités de JGithubPackage
	$name = ''
	$packages = array()
Attributs protégés hérités de JGithubObject
	$options
	$client

Membres hérités additionnels
Fonctions membres protégées hérités de JGithubObject
	fetchUrl ($path, $page=0, $limit=0)
	processResponse (JHttpResponse $response, $expectedCode=200, $decode=true)

Description détaillée

GitHub API References class for the Joomla Platform.

https://developer.github.com/v3/users

Depuis

3.1.4

Obsolète:

4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

edit()

edit	(		$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 unemployed :P
string	$bio	The biometrical DNA fingerprint (or something...)

Exceptions

DomainException

Renvoie

mixed

Références $data, $location, $name, $path, et json_encode.

get()

get

(

$user

)

Get a single user.

Paramètres

string

$user

The users login name.

Exceptions

DomainException

Renvoie

object

Références $path, et $user.

getAuthenticatedUser()

getAuthenticatedUser

(

)

Get the current authenticated user.

Exceptions

DomainException

Renvoie

mixed

Références $path.

getList()

getList

(

$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

Références $path.

getUser()

getUser

(

$user

)

Get a single user.

Paramètres

string

$user

The users login name.

Obsolète:

use users->get()

Exceptions

DomainException

Renvoie

mixed

Références $user.

getUsers()

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.

Obsolète:

use users->getList()

Exceptions

DomainException

Renvoie

mixed

updateUser()

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 unemployed :P
string	$bio	The biometrical DNA fingerprint (or something...)

Obsolète:

use users->edit()

Exceptions

DomainException

Renvoie

mixed

Références $location, $name, et edit.

Documentation des champs

$name

$name = 'Users'

protected

$packages

$packages = array('emails', 'followers', 'keys')

protected

---

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

• libraries/joomla/github/package/users.php