Skip to content

Updated "Authentication System with Guard" Page #7215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 13, 2016
Merged

Updated "Authentication System with Guard" Page #7215

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f8e201f
Update guard_authentication.rst
Dec 3, 2016
33c0d35
Accepted suggestions in the guard documentation
powerdan Dec 3, 2016
b2f20f4
Accepted suggestions in the guard documentation
powerdan Dec 3, 2016
cb3abf3
Accepted suggestions in the guard documentation
powerdan Dec 3, 2016
d17b180
Accepted Suggestions
powerdan Dec 13, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions security/guard_authentication.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,11 +412,18 @@ Each authenticator needs the following methods:
:class:`Symfony\\Component\\HttpFoundation\\Response` object that helps
the user authenticate (e.g. a 401 response that says "token is missing!").

**supportsRememberMe**
**supportsRememberMe()**
If you want to support "remember me" functionality, return true from this method.
You will still need to active ``remember_me`` under your firewall for it to work.
Since this is a stateless API, you do not want to support "remember me"
functionality in this example.

**createAuthenticatedToken(UserInterface $user, string $providerKey)**
If you are implementing the :class:`Symfony\\Component\\Security\\Guard\\GuardAuthenticatorInterface`
class instead of extending the :class:`Symfony\\Component\\Security\\Guard\\AbstractGuardAuthenticator`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@powerdan Sorry about that but class that you added here should be reverted. GuardAuthenticatorInterface is an interface, but not a class. Though as Interface is already part of the name we shouldn't add the word "interface" instead of "class". We should only keep the one after AbstractGuardAuthenticator.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Youre absolutely right. It seems that i am kind of tired after that week.... (in berlin since monday)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I completely understand that. :)

class, you have to implement this method. This method will be called
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like the ... this method. This method ... repetition in this line. How could we reword it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changing it to ... this method. It will be called... seems pretty simple, but im not really happy with it. What does you people think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... this method. It will be called... sounds completely valid to me.

after a successful authentication to create and return the token
for the user, who was supplied as the first argument.

.. _guard-customize-error:

Expand Down Expand Up @@ -552,7 +559,7 @@ Frequently Asked Questions
),
));

**Can I use this with ``form_login``?**
**Can I use this with form_login?**
Yes! ``form_login`` is *one* way to authenticate a user, so you could use
it *and* then add one or more authenticators. Using a guard authenticator doesn't
collide with other ways to authenticate.
Expand Down