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
  25. {
  26.     protected $user;
  28.     private array $badges = [];
  29.     private array $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.     public function getUser(): UserInterface
  46.     {
  47.         if (null === $this->user) {
  48.             if (!$this->hasBadge(UserBadge::class)) {
  49.                 throw new \LogicException('Cannot get the Security user, no username or UserBadge configured for this passport.');
  50.             }
  52.             $this->user = $this->getBadge(UserBadge::class)->getUser();
  53.         }
  55.         return $this->user;
  56.     }
  58.     public function addBadge(BadgeInterface $badge): static
  59.     {
  60.         $this->badges[\get_class($badge)] = $badge;
  62.         return $this;
  63.     }
  65.     public function hasBadge(string $badgeFqcn): bool
  66.     {
  67.         return isset($this->badges[$badgeFqcn]);
  68.     }
  70.     public function getBadge(string $badgeFqcn): ?BadgeInterface
  71.     {
  72.         return $this->badges[$badgeFqcn] ?? null;
  73.     }
  75.     /**
  76.      * @return array<class-string<BadgeInterface>, BadgeInterface>
  77.      */
  78.     public function getBadges(): array
  79.     {
  80.         return $this->badges;
  81.     }
  83.     public function setAttribute(string $name, mixed $value): void
  84.     {
  85.         $this->attributes[$name] = $value;
  86.     }
  88.     public function getAttribute(string $name, mixed $default = null): mixed
  89.     {
  90.         return $this->attributes[$name] ?? $default;
  91.     }
  93.     public function getAttributes(): array
  94.     {
  95.         return $this->attributes;
  96.     }
  97. }