Ubiquity 2.5.2
php rapid development framework
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Static Protected Attributes
AuthAccountRecoveryTrait Class Reference

Ubiquity\controllers\auth\traits$AuthAccountRecoveryTrait This class is part of Ubiquity. More...

+ Inheritance diagram for AuthAccountRecoveryTrait:

Public Member Functions

 _getBodySelector ()
 
 _addFrmAjaxBehavior ($id)
 
 _getPasswordInputName ()
 
 info ($force=null)
 
 recoveryInit ()
 
 recoveryInfo ()
 
 recovery (string $key, string $hashMail)
 
 recoverySubmit ()
 

Protected Member Functions

 fMessage (FlashMessage $fMessage, $id=null)
 
 _getFiles ()
 
 getBaseUrl ()
 
 authLoadView ($viewName, $vars=[])
 
 useAjax ()
 
 passwordConfLabel ()
 
 passwordLabel ()
 
 validateEmail (string $mail)
 
 hasAccountRecovery ()
 
 recoveryInitMessage (FlashMessage $fMessage)
 To override Displayed when an account recovery operation is initiated.
 
 recoveryEmailSendMessage (FlashMessage $fMessage)
 To override Displayed when email is sent for a recovery account operation.
 
 recoveryEmailErrorMessage (FlashMessage $fMessage)
 To override Displayed when email is not associated with an existing account.
 
 resetPasswordSuccessMessage (FlashMessage $fMessage)
 To override Displayed when a new password is set with recovery account.
 
 resetPasswordErrorMessage (FlashMessage $fMessage)
 To override Displayed when an error occurs when a new password is set with recovery account.
 
 emailAccountRecoverySuccess (FlashMessage $fMessage)
 To override Displayed when the account recovery link is valid.
 
 emailAccountRecoveryError (FlashMessage $fMessage)
 To override Displayed when the account recovery link is not valid.
 
 recoveryAccountCaption ()
 Returns the recovery account link caption.
 
 accountRecoveryDuration ()
 Returns the default validity duration for an email account recovery.
 
 getAuthTokensAccountRecovery ()
 To override Returns the AuthTokens instance used for tokens generation for a recovery account.
 
 isValidEmailForRecovery (string $email)
 To override Checks if a valid account matches this email.
 
 _sendEmailAccountRecovery (string $email, string $validationURL, string $expire)
 Sends an email for account recovery (password reset).
 
 passwordResetAction (string $email, string $newPasswordHash)
 To override Changes the active password associated with the account corresponding to this email.
 
 getAccountRecoveryLink ()
 
 generateEmailAccountRecoveryUrl ($email)
 
 prepareEmailAccountRecovery (string $email)
 

Static Protected Attributes

static string $TOKENS_RECOVERY_ACCOUNT ='account.recovery'
 

Detailed Description

Ubiquity\controllers\auth\traits$AuthAccountRecoveryTrait This class is part of Ubiquity.

Author
jc
Version
1.0.0

Definition at line 20 of file AuthAccountRecoveryTrait.php.

Member Function Documentation

◆ _addFrmAjaxBehavior()

_addFrmAjaxBehavior (   $id)
abstract

Reimplemented in AuthController.

◆ _getBodySelector()

_getBodySelector ( )
abstract

Reimplemented in AuthControllerConfig.

◆ _getFiles()

_getFiles ( )
abstractprotected

◆ _getPasswordInputName()

_getPasswordInputName ( )
abstract

Reimplemented in AuthControllerConfig.

◆ _sendEmailAccountRecovery()

_sendEmailAccountRecovery ( string  $email,
string  $validationURL,
string  $expire 
)
protected

Sends an email for account recovery (password reset).

Parameters
string$email
string$validationURL
string$expire
Returns
boolean

Definition at line 161 of file AuthAccountRecoveryTrait.php.

◆ accountRecoveryDuration()

accountRecoveryDuration ( )
protected

Returns the default validity duration for an email account recovery.

Returns
\DateInterval

Definition at line 131 of file AuthAccountRecoveryTrait.php.

◆ authLoadView()

authLoadView (   $viewName,
  $vars = [] 
)
abstractprotected

◆ emailAccountRecoveryError()

emailAccountRecoveryError ( FlashMessage  $fMessage)
protected

To override Displayed when the account recovery link is not valid.

Parameters
FlashMessage$fMessage

Definition at line 114 of file AuthAccountRecoveryTrait.php.

◆ emailAccountRecoverySuccess()

emailAccountRecoverySuccess ( FlashMessage  $fMessage)
protected

To override Displayed when the account recovery link is valid.

Parameters
FlashMessage$fMessage

Definition at line 105 of file AuthAccountRecoveryTrait.php.

◆ fMessage()

fMessage ( FlashMessage  $fMessage,
  $id = null 
)
abstractprotected

◆ generateEmailAccountRecoveryUrl()

generateEmailAccountRecoveryUrl (   $email)
protected

Definition at line 243 of file AuthAccountRecoveryTrait.php.

◆ getAccountRecoveryLink()

getAccountRecoveryLink ( )
protected

Definition at line 176 of file AuthAccountRecoveryTrait.php.

◆ getAuthTokensAccountRecovery()

getAuthTokensAccountRecovery ( )
protected

To override Returns the AuthTokens instance used for tokens generation for a recovery account.

Returns
AuthTokens

Definition at line 140 of file AuthAccountRecoveryTrait.php.

◆ getBaseUrl()

getBaseUrl ( )
abstractprotected

◆ hasAccountRecovery()

hasAccountRecovery ( )
protected
Returns
bool

Reimplemented in AuthControllerConfig.

Definition at line 51 of file AuthAccountRecoveryTrait.php.

◆ info()

info (   $force = null)
abstract

Reimplemented in AuthController.

◆ isValidEmailForRecovery()

isValidEmailForRecovery ( string  $email)
protected

To override Checks if a valid account matches this email.

Parameters
string$email
Returns
bool

Definition at line 150 of file AuthAccountRecoveryTrait.php.

◆ passwordConfLabel()

passwordConfLabel ( )
abstractprotected

Reimplemented in AuthControllerConfig.

◆ passwordLabel()

passwordLabel ( )
abstractprotected

Reimplemented in AuthControllerConfig.

◆ passwordResetAction()

passwordResetAction ( string  $email,
string  $newPasswordHash 
)
protected

To override Changes the active password associated with the account corresponding to this email.

Parameters
string$email
string$newPasswordHash
Returns
bool

Definition at line 172 of file AuthAccountRecoveryTrait.php.

◆ prepareEmailAccountRecovery()

prepareEmailAccountRecovery ( string  $email)
protected

Definition at line 252 of file AuthAccountRecoveryTrait.php.

◆ recovery()

recovery ( string  $key,
string  $hashMail 
)

Definition at line 213 of file AuthAccountRecoveryTrait.php.

◆ recoveryAccountCaption()

recoveryAccountCaption ( )
protected

Returns the recovery account link caption.

Default : Forgot your password?

Returns
string

Reimplemented in AuthControllerConfig.

Definition at line 123 of file AuthAccountRecoveryTrait.php.

◆ recoveryEmailErrorMessage()

recoveryEmailErrorMessage ( FlashMessage  $fMessage)
protected

To override Displayed when email is not associated with an existing account.

Parameters
FlashMessage$fMessage

Definition at line 78 of file AuthAccountRecoveryTrait.php.

◆ recoveryEmailSendMessage()

recoveryEmailSendMessage ( FlashMessage  $fMessage)
protected

To override Displayed when email is sent for a recovery account operation.

Parameters
FlashMessage$fMessage

Definition at line 69 of file AuthAccountRecoveryTrait.php.

◆ recoveryInfo()

recoveryInfo ( )
Postcondition

Definition at line 199 of file AuthAccountRecoveryTrait.php.

◆ recoveryInit()

recoveryInit ( )

Definition at line 183 of file AuthAccountRecoveryTrait.php.

◆ recoveryInitMessage()

recoveryInitMessage ( FlashMessage  $fMessage)
protected

To override Displayed when an account recovery operation is initiated.

Parameters
FlashMessage$fMessage

Definition at line 60 of file AuthAccountRecoveryTrait.php.

◆ recoverySubmit()

recoverySubmit ( )
Postcondition

Definition at line 262 of file AuthAccountRecoveryTrait.php.

◆ resetPasswordErrorMessage()

resetPasswordErrorMessage ( FlashMessage  $fMessage)
protected

To override Displayed when an error occurs when a new password is set with recovery account.

Parameters
FlashMessage$fMessage

Definition at line 96 of file AuthAccountRecoveryTrait.php.

◆ resetPasswordSuccessMessage()

resetPasswordSuccessMessage ( FlashMessage  $fMessage)
protected

To override Displayed when a new password is set with recovery account.

Parameters
FlashMessage$fMessage

Definition at line 87 of file AuthAccountRecoveryTrait.php.

◆ useAjax()

useAjax ( )
abstractprotected

Reimplemented in AuthControllerConfig.

◆ validateEmail()

validateEmail ( string  $mail)
abstractprotected

Field Documentation

◆ $TOKENS_RECOVERY_ACCOUNT

string $TOKENS_RECOVERY_ACCOUNT ='account.recovery'
staticprotected

Definition at line 22 of file AuthAccountRecoveryTrait.php.

The documentation for this class was generated from the following file: