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

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

+ Inheritance diagram for AuthControllerVariablesTrait:

Public Member Functions

 _displayInfoAsString ()
 Override to define if user info is displayed as string.
 
 _getUserSessionKey ()
 To override for defining user session key, default : "activeUser".
 
 _checkConnectionTimeout ()
 
 _getLoginInputName ()
 
 _getPasswordInputName ()
 
 _getBodySelector ()
 Returns the body selector (jquery selector used for replacing the content of the page).
 

Protected Member Functions

 noAccessMessage (FlashMessage $fMessage)
 Override for modifying the noAccess message.
 
 attemptsNumberMessage (FlashMessage $fMessage, $attempsCount)
 Override for modifying attempts message You can use {_timer} and {_attemptsCount} variables in message content.
 
 badLoginMessage (FlashMessage $fMessage)
 To override for modifying the bad login message.
 
 terminateMessage (FlashMessage $fMessage)
 To override for modifying the logout message.
 
 disconnectedMessage (FlashMessage $fMessage)
 To override for modifying the disconnect message.
 
 attemptsNumber ()
 To override Returns int the maximum number of allowed login attempts.
 
 attemptsTimeout ()
 To override Returns the time before trying to connect again Effective only if attemptsNumber return a number.
 
 loginLabel ()
 
 passwordLabel ()
 
 passwordConfLabel ()
 
 rememberCaption ()
 

Detailed Description

Ubiquity\controllers\auth$AuthControllerVariablesTrait This class is part of Ubiquity.

Author
jc
Version
1.0.0

Definition at line 15 of file AuthControllerVariablesTrait.php.

Member Function Documentation

◆ _checkConnectionTimeout()

_checkConnectionTimeout ( )

Definition at line 95 of file AuthControllerVariablesTrait.php.

◆ _displayInfoAsString()

_displayInfoAsString ( )

Override to define if user info is displayed as string.

If set to true, use {{ _infoUser| raw }} in views to display user info. Remember to use $this->jquery->renderView instead of $this->loadView for the javascript generation.

Reimplemented in AuthControllerConfig.

Definition at line 83 of file AuthControllerVariablesTrait.php.

◆ _getBodySelector()

_getBodySelector ( )

Returns the body selector (jquery selector used for replacing the content of the page).

default: main .container

Returns
string

Reimplemented in AuthControllerConfig.

Definition at line 125 of file AuthControllerVariablesTrait.php.

◆ _getLoginInputName()

_getLoginInputName ( )

Reimplemented in AuthControllerConfig.

Definition at line 99 of file AuthControllerVariablesTrait.php.

◆ _getPasswordInputName()

_getPasswordInputName ( )

Reimplemented in AuthControllerConfig.

Definition at line 107 of file AuthControllerVariablesTrait.php.

◆ _getUserSessionKey()

_getUserSessionKey ( )

To override for defining user session key, default : "activeUser".

Returns
string

Reimplemented in AuthControllerConfig.

Definition at line 91 of file AuthControllerVariablesTrait.php.

◆ attemptsNumber()

attemptsNumber ( )
protected

To override Returns int the maximum number of allowed login attempts.

Reimplemented in AuthControllerConfig.

Definition at line 63 of file AuthControllerVariablesTrait.php.

◆ attemptsNumberMessage()

attemptsNumberMessage ( FlashMessage  $fMessage,
  $attempsCount 
)
protected

Override for modifying attempts message You can use {_timer} and {_attemptsCount} variables in message content.

Parameters
FlashMessage$fMessage
int$attempsCount

Definition at line 32 of file AuthControllerVariablesTrait.php.

◆ attemptsTimeout()

attemptsTimeout ( )
protected

To override Returns the time before trying to connect again Effective only if attemptsNumber return a number.

Returns
int

Reimplemented in AuthControllerConfig.

Definition at line 74 of file AuthControllerVariablesTrait.php.

◆ badLoginMessage()

badLoginMessage ( FlashMessage  $fMessage)
protected

To override for modifying the bad login message.

Parameters
FlashMessage$fMessage

Definition at line 40 of file AuthControllerVariablesTrait.php.

◆ disconnectedMessage()

disconnectedMessage ( FlashMessage  $fMessage)
protected

To override for modifying the disconnect message.

Parameters
FlashMessage$fMessage

Definition at line 56 of file AuthControllerVariablesTrait.php.

◆ loginLabel()

loginLabel ( )
protected

Reimplemented in AuthControllerConfig.

Definition at line 103 of file AuthControllerVariablesTrait.php.

◆ noAccessMessage()

noAccessMessage ( FlashMessage  $fMessage)
protected

Override for modifying the noAccess message.

Parameters
FlashMessage$fMessage

Definition at line 22 of file AuthControllerVariablesTrait.php.

◆ passwordConfLabel()

passwordConfLabel ( )
protected

Reimplemented in AuthControllerConfig.

Definition at line 115 of file AuthControllerVariablesTrait.php.

◆ passwordLabel()

passwordLabel ( )
protected

Reimplemented in AuthControllerConfig.

Definition at line 111 of file AuthControllerVariablesTrait.php.

◆ rememberCaption()

rememberCaption ( )
protected

Reimplemented in AuthControllerConfig.

Definition at line 129 of file AuthControllerVariablesTrait.php.

◆ terminateMessage()

terminateMessage ( FlashMessage  $fMessage)
protected

To override for modifying the logout message.

Parameters
FlashMessage$fMessage

Definition at line 48 of file AuthControllerVariablesTrait.php.

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