Login
extends BaseAction
in package
Uses
LoginHistory
Webservice standard container - Users Login action class.
Table of Contents
- DATE_TIME_FORMAT = 'Y-m-d H:i:s'
- $allowedHeaders : array<string|int, mixed>
- $allowedMethod : array<string|int, string>
- $controller : Controller
- $responseType : string
- $userData : array<string|int, mixed>
- checkAction() : void
- Check called action.
- getLanguage() : string
- Get current language.
- getParentCrmId() : int|null
- Get parent record.
- getPermissionType() : int
- Get permission type.
- getUserCrmId() : int
- Get crmid for portal user.
- getUserData() : mixed
- Get user data and session data.
- getUserStorageId() : int
- Get user storage ID.
- post() : array<string|int, mixed>|null
- Post method.
- preProcess() : mixed
- Pre process function.
- setAllUserData() : void
- Set user data.
- setUserData() : void
- Set user data.
- updateSession() : void
- Update user session.
- updateUser() : void
- Update user data.
- checkAccess() : void
- Check access data.
- checkLifetimeSession() : void
- Check lifetime user session.
- checkPermission() : void
- Check permission to method.
- checkPermissionToModule() : void
- Check permission to module.
- createSession() : void
- Update user session.
- loadSession() : void
- Load user session data .
- returnData() : array<string|int, mixed>
- Build data for api response.
- saveData() : void
- Save user data and logs.
- saveLoginHistory() : void
- Function to store the login history.
- twoFactorAuth() : string
- Check two factor authorization.
Constants
DATE_TIME_FORMAT
public
string
DATE_TIME_FORMAT
= 'Y-m-d H:i:s'
Date time format 'Y-m-d H:i:s'
Properties
$allowedHeaders
public
array<string|int, mixed>
$allowedHeaders
= []
Allowed headers
$allowedMethod
public
array<string|int, string>
$allowedMethod
= ['POST']
Allowed methods
$controller
public
Controller
$controller
$responseType
public
string
$responseType
= 'data'
Response data type.
$userData
private
array<string|int, mixed>
$userData
= []
User data
Methods
checkAction()
Check called action.
public
checkAction() : void
Tags
Return values
void —getLanguage()
Get current language.
public
getLanguage() : string
Return values
string —getParentCrmId()
Get parent record.
public
getParentCrmId() : int|null
Tags
Return values
int|null —getPermissionType()
Get permission type.
public
getPermissionType() : int
Return values
int —getUserCrmId()
Get crmid for portal user.
public
getUserCrmId() : int
Return values
int —getUserData()
Get user data and session data.
public
getUserData(string $key[, string $param = '' ]) : mixed
Parameters
- $key : string
- $param : string = ''
Return values
mixed —getUserStorageId()
Get user storage ID.
public
getUserStorageId() : int
Return values
int —post()
Post method.
public
post() : array<string|int, mixed>|null
Tags
Return values
array<string|int, mixed>|null —preProcess()
Pre process function.
public
preProcess() : mixed
Return values
mixed —setAllUserData()
Set user data.
public
setAllUserData(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
Return values
void —setUserData()
Set user data.
public
setUserData(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
Return values
void —updateSession()
Update user session.
public
updateSession([array<string|int, mixed> $data = [] ]) : void
Parameters
- $data : array<string|int, mixed> = []
Return values
void —updateUser()
Update user data.
public
updateUser([array<string|int, mixed> $data = [] ]) : void
Parameters
- $data : array<string|int, mixed> = []
Return values
void —checkAccess()
Check access data.
protected
checkAccess() : void
Tags
Return values
void —checkLifetimeSession()
Check lifetime user session.
protected
checkLifetimeSession() : void
Tags
Return values
void —checkPermission()
Check permission to method.
protected
checkPermission() : void
Return values
void —checkPermissionToModule()
Check permission to module.
protected
checkPermissionToModule() : void
Return values
void —createSession()
Update user session.
protected
createSession() : void
Return values
void —loadSession()
Load user session data .
protected
loadSession() : void
Tags
Return values
void —returnData()
Build data for api response.
protected
returnData() : array<string|int, mixed>
Return values
array<string|int, mixed> —saveData()
Save user data and logs.
protected
saveData() : void
Return values
void —saveLoginHistory()
Function to store the login history.
protected
saveLoginHistory(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
Return values
void —twoFactorAuth()
Check two factor authorization.
protected
twoFactorAuth() : string