src/Entity/User.php line 15

  1. <?php
  3. namespace App\Entity;
  5. use App\Repository\UserRepository;
  6. use Doctrine\ORM\Mapping as ORM;
  7. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  8. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  9. use Symfony\Component\Security\Core\User\UserInterface;
  11. /**
  12.  * @ORM\Entity(repositoryClass=UserRepository::class)
  13.  * @UniqueEntity(fields={"email"}, message="There is already an account with this email")
  14.  */
  15. class User implements UserInterface, PasswordAuthenticatedUserInterface
  16. {
  17.     /**
  18.      * @ORM\Id
  19.      * @ORM\GeneratedValue
  20.      * @ORM\Column(type="integer")
  21.      */
  22.     private ?int $id = null;
  24.     /**
  25.      * @ORM\Column(type="string", length=180, unique=true)
  26.      */
  27.     private ?string $email = null;
  29.     /**
  30.      * @ORM\Column(type="string", length=100)
  31.      */
  32.     private string $name;
  34.     /**
  35.      * @ORM\Column(type="string", length=30)
  36.      */
  37.     private string $phone;
  39.     /**
  40.      * @ORM\Column(type="json")
  41.      */
  42.     private array $roles = [];
  44.     /**
  45.      * @var string|null The hashed password
  46.      * @ORM\Column(type="string", nullable=true)
  47.      */
  48.     private ?string $password = '';
  50.     /**
  51.      * @ORM\Column(type="boolean")
  52.      */
  53.     private bool $isVerified = false;
  55.     /**
  56.      * True for an account this app created by itself while a visitor was
  57.      * checking out as a guest, rather than one somebody filled the sign-up form
  58.      * in for. Such an account has a random password nobody knows, so it stays
  59.      * unusable for signing in until the passenger follows the "choose a
  60.      * password" link mailed to them. Cleared the moment they do.
  61.      *
  62.      * @ORM\Column(type="boolean")
  63.      */
  64.     private bool $isGuest = false;
  66.     /**
  67.      * One-time token behind that link. Null once used or never issued.
  68.      *
  69.      * @ORM\Column(type="string", length=64, nullable=true, unique=true)
  70.      */
  71.     private ?string $passwordSetToken = null;
  73.     /**
  74.      * @ORM\Column(type="datetime_immutable", nullable=true)
  75.      */
  76.     private ?\DateTimeImmutable $passwordSetTokenExpiresAt = null;
  78.     private ?string $plainPassword = null;
  80.     public function getId(): ?int
  81.     {
  82.         return $this->id;
  83.     }
  85.     public function getEmail(): ?string
  86.     {
  87.         return $this->email;
  88.     }
  90.     public function setEmail(string $email): self
  91.     {
  92.         $this->email = $email;
  93.         return $this;
  94.     }
  96.     /**
  97.      * A visual identifier that represents this user.
  98.      * @see UserInterface
  99.      */
  100.     public function getUserIdentifier(): string
  101.     {
  102.         return (string) $this->email;
  103.     }
  105.     /**
  106.      * Required by UserInterface for Symfony 5 compatibility.
  107.      */
  108.     public function getUsername(): string
  109.     {
  110.         return $this->getUserIdentifier();
  111.     }
  113.     public function hasRole(string $role): bool
  114.     {
  115.         return in_array($role, $this->getRoles());
  116.     }
  118.     /**
  119.      * @see UserInterface
  120.      */
  121.     public function getRoles(): array
  122.     {
  123.         $roles = $this->roles;
  124.         $roles[] = 'ROLE_USER';
  125.         return array_unique($roles);
  126.     }
  128.     public function setRoles(array $roles): self
  129.     {
  130.         $this->roles = $roles;
  131.         return $this;
  132.     }
  134.     /**
  135.      * @see PasswordAuthenticatedUserInterface
  136.      */
  137.     public function getPassword(): ?string
  138.     {
  139.         return $this->password;
  140.     }
  142.     public function setPassword(?string $password): self
  143.     {
  144.         $this->password = $password;
  145.         return $this;
  146.     }
  148.     /**
  149.      * @see UserInterface
  150.      */
  151.     public function eraseCredentials(): void
  152.     {
  153.         $this->plainPassword = null;
  154.     }
  156.     /**
  157.      * Required by UserInterface for Symfony 5 compatibility.
  158.      */
  159.     public function getSalt(): ?string
  160.     {
  161.         return null;
  162.     }
  164.     public function isVerified(): bool
  165.     {
  166.         return $this->isVerified;
  167.     }
  169.     public function setIsVerified(bool $isVerified): self
  170.     {
  171.         $this->isVerified = $isVerified;
  172.         return $this;
  173.     }
  175.     public function isIsVerified(): ?bool
  176.     {
  177.         return $this->isVerified;
  178.     }
  180.     public function isGuest(): bool
  181.     {
  182.         return $this->isGuest;
  183.     }
  185.     public function setIsGuest(bool $isGuest): self
  186.     {
  187.         $this->isGuest = $isGuest;
  188.         return $this;
  189.     }
  191.     public function getPasswordSetToken(): ?string
  192.     {
  193.         return $this->passwordSetToken;
  194.     }
  196.     public function getPasswordSetTokenExpiresAt(): ?\DateTimeImmutable
  197.     {
  198.         return $this->passwordSetTokenExpiresAt;
  199.     }
  201.     /**
  202.      * Issue (or re-issue) the one-time link that lets this account choose its
  203.      * first password, and hand the raw token back for the email. Any token
  204.      * issued earlier stops working, so the newest mail is always the live one.
  205.      */
  206.     public function startPasswordSetup(int $validForDays = 14): string
  207.     {
  208.         $this->passwordSetToken          = bin2hex(random_bytes(32));
  209.         $this->passwordSetTokenExpiresAt = new \DateTimeImmutable(sprintf('+%d days', $validForDays));
  211.         return $this->passwordSetToken;
  212.     }
  214.     public function isPasswordSetupPending(): bool
  215.     {
  216.         return $this->passwordSetToken !== null
  217.             && $this->passwordSetTokenExpiresAt !== null
  218.             && $this->passwordSetTokenExpiresAt > new \DateTimeImmutable();
  219.     }
  221.     /**
  222.      * Burn the token. Called once the password is chosen, so the link in the
  223.      * mailbox cannot be replayed by anyone who reads that inbox later.
  224.      */
  225.     public function finishPasswordSetup(): void
  226.     {
  227.         $this->passwordSetToken          = null;
  228.         $this->passwordSetTokenExpiresAt = null;
  229.         $this->isGuest                   = false;
  230.     }
  232.     public function getPlainPassword(): ?string
  233.     {
  234.         return $this->plainPassword;
  235.     }
  237.     public function setPlainPassword(?string $plainPassword): void
  238.     {
  239.         $this->plainPassword = $plainPassword;
  240.     }
  242.     public function getName(): string
  243.     {
  244.         return $this->name;
  245.     }
  247.     public function setName(string $name): void
  248.     {
  249.         $this->name = $name;
  250.     }
  252.     public function getPhone(): string
  253.     {
  254.         return $this->phone;
  255.     }
  257.     public function setPhone(string $phone): void
  258.     {
  259.         $this->phone = $phone;
  260.     }
  262.     public function __toString(): string
  263.     {
  264.         return $this->email ?? '';
  265.     }
  266. }