vendor/symfony/security-http/Authenticator/Passport/Passport.php line 24

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;
  14. use Symfony\Component\Security\Core\User\UserInterface;
  15. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\BadgeInterface;
  16. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
  17. use Symfony\Component\Security\Http\Authenticator\Passport\Credentials\CredentialsInterface;
  19. /**
  20.  * The default implementation for passports.
  21.  *
  22.  * @author Wouter de Jong <wouter@wouterj.nl>
  23.  */
  24. class Passport implements UserPassportInterface
  25. {
  26.     protected $user;
  28.     private $badges = [];
  29.     private $attributes = [];
  31.     /**
  32.      * @param CredentialsInterface $credentials the credentials to check for this authentication, use
  33.      *                                          SelfValidatingPassport if no credentials should be checked
  34.      * @param BadgeInterface[]     $badges
  35.      */
  36.     public function __construct(UserBadge $userBadge, CredentialsInterface $credentials, array $badges = [])
  37.     {
  38.         $this->addBadge($userBadge);
  39.         $this->addBadge($credentials);
  40.         foreach ($badges as $badge) {
  41.             $this->addBadge($badge);
  42.         }
  43.     }
  45.     /**
  46.      * {@inheritdoc}
  47.      */
  48.     public function getUser(): UserInterface
  49.     {
  50.         if (null === $this->user) {
  51.             if (!$this->hasBadge(UserBadge::class)) {
  52.                 throw new \LogicException('Cannot get the Security user, no username or UserBadge configured for this passport.');
  53.             }
  55.             $this->user = $this->getBadge(UserBadge::class)->getUser();
  56.         }
  58.         return $this->user;
  59.     }
  61.     /**
  62.      * @return $this
  63.      */
  64.     public function addBadge(BadgeInterface $badge): PassportInterface
  65.     {
  66.         $this->badges[\get_class($badge)] = $badge;
  68.         return $this;
  69.     }
  71.     public function hasBadge(string $badgeFqcn): bool
  72.     {
  73.         return isset($this->badges[$badgeFqcn]);
  74.     }
  76.     public function getBadge(string $badgeFqcn): ?BadgeInterface
  77.     {
  78.         return $this->badges[$badgeFqcn] ?? null;
  79.     }
  81.     /**
  82.      * @return array<class-string<BadgeInterface>, BadgeInterface>
  83.      */
  84.     public function getBadges(): array
  85.     {
  86.         return $this->badges;
  87.     }
  89.     /**
  90.      * @param mixed $value
  91.      */
  92.     public function setAttribute(string $name, $value): void
  93.     {
  94.         $this->attributes[$name] = $value;
  95.     }
  97.     /**
  98.      * @param mixed $default
  99.      *
  100.      * @return mixed
  101.      */
  102.     public function getAttribute(string $name, $default = null)
  103.     {
  104.         return $this->attributes[$name] ?? $default;
  105.     }
  107.     public function getAttributes(): array
  108.     {
  109.         return $this->attributes;
  110.     }
  111. }