Joomla! API

Download
Launch

Users

Extends AbstractPackage

GitHub API References class for the Joomla Framework.

link
since

1.0
property-read Emails

GitHub API object for emails.

GitHub API object for followers.

GitHub API object for keys.
package

Joomla Framework

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) : mixed
inherited
since

1.0

Arguments

options

\Joomla\Registry\RegistryGitHub options object.

client

\Joomla\Http\HttpThe HTTP client object.

Response

mixed

__get

Magic method to lazily create API objects

__get(string name) : \Joomla\Github\AbstractPackage
inherited
since

1.0
throws

\InvalidArgumentException

Arguments

name

stringName of property to retrieve

Response

\Joomla\Github\AbstractPackageGitHub API package object.

edit

Update the authenticated user.

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

1.0
throws

\DomainException

Arguments

name

stringThe full name

email

stringThe email

blog

stringThe blog

company

stringThe company

location

stringThe location

hireable

stringIf he is unemployed :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, int page, int limit) : \Joomla\Uri\Uri
inherited
since

1.0

Arguments

path

stringURL to inflect

page

intPage to request

limit

intNumber of results to return per page

Response

\Joomla\Uri\Uri

get

Get a single user.

get(string user) : object
since

1.0
throws

\DomainException

Arguments

user

stringThe users login name.

Response

object

getAuthenticatedUser

Get the authenticated user.

getAuthenticatedUser() : mixed
since

1.0
throws

\DomainException

Response

mixed

getList

Get all users.

getList(int since) : object

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

since

1.0
throws

\DomainException

Arguments

since

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

Response

object

processResponse

Process the response and decode it.

processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
inherited
since

1.0
throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

response

\Joomla\Http\ResponseThe response.

expectedCode

intThe expected "good" code.

Response

mixed

Properties

options

Options for the GitHub object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Http\Http

package

The package the object resides in

inherited
since

1.0

Type(s)

string

hookEvents

Array containing the allowed hook events

inherited
since

1.5.2
link
note

From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses

Type(s)

array

emails

GitHub API object for emails.

Type(s)

\Joomla\Github\Package\Users\Emails

followers

GitHub API object for followers.

Type(s)

\Joomla\Github\Package\Users\Followers

keys

GitHub API object for keys.

Type(s)

\Joomla\Github\Package\Users\Keys
  • \ Joomla
  • \ Github
  • \ Package
  • \ Users