Docs For Class JGithubUsers

JGithubUsers

Description

GitHub API References class for the Joomla Platform.

since: 12.3

Located in /libraries/joomla/github/users.php (line 19)

JGithubObject
   |
   --JGithubUsers

Method Summary

mixed getAuthenticatedUser ()

mixed getUser (string $user)

mixed getUsers ([integer $since = 0])

mixed updateUser ([string $name = ''], [string $email = ''], [string $blog = ''], [string $company = ''], [string $location = ''], [string $hireable = ''], [string $bio = ''])

Variables

Inherited Variables

Inherited from JGithubObject

JGithubObject::$client
JGithubObject::$options

Methods

getAuthenticatedUser (line 56)

Get the current authenticated user.

throws: DomainException
access: public

mixed getAuthenticatedUser ()

getUser (line 30)

Get a single user.

throws: DomainException
access: public

mixed getUser (string $user)

string $user: The users login name.

getUsers (line 129)

Get all users.

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

throws: DomainException
access: public

mixed getUsers ([integer $since = 0])

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

updateUser (line 90)

Update a user.

throws: DomainException
access: public

mixed updateUser ([string $name = ''], [string $email = ''], [string $blog = ''], [string $company = ''], [string $location = ''], [string $hireable = ''], [string $bio = ''])

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...)

Inherited Methods

Inherited From JGithubObject

JGithubObject::__construct()
JGithubObject::fetchUrl()
JGithubObject::processResponse()

Documentation generated on Tue, 19 Nov 2013 15:16:42 +0100 by phpDocumentor 1.4.3