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

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\Exception\UserNotFoundException;
  17. use Symfony\Component\Security\Core\User\UserInterface;
  18. use Symfony\Component\Security\Http\EventListener\UserProviderListener;
  20. /**
  21.  * Represents the user in the authentication process.
  22.  *
  23.  * It uses an identifier (e.g. email, or username) and
  24.  * "user loader" to load the related User object.
  25.  *
  26.  * @author Wouter de Jong <wouter@wouterj.nl>
  27.  */
  28. class UserBadge implements BadgeInterface
  29. {
  30.     private string $userIdentifier;
  31.     /** @var callable|null */
  32.     private $userLoader;
  33.     private $user;
  35.     /**
  36.      * Initializes the user badge.
  37.      *
  38.      * You must provide a $userIdentifier. This is a unique string representing the
  39.      * user for this authentication (e.g. the email if authentication is done using
  40.      * email + password; or a string combining email+company if authentication is done
  41.      * based on email *and* company name). This string can be used for e.g. login throttling.
  42.      *
  43.      * Optionally, you may pass a user loader. This callable receives the $userIdentifier
  44.      * as argument and must return a UserInterface object (otherwise an AuthenticationServiceException
  45.      * is thrown). If this is not set, the default user provider will be used with
  46.      * $userIdentifier as username.
  47.      */
  48.     public function __construct(string $userIdentifier, callable $userLoader = null)
  49.     {
  50.         $this->userIdentifier = $userIdentifier;
  51.         $this->userLoader = $userLoader;
  52.     }
  54.     public function getUserIdentifier(): string
  55.     {
  56.         return $this->userIdentifier;
  57.     }
  59.     /**
  60.      * @throws AuthenticationException when the user cannot be found
  61.      */
  62.     public function getUser(): UserInterface
  63.     {
  64.         if (null !== $this->user) {
  65.             return $this->user;
  66.         }
  68.         if (null === $this->userLoader) {
  69.             throw new \LogicException(sprintf('No user loader is configured, did you forget to register the "%s" listener?', UserProviderListener::class));
  70.         }
  72.         $user = ($this->userLoader)($this->userIdentifier);
  74.         // No user has been found via the $this->userLoader callback
  75.         if (null === $user) {
  76.             $exception = new UserNotFoundException();
  77.             $exception->setUserIdentifier($this->userIdentifier);
  79.             throw $exception;
  80.         }
  82.         if (!$user instanceof UserInterface) {
  83.             throw new AuthenticationServiceException(sprintf('The user provider must return a UserInterface object, "%s" given.', get_debug_type($user)));
  84.         }
  86.         return $this->user = $user;
  87.     }
  89.     public function getUserLoader(): ?callable
  90.     {
  91.         return $this->userLoader;
  92.     }
  94.     public function setUserLoader(callable $userLoader): void
  95.     {
  96.         $this->userLoader = $userLoader;
  97.     }
  99.     public function isResolved(): bool
  100.     {
  101.         return true;
  102.     }
  103. }