extends |
AuditEvent |
|---|---|
implements |
FormEventInterface |
Event to log in a user.
This event is dispatched when all the authentication components are completed. Listeners can use this hook to save any authentication information.
The state of the login form (if any) used in the process can be
obtained from the getFormState() method. It contains the same
elements as per the login_form_build event.
This event also provides further information on the authentication result via the getAuthResult() method. Convenience methods getUser() and getAuthLevel() are also included.
| Methods | ||
|---|---|---|
public
|
__construct(AuthResultInterface $result, FormState|null $form_state = null)
|
# |
public
|
getAuthResult(): AuthResultInterface
|
# |
public
|
getFormState()
|
# |
public
|
getUser(): User
|
# |
public
|
getAuthLevel(): int
|
# |
| Methods inherited from SimpleID\Base\AuditEvent |
|---|
getTime(), getIP(), getUserAgent(), getLocation(), getSubject(), getClient(), getAuditEventName() |
| Properties | |||
|---|---|---|---|
protected
|
AuthResultInterface
|
$result
|
# |
protected
|
FormState|null
|
$form_state = null
|
# |
| Properties inherited from SimpleID\Base\AuditEvent |
|---|
$time, $ip, $userAgent, $location, $subject, $client |