AuthenticationPlugin
abstract class AuthenticationPlugin (View source)
Provides a common interface that will have to be implemented by all the authentication plugins.
Properties
| string | $user | Username | |
| string | $password | Password | |
| protected IpAllowDeny | $ipAllowDeny | ||
| Template | $template |
Methods
No description
Displays authentication form
Gets authentication credentials
Set the user and password after last checkings if required
Stores user credentials after successful login.
User is not allowed to login to MySQL -> authentication failed
Perform logout
Returns URL for login form.
Callback when user changes password.
Store session access time in session.
High level authentication interface
Check configuration defined restrictions for authentication
Checks whether two-factor authentication is active for given user and performs it.
Details
__construct()
No description
abstract Response|null
showLoginForm()
Displays authentication form
abstract bool
readCredentials()
Gets authentication credentials
bool
storeCredentials()
Set the user and password after last checkings if required
Response|null
rememberCredentials()
Stores user credentials after successful login.
abstract Response
showFailure(AuthenticationFailure $failure)
User is not allowed to login to MySQL -> authentication failed
protected void
logFailure(AuthenticationFailure $failure)
No description
void
logOut()
Perform logout
string
getLoginFormURL()
Returns URL for login form.
string
getErrorMessage(AuthenticationFailure $failure)
Returns error message for failed authentication.
void
handlePasswordChange(string $password)
Callback when user changes password.
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
Response|null
authenticate()
High level authentication interface
Gets the credentials or shows login form if necessary
void
checkRules()
Check configuration defined restrictions for authentication
Response|null
checkTwoFactor(ServerRequest $request)
Checks whether two-factor authentication is active for given user and performs it.