Class SimpleID\Auth\LoginFormBuildEvent

`extends`	`FormBuildEvent`
`implements`	`StoppableEventInterface`
`uses`	`StoppableEventTrait`

An event used to build the login form.

This class is derived from SimpleID\Util\Forms\FormBuildEvent

, which uses SimpleID\Util\UI\UIBuilder

to build the form. This event uses a region key in the $additional array in the addBlock() method to associate each block with a region. Blocks in each region are sorted and displayed independently of each other.

The regions defined by this class, and their function, can be found in the documentation of the constants below.

SimpleID\Util\Events\BaseEvent
- SimpleID\Util\Events\UIBuildEvent implements GenericEventInterface, UIBuilderInterface uses GenericEventTrait
  - SimpleID\Util\Forms\FormBuildEvent implements FormEventInterface
    - SimpleID\Auth\LoginFormBuildEvent implements StoppableEventInterface uses StoppableEventTrait

Located at core/Auth/LoginFormBuildEvent.php

Methods


					
	public

addBlock(string $id, string $content, int $weight = 0, array $additional = []): UIBuildEvent

{@inheritdoc}

Parameters

`$id`	the block ID
`$content`	the contents
`$weight`	the weight
`$additional`	additional data

Overrides

SimpleID\Util\Events\UIBuildEvent::addBlock()


					
	public

showUIDBlock(array<string> $uid_autocomplete = []): UIBuildEvent

Show the user ID block when presenting the login form, and optionally add values to the autocomplete attribute in the user ID field.

Parameters

$uid_autocomplete

additional values to the autocomplete attribute to be inserted into the login form


					
	public

getBlocks(): array<array<mixed>>

{@inheritdoc}

Overrides

SimpleID\Util\Events\UIBuildEvent::getBlocks()


					
	public

getBlocksGroupedByRegion(): array<string, array<mixed>>

Retrieves the blocks grouped by region, ordered by the weight, from lowest to highest.


					
	public

getUIDAutocompleteValues(): array<string>

Methods inherited from SimpleID\Util\Forms\FormBuildEvent
`__construct(), getFormState()`

Methods inherited from SimpleID\Util\Events\UIBuildEvent
`getUIBuilder(), merge(), getBlockData(), addAttachment(), getAttachments(), getAttachmentTypes(), getAttachmentsByType(), reset()`

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

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

Constants
`public`	`IDENTITY_REGION = 'identity'` Constant denoting the `identity` region. The identity region contains a single block to allow the user to specify an identifier (such as the user name), or show the identifier if is already given. Constant denoting the `identity` region. The identity region contains a single block to allow the user to specify an identifier (such as the user name), or show the identifier if is already given. Authentication modules that require an identifer to be given should call the showUIDBlock() method. Otherwise no blocks should be added to this region.	#
`public`	`PASSWORD_REGION = 'password'` Constant denoting the `password` region. The password region is added by the PasswordAuthSchemeModule module, to be rendered in the DOM but hidden from the user unless it is required. This allows browser password managers to automatically fill in the password in the background. Constant denoting the `password` region. The password region is added by the PasswordAuthSchemeModule module, to be rendered in the DOM but hidden from the user unless it is required. This allows browser password managers to automatically fill in the password in the background. No other blocks should be added to this region.	#
`public`	`DEFAULT_REGION = 'default'` Constant denoting the `default` region. If a region is not specified when adding the block, the block will be added to this region. Constant denoting the `default` region. If a region is not specified when adding the block, the block will be added to this region. Note that blocks in the default region are rendered in the DOM, but not always shown to the user. For example, if the user is able to choose between multiple authentication methods, only the block associated with selected method is shown to the user, while other blocks are hidden. To always show a block, add it to the `options` region.	#
`public`	`OPTIONS_REGION = 'options'` Constant denoting the `options` region. Blocks in this region are rendered below the `default` region but above the submit button. Constant denoting the `options` region. Blocks in this region are rendered below the `default` region but above the submit button.	#
`public`	`SECONDARY_REGION = 'secondary'` Constant denoting the `secondary` region. Blocks in this region are always rendered below the default submit button. Constant denoting the `secondary` region. Blocks in this region are always rendered below the default submit button. If a block is added to this region, then a divider will be shown in the login form.	#

Constants inherited from SimpleID\Util\UI\AttachmentManagerInterface
`CSS_ATTACHMENT, JS_ATTACHMENT`

Properties
`protected`	`bool`	`$hasUIDBlock = false`	#
`protected`	`bool`	`$UIDBlockRendered = false`	#
`protected`	`array<string>`	`$UIDAutocompleteValues = []`	#

Properties inherited from SimpleID\Util\Forms\FormBuildEvent
`$form_state`

Properties inherited from SimpleID\Util\Events\UIBuildEvent
`$builder`

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

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

Namespaces

Classes

Interfaces

Traits

Class SimpleID\Auth\LoginFormBuildEvent

Parameters

Overrides

Parameters

Overrides