vendor/friendsofsymfony/user-bundle/Model/User.php line 23

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the FOSUserBundle package.
  4.  *
  5.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.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 FOS\UserBundle\Model;
  11. use Symfony\Component\Security\Core\User\EquatableInterface;
  12. use Symfony\Component\Security\Core\User\UserInterface as BaseUserInterface;
  13. /**
  14.  * Storage agnostic user object.
  15.  *
  16.  * @author Thibault Duplessis <thibault.duplessis@gmail.com>
  17.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  18.  */
  19. abstract class User implements UserInterfaceEquatableInterface\Serializable
  20. {
  21.     /**
  22.      * @var mixed
  23.      */
  24.     protected $id;
  25.     /**
  26.      * @var string
  27.      */
  28.     protected $username;
  29.     /**
  30.      * @var string
  31.      */
  32.     protected $usernameCanonical;
  33.     /**
  34.      * @var string
  35.      */
  36.     protected $email;
  37.     /**
  38.      * @var string
  39.      */
  40.     protected $emailCanonical;
  41.     /**
  42.      * @var bool
  43.      */
  44.     protected $enabled;
  45.     /**
  46.      * The salt to use for hashing.
  47.      *
  48.      * @var string
  49.      */
  50.     protected $salt;
  51.     /**
  52.      * Encrypted password. Must be persisted.
  53.      *
  54.      * @var string
  55.      */
  56.     protected $password;
  57.     /**
  58.      * Plain password. Used for model validation. Must not be persisted.
  59.      *
  60.      * @var string|null
  61.      */
  62.     protected $plainPassword;
  63.     /**
  64.      * @var \DateTime|null
  65.      */
  66.     protected $lastLogin;
  67.     /**
  68.      * Random string sent to the user email address in order to verify it.
  69.      *
  70.      * @var string|null
  71.      */
  72.     protected $confirmationToken;
  73.     /**
  74.      * @var \DateTime|null
  75.      */
  76.     protected $passwordRequestedAt;
  77.     /**
  78.      * @var array
  79.      */
  80.     protected $roles;
  81.     /**
  82.      * User constructor.
  83.      */
  84.     public function __construct()
  85.     {
  86.         $this->enabled false;
  87.         $this->roles = [];
  88.     }
  89.     /**
  90.      * @return string
  91.      */
  92.     public function __toString()
  93.     {
  94.         return (string) $this->getUsername();
  95.     }
  96.     public function __serialize(): array
  97.     {
  98.         return [
  99.             $this->password,
  100.             $this->salt,
  101.             $this->usernameCanonical,
  102.             $this->username,
  103.             $this->enabled,
  104.             $this->id,
  105.             $this->email,
  106.             $this->emailCanonical,
  107.         ];
  108.     }
  109.     public function __unserialize(array $data): void
  110.     {
  111.         if (13 === count($data)) {
  112.             // Unserializing a User object from 1.3.x
  113.             unset($data[4], $data[5], $data[6], $data[9], $data[10]);
  114.             $data array_values($data);
  115.         } elseif (11 === count($data)) {
  116.             // Unserializing a User from a dev version somewhere between 2.0-alpha3 and 2.0-beta1
  117.             unset($data[4], $data[7], $data[8]);
  118.             $data array_values($data);
  119.         }
  120.         list(
  121.             $this->password,
  122.             $this->salt,
  123.             $this->usernameCanonical,
  124.             $this->username,
  125.             $this->enabled,
  126.             $this->id,
  127.             $this->email,
  128.             $this->emailCanonical
  129.         ) = $data;
  130.     }
  131.     /**
  132.      * @internal
  133.      */
  134.     final public function serialize()
  135.     {
  136.         return serialize($this->__serialize());
  137.     }
  138.     /**
  139.      * @internal
  140.      */
  141.     final public function unserialize($serialized)
  142.     {
  143.         $this->__unserialize(unserialize($serialized));
  144.     }
  145.     public function addRole($role)
  146.     {
  147.         $role strtoupper($role);
  148.         if ($role === static::ROLE_DEFAULT) {
  149.             return $this;
  150.         }
  151.         if (!in_array($role$this->rolestrue)) {
  152.             $this->roles[] = $role;
  153.         }
  154.         return $this;
  155.     }
  156.     /**
  157.      * @return void
  158.      */
  159.     public function eraseCredentials()
  160.     {
  161.         $this->plainPassword null;
  162.     }
  163.     public function getId()
  164.     {
  165.         return $this->id;
  166.     }
  167.     public function getUserIdentifier(): string
  168.     {
  169.         return $this->username;
  170.     }
  171.     /**
  172.      * @return string
  173.      */
  174.     public function getUsername()
  175.     {
  176.         return $this->username;
  177.     }
  178.     public function getUsernameCanonical()
  179.     {
  180.         return $this->usernameCanonical;
  181.     }
  182.     public function getSalt(): ?string
  183.     {
  184.         return $this->salt;
  185.     }
  186.     public function getEmail()
  187.     {
  188.         return $this->email;
  189.     }
  190.     public function getEmailCanonical()
  191.     {
  192.         return $this->emailCanonical;
  193.     }
  194.     public function getPassword(): ?string
  195.     {
  196.         return $this->password;
  197.     }
  198.     public function getPlainPassword()
  199.     {
  200.         return $this->plainPassword;
  201.     }
  202.     /**
  203.      * Gets the last login time.
  204.      *
  205.      * @return \DateTime|null
  206.      */
  207.     public function getLastLogin()
  208.     {
  209.         return $this->lastLogin;
  210.     }
  211.     public function getConfirmationToken()
  212.     {
  213.         return $this->confirmationToken;
  214.     }
  215.     public function getRoles(): array
  216.     {
  217.         $roles $this->roles;
  218.         // we need to make sure to have at least one role
  219.         $roles[] = static::ROLE_DEFAULT;
  220.         return array_values(array_unique($roles));
  221.     }
  222.     public function hasRole($role)
  223.     {
  224.         return in_array(strtoupper($role), $this->getRoles(), true);
  225.     }
  226.     public function isEnabled()
  227.     {
  228.         return $this->enabled;
  229.     }
  230.     public function isSuperAdmin()
  231.     {
  232.         return $this->hasRole(static::ROLE_SUPER_ADMIN);
  233.     }
  234.     public function removeRole($role)
  235.     {
  236.         if (false !== $key array_search(strtoupper($role), $this->rolestrue)) {
  237.             unset($this->roles[$key]);
  238.             $this->roles array_values($this->roles);
  239.         }
  240.         return $this;
  241.     }
  242.     public function setUsername($username)
  243.     {
  244.         $this->username $username;
  245.         return $this;
  246.     }
  247.     public function setUsernameCanonical($usernameCanonical)
  248.     {
  249.         $this->usernameCanonical $usernameCanonical;
  250.         return $this;
  251.     }
  252.     public function setSalt($salt)
  253.     {
  254.         $this->salt $salt;
  255.         return $this;
  256.     }
  257.     public function setEmail($email)
  258.     {
  259.         $this->email $email;
  260.         return $this;
  261.     }
  262.     public function setEmailCanonical($emailCanonical)
  263.     {
  264.         $this->emailCanonical $emailCanonical;
  265.         return $this;
  266.     }
  267.     public function setEnabled($boolean)
  268.     {
  269.         $this->enabled = (bool) $boolean;
  270.         return $this;
  271.     }
  272.     public function setPassword($password)
  273.     {
  274.         $this->password $password;
  275.         return $this;
  276.     }
  277.     public function setSuperAdmin($boolean)
  278.     {
  279.         if (true === $boolean) {
  280.             $this->addRole(static::ROLE_SUPER_ADMIN);
  281.         } else {
  282.             $this->removeRole(static::ROLE_SUPER_ADMIN);
  283.         }
  284.         return $this;
  285.     }
  286.     public function setPlainPassword($password)
  287.     {
  288.         $this->plainPassword $password;
  289.         return $this;
  290.     }
  291.     public function setLastLogin(\DateTime $time null)
  292.     {
  293.         $this->lastLogin $time;
  294.         return $this;
  295.     }
  296.     public function setConfirmationToken($confirmationToken)
  297.     {
  298.         $this->confirmationToken $confirmationToken;
  299.         return $this;
  300.     }
  301.     public function setPasswordRequestedAt(\DateTime $date null)
  302.     {
  303.         $this->passwordRequestedAt $date;
  304.         return $this;
  305.     }
  306.     /**
  307.      * Gets the timestamp that the user requested a password reset.
  308.      *
  309.      * @return \DateTime|null
  310.      */
  311.     public function getPasswordRequestedAt()
  312.     {
  313.         return $this->passwordRequestedAt;
  314.     }
  315.     public function isPasswordRequestNonExpired($ttl)
  316.     {
  317.         return $this->getPasswordRequestedAt() instanceof \DateTime
  318.                && $this->getPasswordRequestedAt()->getTimestamp() + $ttl time();
  319.     }
  320.     public function setRoles(array $roles)
  321.     {
  322.         $this->roles = [];
  323.         foreach ($roles as $role) {
  324.             $this->addRole($role);
  325.         }
  326.         return $this;
  327.     }
  328.     public function isEqualTo(BaseUserInterface $user): bool
  329.     {
  330.         if (!$user instanceof self) {
  331.             return false;
  332.         }
  333.         if ($this->password !== $user->getPassword()) {
  334.             return false;
  335.         }
  336.         if ($this->salt !== $user->getSalt()) {
  337.             return false;
  338.         }
  339.         if ($this->username !== $user->getUsername()) {
  340.             return false;
  341.         }
  342.         return true;
  343.     }
  344. }