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

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 $userIdentifier;
  30.     private $userLoader;
  31.     private $user;
  33.     /**
  34.      * Initializes the user badge.
  35.      *
  36.      * You must provide a $userIdentifier. This is a unique string representing the
  37.      * user for this authentication (e.g. the email if authentication is done using
  38.      * email + password; or a string combining email+company if authentication is done
  39.      * based on email *and* company name). This string can be used for e.g. login throttling.
  40.      *
  41.      * Optionally, you may pass a user loader. This callable receives the $userIdentifier
  42.      * as argument and must return a UserInterface object (otherwise an AuthenticationServiceException
  43.      * is thrown). If this is not set, the default user provider will be used with
  44.      * $userIdentifier as username.
  45.      */
  46.     public function __construct(string $userIdentifier, callable $userLoader = null)
  47.     {
  48.         $this->userIdentifier = $userIdentifier;
  49.         $this->userLoader = $userLoader;
  50.     }
  52.     public function getUserIdentifier(): string
  53.     {
  54.         return $this->userIdentifier;
  55.     }
  57.     /**
  58.      * @throws AuthenticationException when the user cannot be found
  59.      */
  60.     public function getUser(): UserInterface
  61.     {
  62.         if (null === $this->user) {
  63.             if (null === $this->userLoader) {
  64.                 throw new \LogicException(sprintf('No user loader is configured, did you forget to register the "%s" listener?', UserProviderListener::class));
  65.             }
  67.             $this->user = ($this->userLoader)($this->userIdentifier);
  68.             if (!$this->user instanceof UserInterface) {
  69.                 throw new AuthenticationServiceException(sprintf('The user provider must return a UserInterface object, "%s" given.', get_debug_type($this->user)));
  70.             }
  71.         }
  73.         return $this->user;
  74.     }
  76.     public function getUserLoader(): ?callable
  77.     {
  78.         return $this->userLoader;
  79.     }
  81.     public function setUserLoader(callable $userLoader): void
  82.     {
  83.         $this->userLoader = $userLoader;
  84.     }
  86.     public function isResolved(): bool
  87.     {
  88.         return true;
  89.     }
  90. }