Class SimpleID\Auth\LoginFormSubmitEvent

`extends`	`FormSubmitEvent`
`implements`	`AuthResultInterface`
`uses`	`AuthResultTrait`

An event used to process the login form.

SimpleID\Util\Events\BaseEvent
- SimpleID\Util\Forms\FormSubmitEvent implements GenericEventInterface, StoppableEventInterface, FormEventInterface uses GenericEventTrait, StoppableEventTrait
  - SimpleID\Auth\LoginFormSubmitEvent implements AuthResultInterface uses AuthResultTrait

Located at core/Auth/LoginFormSubmitEvent.php

Methods


					
	public

__construct(FormState $form_state, string $eventName = null)

Creates a form submission event

Parameters

`$form_state`	a reference to the form state array
`$eventName`	the name of the event, or the name

Overrides

SimpleID\Util\Forms\FormSubmitEvent::__construct()


					
	public

isAuthSuccessful()

{@inheritdoc}

Returns

true if authentication was successful

Implements

SimpleID\Auth\AuthResultInterface::isAuthSuccessful()


					
	public

setUser(User $user): void

Set the user object for the user that has been automatically authenticated.

Parameters

$user

the user


					
	public

setAuthLevel(int $auth_level): void

Sets the authentication level.

If the authentication level specified in the parameter is less than the level set by previous listeners to this event, it is ignored.

Parameters

$auth_level

the authentication level


					
	public

addAuthModuleName(string $auth_module_name): void

Adds the name of the module that authenticated the user

Parameters

$auth_module_name

the name of the module that authenticated the user

Methods inherited from SimpleID\Util\Forms\FormSubmitEvent
`getFormState(), addMessage(), getMessages(), setInvalid(), isValid()`

Methods used from SimpleID\Util\Events\GenericEventTrait
`setEventName(), getEventName()`

Methods used from SimpleID\Util\Events\StoppableEventTrait
`isPropagationStopped(), stopPropagation()`

Methods used from SimpleID\Auth\AuthResultTrait
`getUser(), getAuthLevel(), getACR(), getAuthModuleNames()`

Properties inherited from SimpleID\Util\Forms\FormSubmitEvent
`$form_state, $is_valid, $messages`

Properties used from SimpleID\Util\Events\GenericEventTrait
`$eventName`

Properties used from SimpleID\Util\Events\StoppableEventTrait
`$stopped`

Properties used from SimpleID\Auth\AuthResultTrait
`$user, $auth_level, $auth_module_names, $acr`

Namespaces

Classes

Interfaces

Traits

Class SimpleID\Auth\LoginFormSubmitEvent

Parameters

Overrides

Returns

Implements

Parameters

Parameters

Parameters