Drupal 8  8.0.2
UserLoginForm Class Reference
Inheritance diagram for UserLoginForm:

Public Member Functions

 __construct (FloodInterface $flood, UserStorageInterface $user_storage, UserAuthInterface $user_auth, RendererInterface $renderer)
 getFormId ()
 buildForm (array $form, FormStateInterface $form_state)
 submitForm (array &$form, FormStateInterface $form_state)
 validateName (array &$form, FormStateInterface $form_state)
 validateAuthentication (array &$form, FormStateInterface $form_state)
 validateFinal (array &$form, FormStateInterface $form_state)

Static Public Member Functions

static create (ContainerInterface $container)

Protected Attributes


Detailed Description

Provides a user login form.

Constructor & Destructor Documentation

__construct ( FloodInterface  $flood,
UserStorageInterface  $user_storage,
UserAuthInterface  $user_auth,
RendererInterface  $renderer 

Constructs a new UserLoginForm.

\Drupal\Core\Flood\FloodInterface$floodThe flood service.
\Drupal\user\UserStorageInterface$user_storageThe user storage.
\Drupal\user\UserAuthInterface$user_authThe user authentication object.
\Drupal\Core\Render\RendererInterface$rendererThe renderer.

References Drupal\flood().

Here is the call graph for this function:

Member Function Documentation

buildForm ( array  $form,
FormStateInterface  $form_state 


References Drupal\config(), and t().

Here is the call graph for this function:

static create ( ContainerInterface  $container)


getFormId ( )


submitForm ( array &  $form,
FormStateInterface  $form_state 


References FormStateInterface\get(), Drupal\request(), and FormStateInterface\setRedirect().

Here is the call graph for this function:

validateAuthentication ( array &  $form,
FormStateInterface  $form_state 

Checks supplied username/password against local users table.

If successful, $form_state->get('uid') is set to the matching user ID.

References Drupal\config(), Drupal\flood(), FormStateInterface\getValue(), FormStateInterface\isValueEmpty(), and FormStateInterface\set().

Here is the call graph for this function:

validateFinal ( array &  $form,
FormStateInterface  $form_state 

Checks if user was not authenticated, or if too many logins were attempted.

This validation function should always be the last one.

References Drupal\config(), Drupal\flood(), FormStateInterface\get(), FormStateInterface\getValue(), Drupal\logger(), FormStateInterface\setErrorByName(), t(), and Drupal\url().

Here is the call graph for this function:

validateName ( array &  $form,
FormStateInterface  $form_state 

Sets an error if supplied username has been blocked.

References FormStateInterface\getValue(), FormStateInterface\isValueEmpty(), FormStateInterface\setErrorByName(), and t().

Here is the call graph for this function:

The documentation for this class was generated from the following file: