vendor/symfony/security-core/User/User.php line 21

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\Core\User;
  14. /**
  15.  * User is the user implementation used by the in-memory user provider.
  16.  *
  17.  * This should not be used for anything else.
  18.  *
  19.  * @author Fabien Potencier <fabien@symfony.com>
  20.  */
  21. final class User implements UserInterface, EquatableInterface, AdvancedUserInterface
  22. {
  23.     private $username;
  24.     private $password;
  25.     private $enabled;
  26.     private $accountNonExpired;
  27.     private $credentialsNonExpired;
  28.     private $accountNonLocked;
  29.     private $roles;
  30.     private $extraFields;
  32.     public function __construct(?string $username, ?string $password, array $roles = [], bool $enabled = true, bool $userNonExpired = true, bool $credentialsNonExpired = true, bool $userNonLocked = true, array $extraFields = [])
  33.     {
  34.         if ('' === $username || null === $username) {
  35.             throw new \InvalidArgumentException('The username cannot be empty.');
  36.         }
  38.         $this->username = $username;
  39.         $this->password = $password;
  40.         $this->enabled = $enabled;
  41.         $this->accountNonExpired = $userNonExpired;
  42.         $this->credentialsNonExpired = $credentialsNonExpired;
  43.         $this->accountNonLocked = $userNonLocked;
  44.         $this->roles = $roles;
  45.         $this->extraFields = $extraFields;
  46.     }
  48.     public function __toString(): string
  49.     {
  50.         return $this->getUsername();
  51.     }
  53.     /**
  54.      * {@inheritdoc}
  55.      */
  56.     public function getRoles(): array
  57.     {
  58.         return $this->roles;
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function getPassword(): ?string
  65.     {
  66.         return $this->password;
  67.     }
  69.     /**
  70.      * {@inheritdoc}
  71.      */
  72.     public function getSalt(): ?string
  73.     {
  74.         return null;
  75.     }
  77.     /**
  78.      * {@inheritdoc}
  79.      */
  80.     public function getUsername(): string
  81.     {
  82.         return $this->username;
  83.     }
  85.     /**
  86.      * {@inheritdoc}
  87.      */
  88.     public function isAccountNonExpired(): bool
  89.     {
  90.         return $this->accountNonExpired;
  91.     }
  93.     /**
  94.      * {@inheritdoc}
  95.      */
  96.     public function isAccountNonLocked(): bool
  97.     {
  98.         return $this->accountNonLocked;
  99.     }
  101.     /**
  102.      * {@inheritdoc}
  103.      */
  104.     public function isCredentialsNonExpired(): bool
  105.     {
  106.         return $this->credentialsNonExpired;
  107.     }
  109.     /**
  110.      * {@inheritdoc}
  111.      */
  112.     public function isEnabled(): bool
  113.     {
  114.         return $this->enabled;
  115.     }
  117.     /**
  118.      * {@inheritdoc}
  119.      */
  120.     public function eraseCredentials()
  121.     {
  122.     }
  124.     public function getExtraFields(): array
  125.     {
  126.         return $this->extraFields;
  127.     }
  129.     /**
  130.      * {@inheritdoc}
  131.      */
  132.     public function isEqualTo(UserInterface $user): bool
  133.     {
  134.         if (!$user instanceof self) {
  135.             return false;
  136.         }
  138.         if ($this->getPassword() !== $user->getPassword()) {
  139.             return false;
  140.         }
  142.         if ($this->getSalt() !== $user->getSalt()) {
  143.             return false;
  144.         }
  146.         $currentRoles = array_map('strval', (array) $this->getRoles());
  147.         $newRoles = array_map('strval', (array) $user->getRoles());
  148.         $rolesChanged = \count($currentRoles) !== \count($newRoles) || \count($currentRoles) !== \count(array_intersect($currentRoles, $newRoles));
  149.         if ($rolesChanged) {
  150.             return false;
  151.         }
  153.         if ($this->getUsername() !== $user->getUsername()) {
  154.             return false;
  155.         }
  157.         if ($this->isAccountNonExpired() !== $user->isAccountNonExpired()) {
  158.             return false;
  159.         }
  161.         if ($this->isAccountNonLocked() !== $user->isAccountNonLocked()) {
  162.             return false;
  163.         }
  165.         if ($this->isCredentialsNonExpired() !== $user->isCredentialsNonExpired()) {
  166.             return false;
  167.         }
  169.         if ($this->isEnabled() !== $user->isEnabled()) {
  170.             return false;
  171.         }
  173.         return true;
  174.     }
  176.     public function setPassword(string $password)
  177.     {
  178.         $this->password = $password;
  179.     }
  180. }