Controller
class Controller extends AuthenticationTypeController (View source)
Traits
Trait LoggerAwareTrait A trait used with LoggerAwareInterface
Constants
| protected REQUIRED_PASSWORD_UPGRADE_SESSIONKEY |
|
Properties
| protected | $authenticationType | from AuthenticationTypeController | |
| protected | $app | from AuthenticationTypeController | |
| $apiMethods |
Methods
Get the logger channel expected by this LoggerAwareTrait implementation The user is expected to declare this method and return a valid channel name.
No description
No description
No description
No description
Called when a user tries to log in after his password has been reset by "Global Password Reset".
Called when a user wants a password reset email sent, is passed in the user's email address.
No description
No description
No description
No description
Method used to verify the user and log them in.
No description
Details
abstract string
getLoggerChannel()
Get the logger channel expected by this LoggerAwareTrait implementation The user is expected to declare this method and return a valid channel name.
string
getAuthenticationTypeIconHTML()
No description
view()
No description
__construct(AuthenticationType $type = null)
No description
AuthenticationType
getAuthenticationType()
No description
completeAuthentication(User $u)
tasks to finalize authentication, call on login events etc.
string
getHandle()
No description
deauthenticate(User $u)
Method used to clean up.
This method must be defined, if it isn't needed, leave it blank.
bool
verifyHash(User $u, string $hash)
Verify cookie hash to identify user.
string
buildHash(User $u, $test = 1)
Create a cookie hash to identify the user indefinitely.
bool
isAuthenticated(User $u)
Test user authentication status.
saveAuthenticationType($values)
No description
required_password_upgrade()
Called when a user tries to log in after his password has been reset by "Global Password Reset".
forgot_password()
Called when a user wants a password reset email sent, is passed in the user's email address.
private
passwordUpgrade(UserInfo|null $userInfo, ErrorList $error, bool $isForgotPassword)
No description
change_password($uHash = '')
No description
password_changed()
No description
email_validated($mode = false)
No description
invalid_token()
No description
User|null
authenticate()
Method used to verify the user and log them in.
Returning user will cause finishAuthentication to run, otherwise it's expected that the subclass manage completion.
protected
handleFailedLogin(LoginService $loginService, $uName, $uPassword, UserException $e)
No description
v($hash = '')
No description