JsonUser
in package
implements
JsonAdapter
JSON Adapter for Block module
Tags
Table of Contents
Interfaces
- JsonAdapter
- JSON Adapter for JSON requests
Properties
- $messages : array<string|int, mixed>
- List of messages
Methods
- getAccessableMethods() : array<string|int, mixed>
- Returns an array of method names accessable from a JSON request
- getDefaultPermissions() : object
- Returns default permission as object
- getMessagesAsString() : string
- Returns all messages as string
- getName() : string
- Returns the internal name used as identifier for this adapter
- getUserById() : array<string|int, mixed>
- Returns the user with the given user id.
- getUsers() : array<string|int, mixed>
- Returns all users according to the given term.
- loginUser() : false
- Logs the current User in.
- logoutUser() : bool
- Logs the current User out.
- lostPassword() : bool
- Sends a Email with a new tomporary Password to the user with given email
- setPassword() : bool
- Set a new Password for a specific user if the admin has enough permissions
Properties
$messages
List of messages
private
array<string|int, mixed>
$messages
= array()
Methods
getAccessableMethods()
Returns an array of method names accessable from a JSON request
public
getAccessableMethods() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of method names
getDefaultPermissions()
Returns default permission as object
public
getDefaultPermissions() : object
Return values
objectgetMessagesAsString()
Returns all messages as string
public
getMessagesAsString() : string
Return values
string —HTML encoded error messages
getName()
Returns the internal name used as identifier for this adapter
public
getName() : string
Return values
string —Name of this adapter
getUserById()
Returns the user with the given user id.
public
getUserById() : array<string|int, mixed>
If the user does not exist then return the currently logged in user.
Return values
array<string|int, mixed> —User id and title
getUsers()
Returns all users according to the given term.
public
getUsers() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of users
loginUser()
Logs the current User in.
public
loginUser() : false
Return values
false —on failure and array with userdata on success
logoutUser()
Logs the current User out.
public
logoutUser() : bool
Return values
boollostPassword()
Sends a Email with a new tomporary Password to the user with given email
public
lostPassword(string $arguments) : bool
Parameters
- $arguments : string
-
['get']['email'] || $arguments['post']['email']
Return values
boolsetPassword()
Set a new Password for a specific user if the admin has enough permissions
public
setPassword(string $arguments) : bool
Parameters
- $arguments : string
-
['get']['repeatPassword'] || $arguments['post']['repeatPassword']