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

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. * A Passport contains all security-related information that needs to be
  21. * validated during authentication.
  22. *
  23. * A passport badge can be used to add any additional information to the
  24. * passport.
  25. *
  26. * @author Wouter de Jong <wouter@wouterj.nl>
  27. */
  28. class Passport implements UserPassportInterface
  29. {
  30. protected $user;
  32. private $badges = [];
  33. private $attributes = [];
  35. /**
  36. * @param CredentialsInterface $credentials the credentials to check for this authentication, use
  37. * SelfValidatingPassport if no credentials should be checked
  38. * @param BadgeInterface[] $badges
  39. */
  40. public function __construct(UserBadge $userBadge, CredentialsInterface $credentials, array $badges = [])
  41. {
  42. $this->addBadge($userBadge);
  43. $this->addBadge($credentials);
  44. foreach ($badges as $badge) {
  45. $this->addBadge($badge);
  46. }
  47. }
  49. /**
  50. * {@inheritdoc}
  51. */
  52. public function getUser(): UserInterface
  53. {
  54. if (null === $this->user) {
  55. if (!$this->hasBadge(UserBadge::class)) {
  56. throw new \LogicException('Cannot get the Security user, no username or UserBadge configured for this passport.');
  57. }
  59. $this->user = $this->getBadge(UserBadge::class)->getUser();
  60. }
  62. return $this->user;
  63. }
  65. /**
  66. * Adds a new security badge.
  67. *
  68. * A passport can hold only one instance of the same security badge.
  69. * This method replaces the current badge if it is already set on this
  70. * passport.
  71. *
  72. * @return $this
  73. */
  74. public function addBadge(BadgeInterface $badge): PassportInterface
  75. {
  76. $this->badges[\get_class($badge)] = $badge;
  78. return $this;
  79. }
  81. public function hasBadge(string $badgeFqcn): bool
  82. {
  83. return isset($this->badges[$badgeFqcn]);
  84. }
  86. public function getBadge(string $badgeFqcn): ?BadgeInterface
  87. {
  88. return $this->badges[$badgeFqcn] ?? null;
  89. }
  91. /**
  92. * @return array<class-string<BadgeInterface>, BadgeInterface>
  93. */
  94. public function getBadges(): array
  95. {
  96. return $this->badges;
  97. }
  99. /**
  100. * @param mixed $value
  101. */
  102. public function setAttribute(string $name, $value): void
  103. {
  104. $this->attributes[$name] = $value;
  105. }
  107. /**
  108. * @param mixed $default
  109. *
  110. * @return mixed
  111. */
  112. public function getAttribute(string $name, $default = null)
  113. {
  114. return $this->attributes[$name] ?? $default;
  115. }
  117. public function getAttributes(): array
  118. {
  119. return $this->attributes;
  120. }
  121. }