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

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