Authenticator
interface Authenticator (View source)
Abstract base class for an authentication method
This class is used as a base class for the different authentication methods like {@link MemberAuthenticator} or {@link OpenIDAuthenticator}.
Constants
| LOGIN |
Can log a user in |
| LOGOUT |
Can log user out |
| CHANGE_PASSWORD |
Can change password (check + reset) |
| RESET_PASSWORD |
Can modify password |
| CMS_LOGIN |
In-CMS authentication |
| CHECK_PASSWORD |
Can check password is valid without logging the user in or modifying the password |
Methods
Returns the services supported by this authenticator
Return RequestHandler to manage the log-in process.
Return the RequestHandler to manage the log-out process.
Return RequestHandler to manage the change-password process.
No description
Method to authenticate an user.
Check if the passed password matches the stored one (if the member is not locked out).
Details
int
supportedServices()
Returns the services supported by this authenticator
The number should be a bitwise-OR of 1 or more of the following constants: Authenticator::LOGIN, Authenticator::LOGOUT, Authenticator::CHANGE_PASSWORD, Authenticator::RESET_PASSWORD, or Authenticator::CMS_LOGIN
LoginHandler
getLoginHandler(string $link)
Return RequestHandler to manage the log-in process.
The default URL of the RequestHandler should return the initial log-in form, any other URL may be added for other steps & processing.
URL-handling methods may return an array [ "Form" => (form-object) ] which can then be merged into a default controller.
LogoutHandler
getLogOutHandler(string $link)
Return the RequestHandler to manage the log-out process.
The default URL of the RequestHandler should log the user out immediately and destroy the session.
getChangePasswordHandler(string $link)
Return RequestHandler to manage the change-password process.
The default URL of the RequetHandler should return the initial change-password form, any other URL may be added for other steps & processing.
URL-handling methods may return an array [ "Form" => (form-object) ] which can then be merged into a default controller.
mixed
getLostPasswordHandler(string $link)
Member
authenticate(array $data, HTTPRequest $request, ValidationResult $result = null)
Method to authenticate an user.
ValidationResult
checkPassword(Member $member, string $password, ValidationResult $result = null)
Check if the passed password matches the stored one (if the member is not locked out).
Note, we don't return early, to prevent differences in timings to give away if a member password is invalid.