User
Table of Contents
- delete() : bool
- Delete user by id.
- getAll() : array<string|int, mixed>
- Get all the users.
- getByWhere() : bool
- Get users using specific field.
- isEmail() : bool
- Check is email is exists or not.
- isLogin() : bool
- Check user is login or not.
- isResetToken() : bool
- Check is reset token is exists or not.
- isToken() : bool
- Check is is verification token is exists or not.
- isUsername() : bool
- Check is username is exists or not.
- loginUser() : mixed
- Get the details of login user.
- logout() : bool
- Logout the user.
- sessionUser() : mixed
- Get the current session user.
Methods
delete()
Delete user by id.
public
delete( $id) : bool
Parameters
Tags
Return values
bool —getAll()
Get all the users.
public
getAll() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getByWhere()
Get users using specific field.
public
getByWhere((string) $where, (string) $value) : bool
Parameters
- $where : (string)
-
field of user e.g username
- $value : (string)
-
value fo field like , usr01
Tags
Return values
bool —isEmail()
Check is email is exists or not.
public
isEmail((mixed) $email) : bool
Parameters
- $email : (mixed)
-
email of user
Tags
Return values
bool —isLogin()
Check user is login or not.
public
isLogin() : bool
Tags
Return values
bool —isResetToken()
Check is reset token is exists or not.
public
isResetToken((mixed) $token) : bool
Parameters
- $token : (mixed)
-
token of user
Tags
Return values
bool —isToken()
Check is is verification token is exists or not.
public
isToken((mixed) $token) : bool
Parameters
- $token : (mixed)
-
token of user
Tags
Return values
bool —isUsername()
Check is username is exists or not.
public
isUsername((string) $username) : bool
Parameters
- $username : (string)
-
username of user
Tags
Return values
bool —loginUser()
Get the details of login user.
public
loginUser() : mixed
Tags
Return values
mixed —logout()
Logout the user.
public
logout() : bool
Tags
Return values
bool —sessionUser()
Get the current session user.
public
sessionUser() : mixed