Users
in package
Users Class
Table of Contents
- $planet_data : mixed
- $user_data : mixed
- $Users_Model : mixed
- __construct() : void
- __construct
- checkSession() : void
- checkSession
- createUserWithOptions() : void
- createUserWithOptions
- deleteUser() : void
- deleteUser
- getPlanetData() : array<string|int, mixed>
- getPlanetData
- getUserData() : array<string|int, mixed>
- getUserData
- isInactive() : bool
- Check if user is inactive
- isOnVacations() : bool
- Check if user is on vacations
- userLogin() : void
- userLogin
- displayLoginErrors() : void
- Display login errors
- isSessionSet() : bool
- isSessionSet
- setPlanet() : void
- setPlanet
- setPlanetData() : void
- setPlanetData
- setUserData() : void
- Set the user data after some session and security validations
Properties
$planet_data
private
mixed
$planet_data
$user_data
private
mixed
$user_data
$Users_Model
private
mixed
$Users_Model
Methods
__construct()
__construct
public
__construct() : void
Return values
void —checkSession()
checkSession
public
static checkSession() : void
Return values
void —createUserWithOptions()
createUserWithOptions
public
createUserWithOptions(array<string|int, mixed> $data[, bool $full_insert = true ]) : void
Parameters
- $data : array<string|int, mixed>
-
The data as an array
- $full_insert : bool = true
-
Insert all the required tables
Return values
void —deleteUser()
deleteUser
public
deleteUser(int $user_id) : void
Parameters
- $user_id : int
-
User ID
Return values
void —getPlanetData()
getPlanetData
public
getPlanetData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUserData()
getUserData
public
getUserData() : array<string|int, mixed>
Return values
array<string|int, mixed> —isInactive()
Check if user is inactive
public
isInactive(array<string|int, mixed> $user) : bool
Parameters
- $user : array<string|int, mixed>
-
User data
Return values
bool —isOnVacations()
Check if user is on vacations
public
isOnVacations(array<string|int, mixed> $user) : bool
Parameters
- $user : array<string|int, mixed>
-
User data
Return values
bool —userLogin()
userLogin
public
userLogin(int $user_id[, string $password = '' ]) : void
Parameters
- $user_id : int
-
User ID
- $password : string = ''
-
Password
Return values
void —displayLoginErrors()
Display login errors
private
displayLoginErrors(array<string|int, mixed> $user_row) : void
Parameters
- $user_row : array<string|int, mixed>
-
User Row
Return values
void —isSessionSet()
isSessionSet
private
static isSessionSet() : bool
Return values
bool —setPlanet()
setPlanet
private
setPlanet() : void
Return values
void —setPlanetData()
setPlanetData
private
setPlanetData() : void
Return values
void —setUserData()
Set the user data after some session and security validations
private
setUserData() : void