8000 minor #12873 backport some tweaks from 5.0 docs (xabbuh) · symfony/symfony-docs@ccad63b · GitHub
[go: up one dir, main page]

Skip to content

Commit ccad63b

Browse files
committed
minor #12873 backport some tweaks from 5.0 docs (xabbuh)
This PR was merged into the 3.4 branch. Discussion ---------- backport some tweaks from 5.0 docs backports the tweaks made by @atailouloute in #12856 that apply to 3.4 too Commits ------- 122e487 backport some tweaks from 5.0 docs
2 parents ab04fe8 + 122e487 commit ccad63b

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

security/guard_authentication.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ Finally, configure your ``firewalls`` key in ``security.yml`` to use this authen
333333
'logout' => true,
334334
'guard' => [
335335
'authenticators' => [
336-
TokenAuthenticator::class
336+
TokenAuthenticator::class,
337337
],
338338
],
339339
// ...
@@ -419,7 +419,7 @@ Each authenticator needs the following methods:
419419
the user authenticate (e.g. a 401 response that says "token is missing!").
420420

421421
**supportsRememberMe()**
422-
If you want to support "remember me" functionality, return true from this method.
422+
If you want to support "remember me" functionality, return ``true`` from this method.
423423
You will still need to activate ``remember_me`` under your firewall for it to work.
424424
Since this is a stateless API, you do not want to support "remember me"
425425
functionality in this example.
@@ -428,7 +428,8 @@ Each authenticator needs the following methods:
428428
If you are implementing the :class:`Symfony\\Component\\Security\\Guard\\AuthenticatorInterface`
429429
instead of extending the :class:`Symfony\\Component\\Security\\Guard\\AbstractGuardAuthenticator`
430430
class, you have to implement this method. It will be called
431-
after a successful authentication to create and return the token
431+
after a successful authentication to create and return the token (a
432+
class implementing :class:`Symfony\\Component\\Security\\Guard\\Token\\GuardTokenInterface`)
432433
for the user, who was supplied as the first argument.
433434

434435
The picture below shows how Symfony calls Guard Authenticator methods:

0 commit comments

Comments
 (0)
0