abstract class AuthenticationPlugin

Provides a common interface that will have to be implemented by all of the authentication plugins.

Properties

string $user Username
string $password Password
protected IpAllowDeny $ipAllowDeny
Template $template

Methods

__construct()

AuthenticationPlugin constructor.

boolean
showLoginForm()

Displays authentication form

boolean
readCredentials()

Gets authentication credentials

boolean
storeCredentials()

Set the user and password after last checkings if required

void
rememberCredentials()

Stores user credentials after successful login.

void
showFailure(string $failure)

User is not allowed to login to MySQL -> authentication failed

void
logOut()

Perform logout

string
getLoginFormURL()

Returns URL for login form.

string
getErrorMessage(string $failure)

Returns error message for failed authentication.

void
handlePasswordChange(string $password)

Callback when user changes password.

void
setSessionAccessTime()

Store session access time in session.

void
authenticate()

High level authentication interface

void
checkRules()

Check configuration defined restrictions for authentication

boolean|void
checkTwoFactor()

Checks whether two factor authentication is active for given user and performs it.

Details

at line 58
__construct()

AuthenticationPlugin constructor.

at line 69
abstract boolean showLoginForm()

Displays authentication form

Return Value

boolean

at line 76
abstract boolean readCredentials()

Gets authentication credentials

Return Value

boolean

at line 83
boolean storeCredentials()

Set the user and password after last checkings if required

Return Value

boolean

at line 100
void rememberCredentials()

Stores user credentials after successful login.

Return Value

void

at line 111
void showFailure(string $failure)

User is not allowed to login to MySQL -> authentication failed

Parameters

string $failure String describing why authentication has failed

Return Value

void

at line 121
void logOut()

Perform logout

Return Value

void

at line 174
string getLoginFormURL()

Returns URL for login form.

Return Value

string

at line 186
string getErrorMessage(string $failure)

Returns error message for failed authentication.

Parameters

string $failure String describing why authentication has failed

Return Value

string

at line 220
void handlePasswordChange(string $password)

Callback when user changes password.

Parameters

string $password New password to set

Return Value

void

at line 232
void setSessionAccessTime()

Store session access time in session.

Tries to workaround PHP 5 session garbage collection which looks at the session file's last modified time

Return Value

void

at line 259
void authenticate()

High level authentication interface

Gets the credentials or shows login form if necessary

Return Value

void

at line 281
void checkRules()

Check configuration defined restrictions for authentication

Return Value

void

at line 337
boolean|void checkTwoFactor()

Checks whether two factor authentication is active for given user and performs it.

Return Value

boolean|void