JGithubPackageUsers

class JGithubPackageUsers extends JGithubPackage

GitHub API References class for the Joomla Platform.

Methods

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

Constructor.

from JGithubObject
JGithubPackage
__get( string $name)

Magic method to lazily create API objects

from JGithubPackage
object
get( string $user)

Get a single user.

mixed
getAuthenticatedUser()

Get the current authenticated user.

mixed
edit( string $name = '', string $email = '', string $blog = '', string $company = '', string $location = '', string $hireable = '', string $bio = '')

Update a user.

mixed
getList( integer $since)

Get all users.

mixed
getUser( string $user)

Get a single user.

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

Update a user.

mixed
getUsers( integer $since)

Get all users.

Details

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

Constructor.

Parameters

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

JGithubPackage __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JGithubPackage GitHub API package object.

Exceptions

RuntimeException

object get( string $user)

Get a single user.

Parameters

string $user The users login name.

Return Value

object

Exceptions

DomainException

mixed getAuthenticatedUser()

Get the current authenticated user.

Return Value

mixed

Exceptions

DomainException

mixed edit( string $name = '', string $email = '', string $blog = '', string $company = '', string $location = '', string $hireable = '', string $bio = '')

Update a user.

Parameters

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

Return Value

mixed

Exceptions

DomainException

mixed getList( integer $since)

Get all users.

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

Parameters

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

Return Value

mixed

Exceptions

DomainException

mixed getUser( string $user)

Get a single user.

Parameters

string $user The users login name.

Return Value

mixed

Exceptions

DomainException

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

Update a user.

Parameters

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

Return Value

mixed

Exceptions

DomainException

mixed getUsers( integer $since)

Get all users.

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

Parameters

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

Return Value

mixed

Exceptions

DomainException