JGithubPackageUsers

Extends \JGithubPackage

GitHub API References class for the Joomla Platform.

deprecated
documentation

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

since

3.1.4

deprecated

4.0 Use the joomla/github package via Composer instead

package

Joomla.Platform

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null) 
inherited
since

1.7.3

Arguments

$options

\Joomla\Registry\RegistryGitHub options object.

$client

\JGithubHttpThe HTTP client object.

__get

Magic method to lazily create API objects

__get(string $name) : \JGithubPackage
inherited
since

3.3

throws

\RuntimeException

Arguments

$name

stringName of property to retrieve

Response

\JGithubPackageGitHub API package object.

edit

Update a user.

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

\DomainException

Arguments

$name

stringThe full name

$email

stringThe email

$blog

stringThe blog

$company

stringThe company

$location

stringThe location

$hireable

stringIf he is unemplayed :P

$bio

stringThe biometrical DNA fingerprint (or smthng...)

Response

mixed

fetchUrl

Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.

fetchUrl(string $path, integer $page, integer $limit) : string
inherited
since

1.7.3

Arguments

$path

stringURL to inflect

$page

integerPage to request

$limit

integerNumber of results to return per page

Response

stringThe request URL.

get

Get a single user.

get(string $user) : object
throws

\DomainException

Arguments

$user

stringThe users login name.

Response

object

getAuthenticatedUser

Get the current authenticated user.

getAuthenticatedUser() : mixed
throws

\DomainException

Response

mixed

getList

Get all users.

getList(integer $since) : mixed

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

throws

\DomainException

Arguments

$since

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

Response

mixed

getUser

Get a single user.

getUser(string $user) : mixed
deprecated
deprecated

use users->get()

throws

\DomainException

Arguments

$user

stringThe users login name.

Response

mixed

getUsers

Get all users.

getUsers(integer $since) : mixed
deprecated

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

deprecated

use users->getList()

throws

\DomainException

Arguments

$since

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

Response

mixed

processResponse

Process the response and decode it.

processResponse(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
inherited
throws

\DomainException

since

3.3.0

Arguments

$response

\JHttpResponseThe response.

$expectedCode

integerThe expected "good" code.

$decode

booleanIf the should be response be JSON decoded.

Response

mixed

updateUser

Update a user.

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

use users->edit()

throws

\DomainException

Arguments

$name

stringThe full name

$email

stringThe email

$blog

stringThe blog

$company

stringThe company

$location

stringThe location

$hireable

stringIf he is unemplayed :P

$bio

stringThe biometrical DNA fingerprint (or smthng...)

Response

mixed

Properties

name

inherited
since

3.3

Type(s)

string

packages

inherited
since

3.3

Type(s)

array

options

Options for the GitHub object.

inherited
since

1.7.3

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.7.3

Type(s)

\JGithubHttp