| Methods |
public
static
|
init($f3)
|
#
|
public
|
__construct()
|
#
|
public
|
beforeroute()
FatFree Framework event handler.
FatFree Framework event handler.
This module does not use the default event handler provided by SimpleID\Module
,
as it needs to disable the automatic authentication.
|
#
|
public
|
login(Base $f3, array<string, mixed> $params): void
Attempts to log in a user, using the credentials specified in the
HTTP request.
Attempts to log in a user, using the credentials specified in the
HTTP request.
|
#
|
public
|
logout(Base $f3, array<string, mixed> $params): void
Attempts to log out a user and returns to the login form.
Attempts to log out a user and returns to the login form.
|
#
|
public
|
loginForm(array<string, mixed> $params = ['destination' => null], FormState $form_state = null): void
Displays a user login or a login verification form.
Displays a user login or a login verification form.
The following common additional variables are stored in the form state ($form_state):
-
auth_level - if login is successful, the authentication level
-
auth_skip_activity - true if the login should not be recorded in the activity
log
-
cancel - if the login form is cancellable, a string to identify the module to
handle the cancellation event
-
mode - one of the AuthManager::MODE constants to determine the mode of the form
-
modules - if login is successful, an array of authentication modules
-
uid - the user ID entered by the user or requested for verification
-
verify_forms - if mode is AuthManager::MODE_VERIFY, an array of UI blocks containing
the verificationinterface
Authentication modules may define additional variables in the form state.
Parameters
| $params |
the F3 parameters
|
| $form_state |
|null the form state
|
|
#
|