Skip to content

Commit ca7bf7b

Browse files
committed
minor #17422 [Form][Security] Consistent naming of FormLoginAuthenticator (ThomasLandauer)
This PR was merged into the 5.4 branch. Discussion ---------- [Form][Security] Consistent naming of `FormLoginAuthenticator` Reason: Make it more clear that we're always talking about the same **built-in** thing. URL: https://symfony.com/doc/5.4/security.html Commits ------- 9262483 Consistent naming of `FormLoginAuthenticator`
2 parents 6856b71 + 9262483 commit ca7bf7b

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

security.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -648,7 +648,7 @@ Form Login
648648

649649
Most websites have a login form where users authenticate using an
650650
identifier (e.g. email address or username) and a password. This
651-
functionality is provided by the *form login authenticator*.
651+
functionality is provided by the built-in :class:`Symfony\\Component\\Security\\Http\Authenticator\\FormLoginAuthenticator`.
652652

653653
First, create a controller for the login form:
654654

@@ -679,7 +679,7 @@ First, create a controller for the login form:
679679
}
680680
}
681681
682-
Then, enable the form login authenticator using the ``form_login`` setting:
682+
Then, enable the ``FormLoginAuthenticator`` using the ``form_login`` setting:
683683

684684
.. configuration-block::
685685

@@ -772,8 +772,8 @@ Edit the login controller to render the login form:
772772
}
773773
}
774774
775-
Don't let this controller confuse you. Its job is only to *render* the form:
776-
the ``form_login`` authenticator will handle the form *submission* automatically.
775+
Don't let this controller confuse you. Its job is only to *render* the form.
776+
The ``FormLoginAuthenticator`` will handle the form *submission* automatically.
777777
If the user submits an invalid email or password, that authenticator will store
778778
the error and redirect back to this controller, where we read the error (using
779779
``AuthenticationUtils``) so that it can be displayed back to the user.
@@ -845,7 +845,7 @@ To review the whole process:
845845
#. The ``/login`` page renders login form via the route and controller created
846846
in this example;
847847
#. The user submits the login form to ``/login``;
848-
#. The security system (i.e. the ``form_login`` authenticator) intercepts the
848+
#. The security system (i.e. the ``FormLoginAuthenticator``) intercepts the
849849
request, checks the user's submitted credentials, authenticates the user if
850850
they are correct, and sends the user back to the login form if they are not.
851851

0 commit comments

Comments
 (0)