Users
Extends AbstractPackageGitHub 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
since |
1.0 |
---|
Arguments
- options
\Joomla\Registry\Registry
GitHub options object.- client
\Joomla\Http\Http
The HTTP client object.
Response
mixed
__get
Magic method to lazily create API objects
__get(string name) : \Joomla\Github\AbstractPackage
since |
1.0 |
---|---|
throws |
|
Arguments
- name
string
Name of property to retrieve
Response
\Joomla\Github\AbstractPackage
GitHub 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 |
|
Arguments
- name
string
The full namestring
The email- blog
string
The blog- company
string
The company- location
string
The location- hireable
string
If he is unemployed :P- bio
string
The 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
since |
1.0 |
---|
Arguments
- path
string
URL to inflect- page
int
Page to request- limit
int
Number of results to return per page
Response
\Joomla\Uri\Uri
get
Get a single user.
get(string user) : object
since |
1.0 |
---|---|
throws |
|
Arguments
- user
string
The users login name.
Response
object
getAuthenticatedUser
Get the authenticated user.
getAuthenticatedUser() : mixed
since |
1.0 |
---|---|
throws |
|
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 |
|
Arguments
- since
int
The 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
since |
1.0 |
---|---|
throws |
|
Arguments
- response
\Joomla\Http\Response
The response.- expectedCode
int
The expected "good" code.
Response
mixed
Properties
options
Options for the GitHub object.
since |
1.0 |
---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
since |
1.0 |
---|
Type(s)
\Joomla\Http\Http
package
The package the object resides in
since |
1.0 |
---|
Type(s)
string
hookEvents
Array containing the allowed hook events
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