abstract class AuthenticationPlugin (View source)

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

No description

bool
showLoginForm()

Displays authentication form

bool
readCredentials()

Gets authentication credentials

bool
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

void
checkTwoFactor()

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

Details

__construct()

abstract bool showLoginForm()

Displays authentication form

Return Value

bool

abstract bool readCredentials()

Gets authentication credentials

Return Value

bool

bool storeCredentials()

Set the user and password after last checkings if required

Return Value

bool

void rememberCredentials()

Stores user credentials after successful login.

Return Value

void

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

void logOut()

Perform logout

Return Value

void

string getLoginFormURL()

Returns URL for login form.

Return Value

string

string getErrorMessage(string $failure)

Returns error message for failed authentication.

Parameters

string $failure String describing why authentication has failed

Return Value

string

void handlePasswordChange(string $password)

Callback when user changes password.

Parameters

string $password New password to set

Return Value

void

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

void authenticate()

High level authentication interface

Gets the credentials or shows login form if necessary

Return Value

void

void checkRules()

Check configuration defined restrictions for authentication

Return Value

void

void checkTwoFactor()

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

Return Value

void