class Controller extends AuthenticationTypeController (View source)

Traits

Trait LoggerAwareTrait A trait used with LoggerAwareInterface

LoggerAwareTrait

Constants

protected REQUIRED_PASSWORD_UPGRADE_SESSIONKEY

Properties

protected $authenticationType from  AuthenticationTypeController
protected $app from  AuthenticationTypeController
$apiMethods

Methods

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
view()

No description

__construct(AuthenticationType $type = null)

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.

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.

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.

handleFailedLogin(LoginService $loginService, $uName, $uPassword, UserException $e)

No description

v($hash = '')

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.

Return Value

string

One of \Concrete\Core\Logging\Channels::CHANNEL_*

string getAuthenticationTypeIconHTML()

No description

view()

No description

__construct(AuthenticationType $type = null)

No description

Parameters

AuthenticationType $type

This type may be null only for access points that do not rely on the type.

AuthenticationType getAuthenticationType()

No description

Return Value

AuthenticationType

completeAuthentication(User $u)

tasks to finalize authentication, call on login events etc.

string getHandle()

No description

Return Value

string

See also

AuthenticationTypeController::getHandle

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.

Parameters

User $u

User object requesting verification.

string $hash

Return Value

bool

returns true if the hash is valid, false if not

See also

AuthenticationTypeControllerInterface::verifyHash

string buildHash(User $u, $test = 1)

Create a cookie hash to identify the user indefinitely.

Parameters

User $u
$test

Return Value

string

Unique hash to be used to verify the users identity

See also

AuthenticationTypeControllerInterface::buildHash

bool isAuthenticated(User $u)

Test user authentication status.

Parameters

User $u

Return Value

bool

Returns true if user is authenticated, false if not

See also

AuthenticationTypeControllerInterface::isAuthenticated

saveAuthenticationType($values)

No description

Parameters

$values

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

Parameters

UserInfo|null $userInfo
ErrorList $error
bool $isForgotPassword

change_password($uHash = '')

No description

Parameters

$uHash

password_changed()

No description

email_validated($mode = false)

No description

Parameters

$mode

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

Parameters

LoginService $loginService
$uName
$uPassword
UserException $e

v($hash = '')

No description

Parameters

$hash