Users_Login_Action
extends Action
in package
Abstract action controller class.
Table of Contents
- $headers : Headers
- $activatedLocale : bool
- $csrfInitiated : bool
- $userModel : User
- Base user model.
- $userRecordModel : Users_Record_Model
- Users record model.
- __construct() : mixed
- {@inheritdoc}
- afterLogin() : void
- After login function.
- check2fa() : void
- Check if 2FA verification is necessary.
- checkPermission() : mixed
- {@inheritdoc}
- cleanInstallationFiles() : void
- Clean installation files.
- failedLogin() : void
- Failed login function.
- isSessionExtend() : bool
- Function to check if session is extended.
- login() : void
- User login to the system.
- loginRequired() : mixed
- {@inheritdoc}
- postProcess() : mixed
- Post process function.
- postProcessAjax() : mixed
- Post process ajax function.
- preProcess() : mixed
- Pre process function.
- preProcessAjax() : mixed
- Pre process ajax function.
- process() : mixed
- Process action.
- sendHeaders() : mixed
- Send headers.
- validateRequest() : void
- Function to validate request method.
- isMultiFactorAuthentication() : bool
- Check whether to run multi-factor authentication.
- redirectUser() : void
- Redirect the user to a different page.
Properties
$headers
public
Headers
$headers
Headers instance.
$activatedLocale
protected
static bool
$activatedLocale
= false
Activated language locale.
$csrfInitiated
private
static bool
$csrfInitiated
= false
CSRF already initiated.
$userModel
Base user model.
private
User
$userModel
$userRecordModel
Users record model.
private
Users_Record_Model
$userRecordModel
Methods
__construct()
{@inheritdoc}
public
__construct() : mixed
Return values
mixed —afterLogin()
After login function.
public
afterLogin(Request $request) : void
Parameters
- $request : Request
Return values
void —check2fa()
Check if 2FA verification is necessary.
public
check2fa(Request $request) : void
Parameters
- $request : Request
Tags
Return values
void —checkPermission()
{@inheritdoc}
public
checkPermission(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —cleanInstallationFiles()
Clean installation files.
public
cleanInstallationFiles() : void
Return values
void —failedLogin()
Failed login function.
public
failedLogin(Request $request, string $type) : void
Parameters
- $request : Request
- $type : string
Return values
void —isSessionExtend()
Function to check if session is extended.
public
isSessionExtend(Request $request) : bool
Parameters
- $request : Request
Return values
bool —login()
User login to the system.
public
login(Request $request) : void
Parameters
- $request : Request
Return values
void —loginRequired()
{@inheritdoc}
public
loginRequired() : mixed
Return values
mixed —postProcess()
Post process function.
public
postProcess(Request $request[, bool $display = true ]) : mixed
Parameters
- $request : Request
- $display : bool = true
Return values
mixed —postProcessAjax()
Post process ajax function.
public
postProcessAjax(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —preProcess()
Pre process function.
public
preProcess(Request $request[, bool $display = true ]) : mixed
Parameters
- $request : Request
- $display : bool = true
Return values
mixed —preProcessAjax()
Pre process ajax function.
public
preProcessAjax(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —process()
Process action.
public
process(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —sendHeaders()
Send headers.
public
sendHeaders() : mixed
Return values
mixed —validateRequest()
Function to validate request method.
public
validateRequest(Request $request) : void
Parameters
- $request : Request
Return values
void —isMultiFactorAuthentication()
Check whether to run multi-factor authentication.
private
isMultiFactorAuthentication() : bool
Return values
bool —redirectUser()
Redirect the user to a different page.
private
redirectUser() : void