Class JGithubPackageUsers

GitHub API References class for the Joomla Platform.

JGithubPackageUsers

Package: Joomla\Platform\GitHub
Deprecated: 4.0 Use the joomla/github package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Documentation: https://developer.github.com/v3/repos/users
Located at joomla/github/package/users.php

Methods summary

`public object`	# `get( string $user )` Get a single user. Get a single user. Parameters `$user` `string` - $user The users login name. Returns `object` Throws `DomainException`
`public mixed`	# `getAuthenticatedUser( )` Get the current authenticated user. Get the current authenticated user. Returns `mixed` Throws `DomainException`
`public mixed`	# `edit( string $name = '', string $email = '', string $blog = '', string $company = '', string $location = '', string $hireable = '', string $bio = '' )` Update a user. Update a user. Parameters `$name` `string` - $name The full name `$email` `string` - $email The email `$blog` `string` - $blog The blog `$company` `string` - $company The company `$location` `string` - $location The location `$hireable` `string` - $hireable If he is unemplayed :P `$bio` `string` - $bio The biometrical DNA fingerprint (or smthng...) Returns `mixed` Throws `DomainException`
`public mixed`	# `getList( integer $since = 0 )` Get all users. Get all users. This provides a dump of every user, in the order that they signed up for GitHub. Parameters `$since` `integer` - $since The integer ID of the last User that you’ve seen. Returns `mixed` Throws `DomainException`
`public mixed`	# `getUser( string $user )` Get a single user. Get a single user. Parameters `$user` `string` - $user The users login name. Returns `mixed` Throws `DomainException`
`public mixed`	# `updateUser( string $name = '', string $email = '', string $blog = '', string $company = '', string $location = '', string $hireable = '', string $bio = '' )` Update a user. Update a user. Parameters `$name` `string` - $name The full name `$email` `string` - $email The email `$blog` `string` - $blog The blog `$company` `string` - $company The company `$location` `string` - $location The location `$hireable` `string` - $hireable If he is unemplayed :P `$bio` `string` - $bio The biometrical DNA fingerprint (or smthng...) Returns `mixed` Throws `DomainException`
`public mixed`	# `getUsers( integer $since = 0 )` Get all users. Get all users. This provides a dump of every user, in the order that they signed up for GitHub. Parameters `$since` `integer` - $since The integer ID of the last User that you’ve seen. Returns `mixed` Throws `DomainException`

Methods inherited from JGithubPackage

__get()

Methods inherited from JGithubObject

__construct(), fetchUrl(), processResponse()

Magic methods summary

Properties summary

`protected string`	`$name`	# Since 3.3 (CMS)
`protected array`	`$packages`	# Since 3.3 (CMS)

Properties inherited from JGithubObject

$client, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithubPackageUsers

Methods summary

Parameters

Returns

Throws

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Methods inherited from JGithubPackage

Methods inherited from JGithubObject

Magic methods summary

Properties summary

Since

Since

Properties inherited from JGithubObject