vendor/symfony/security-http/Authenticator/Passport/Badge/UserBadge.php line 61

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Security\Http\Authenticator\Passport\Badge;
  14. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  15. use Symfony\Component\Security\Core\Exception\AuthenticationServiceException;
  16. use Symfony\Component\Security\Core\User\UserInterface;
  17. use Symfony\Component\Security\Http\EventListener\UserProviderListener;
  19. /**
  20.  * Represents the user in the authentication process.
  21.  *
  22.  * It uses an identifier (e.g. email, or username) and
  23.  * "user loader" to load the related User object.
  24.  *
  25.  * @author Wouter de Jong <wouter@wouterj.nl>
  26.  */
  27. class UserBadge implements BadgeInterface
  28. {
  29.     private string $userIdentifier;
  30.     /** @var callable|null */
  31.     private $userLoader;
  32.     private $user;
  34.     /**
  35.      * Initializes the user badge.
  36.      *
  37.      * You must provide a $userIdentifier. This is a unique string representing the
  38.      * user for this authentication (e.g. the email if authentication is done using
  39.      * email + password; or a string combining email+company if authentication is done
  40.      * based on email *and* company name). This string can be used for e.g. login throttling.
  41.      *
  42.      * Optionally, you may pass a user loader. This callable receives the $userIdentifier
  43.      * as argument and must return a UserInterface object (otherwise an AuthenticationServiceException
  44.      * is thrown). If this is not set, the default user provider will be used with
  45.      * $userIdentifier as username.
  46.      */
  47.     public function __construct(string $userIdentifier, callable $userLoader = null)
  48.     {
  49.         $this->userIdentifier = $userIdentifier;
  50.         $this->userLoader = $userLoader;
  51.     }
  53.     public function getUserIdentifier(): string
  54.     {
  55.         return $this->userIdentifier;
  56.     }
  58.     /**
  59.      * @throws AuthenticationException when the user cannot be found
  60.      */
  61.     public function getUser(): UserInterface
  62.     {
  63.         if (!isset($this->user)) {
  64.             if (null === $this->userLoader) {
  65.                 throw new \LogicException(sprintf('No user loader is configured, did you forget to register the "%s" listener?', UserProviderListener::class));
  66.             }
  68.             $user = ($this->userLoader)($this->userIdentifier);
  69.             if (!$user instanceof UserInterface) {
  70.                 throw new AuthenticationServiceException(sprintf('The user provider must return a UserInterface object, "%s" given.', get_debug_type($this->user)));
  71.             }
  73.             $this->user = $user;
  74.         }
  76.         return $this->user;
  77.     }
  79.     public function getUserLoader(): ?callable
  80.     {
  81.         return $this->userLoader;
  82.     }
  84.     public function setUserLoader(callable $userLoader): void
  85.     {
  86.         $this->userLoader = $userLoader;
  87.     }
  89.     public function isResolved(): bool
  90.     {
  91.         return true;
  92.     }
  93. }