-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[Security] Add example to fetch User with CurrentUser attribute #18005
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.
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
Open
ker0x
wants to merge
1
commit into
symfony:6.2
Choose a base branch
from
ker0x:feature/currentuser-attribute
base: 6.2
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -1881,29 +1881,65 @@ Fetching the User Object | |||||
------------------------ | ||||||
|
||||||
After authentication, the ``User`` object of the current user can be | ||||||
accessed via the ``getUser()`` shortcut in the | ||||||
:ref:`base controller <the-base-controller-class-services>`:: | ||||||
accessed via the :ref:`#[CurrentUser] <controller-value-resolver-current-user>` attribute or ``getUser()`` shortcut in the | ||||||
:ref:`base controller <the-base-controller-class-services>`: | ||||||
|
||||||
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; | ||||||
.. configuration-block:: | ||||||
|
||||||
class ProfileController extends AbstractController | ||||||
{ | ||||||
public function index(): Response | ||||||
.. code-block:: php-attributes | ||||||
|
||||||
// src/Controller/ProfileController.php | ||||||
namespace App\Controller; | ||||||
|
||||||
use App\Entity\User; | ||||||
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; | ||||||
use Symfony\Component\Security\Http\Attribute\CurrentUser; | ||||||
|
||||||
class ProfileController extends AbstractController | ||||||
{ | ||||||
// usually you'll want to make sure the user is authenticated first, | ||||||
// see "Authorization" below | ||||||
$this->denyAccessUnlessGranted('IS_AUTHENTICATED_FULLY'); | ||||||
#[IsGranted('IS_AUTHENTICATED_FULLY')] | ||||||
public function index( | ||||||
// returns your User object, or null if the user is not authenticated | ||||||
#[CurrentUser] ?User $user | ||||||
): Response { | ||||||
// Call whatever methods you've added to your User class | ||||||
// For example, if you added a getFirstName() method, you can use that. | ||||||
return new Response('Well hi there '.$user->getFirstName()); | ||||||
} | ||||||
} | ||||||
|
||||||
// returns your User object, or null if the user is not authenticated | ||||||
// use inline documentation to tell your editor your exact User class | ||||||
/** @var \App\Entity\User $user */ | ||||||
$user = $this->getUser(); | ||||||
.. code-block:: php | ||||||
|
||||||
// src/Controller/ProfileController.php | ||||||
namespace App\Controller; | ||||||
|
||||||
// Call whatever methods you've added to your User class | ||||||
// For example, if you added a getFirstName() method, you can use that. | ||||||
return new Response('Well hi there '.$user->getFirstName()); | ||||||
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; | ||||||
|
||||||
class ProfileController extends AbstractController | ||||||
{ | ||||||
public function index(): Response | ||||||
{ | ||||||
// usually you'll want to make sure the user is authenticated first, | ||||||
// see "Authorization" below | ||||||
$this->denyAccessUnlessGranted('IS_AUTHENTICATED_FULLY'); | ||||||
|
||||||
// returns your User object, or null if the user is not authenticated | ||||||
// use inline documentation to tell your editor your exact User class | ||||||
/** @var \App\Entity\User $user */ | ||||||
$user = $this->getUser(); | ||||||
|
||||||
// Call whatever methods you've added to your User class | ||||||
// For example, if you added a getFirstName() method, you can use that. | ||||||
return new Response('Well hi there '.$user->getFirstName()); | ||||||
} | ||||||
} | ||||||
} | ||||||
|
||||||
.. note:: | ||||||
|
||||||
The ``#[CurrentUser]`` attribute can only be used in controller arguments to | ||||||
retrieve the authenticated user. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
Fetching the User from a Service | ||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what if $user result in being null like if someone remove the isgranted above
better force it to not null
and perhaps add other example with current user that may be null?