class Controller extends AuthenticationTypeController (View source)

Properties

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

Methods

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.

genString($a = 16)

No description

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.

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.

isPasswordReset()

No description

v($hash = '')

No description

Details

getAuthenticationTypeIconHTML()

view()

__construct(AuthenticationType $type = null)

Parameters

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

getAuthenticationType()

completeAuthentication(User $u)

tasks to finalize authentication, call on login events etc.

Parameters

User $u

string getHandle()

Return Value

string

deauthenticate(User $u)

Method used to clean up.

This method must be defined, if it isn't needed, leave it blank.

Parameters

User $u

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

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

private genString($a = 16)

Parameters

$a

bool isAuthenticated(User $u)

Test user authentication status.

Parameters

User $u

Return Value

bool Returns true if user is authenticated, false if not

saveAuthenticationType($values)

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.

change_password($uHash = '')

Parameters

$uHash

password_changed()

email_validated($mode = false)

Parameters

$mode

invalid_token()

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.

Return Value

User|null

Exceptions

AuthenticationTypeFailureException

private isPasswordReset()

v($hash = '')

Parameters

$hash