Documentation

Users_LoginForgotPassword_Action extends Users_Login_Action
in package

Login forgot password action class.

Table of Contents

$csrfActive  : bool
CSRF is active?.
$headers  : Headers
$activatedCsrf  : bool
Activated csrf.
$activatedLocale  : bool
Activated language locale.
$userModel  : User
Base user model.
$userRecordModel  : Users_Record_Model
Users record model.
__construct()  : mixed
Constructor.
afterLogin()  : void
After login function.
check2fa()  : void
Check if 2FA verification is necessary.
checkPermission()  : mixed
Function to check permission.
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()  : bool
Function to check login required permission.
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()  : bool
Function to validate request method.
isMultiFactorAuthentication()  : bool
Check whether to run multi-factor authentication.
redirectUser()  : void
Redirect the user to a different page.

Properties

$csrfActive

CSRF is active?.

public bool $csrfActive = true

$headers

public Headers $headers

Headers instance.

$activatedCsrf

Activated csrf.

protected static bool $activatedCsrf = false

$activatedLocale

Activated language locale.

protected static bool $activatedLocale = false

$userModel

Base user model.

private User $userModel

$userRecordModel

Users record model.

private Users_Record_Model $userRecordModel

Methods

__construct()

Constructor.

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
throws
IllegalValue
Return values
void

checkPermission()

Function to check permission.

public abstract checkPermission(Request $request) : mixed
Parameters
$request : Request
Tags
throws
NoPermitted
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()

Function to check login required permission.

public loginRequired() : bool
Return values
bool

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

sendHeaders()

Send headers.

public sendHeaders() : mixed
Return values
mixed

validateRequest()

Function to validate request method.

public validateRequest(Request $request) : bool
Parameters
$request : Request
Return values
bool

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
Return values
void

        

Search results