src/Entity/User.php line 21

  1. <?php
  3. namespace App\Entity;
  5. use ApiPlatform\Core\Annotation\ApiResource;
  6. use App\Repository\UserRepository;
  7. use Doctrine\Common\Collections\ArrayCollection;
  8. use Doctrine\Common\Collections\Collection;
  9. use Doctrine\ORM\Mapping as ORM;
  10. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  11. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  12. use Symfony\Component\Security\Core\User\UserInterface;
  13. use Symfony\Component\Serializer\Annotation\Groups;
  15. #[ApiResource(
  16.     denormalizationContext: ['groups' => ['write']],
  17. )]
  18. #[ORM\Table(name: 'user')]
  19. #[ORM\Entity(repositoryClass: UserRepository::class)]
  20. #[UniqueEntity(fields: ['username'], message: 'There is already an account with this username')]
  21. class User implements UserInterface, PasswordAuthenticatedUserInterface
  22. {
  23.     #[ORM\Id]
  24.     #[ORM\GeneratedValue]
  25.     #[ORM\Column(type: 'integer')]
  26.     private $id;
  28.     #[Groups("write")]
  29.     #[ORM\Column(type: 'string', length: 180, unique: true)]
  30.     private ?string $username = null;
  32.     #[Groups("write")]
  33.     #[ORM\Column(type: 'json')]
  34.     private array $roles = [];
  36.     #[Groups("write")]
  37.     #[ORM\Column(type: 'string')]
  38.     private ?string $password = null;
  40.     #[Groups("write")]
  41.     #[ORM\Column(type: 'boolean', nullable: true)]
  42.     private ?bool $isValid = null;
  44.     #[ORM\Column(type: 'boolean')]
  45.     #[Groups("write")]
  46.     private bool $isVerified = false;
  48.     #[ORM\ManyToMany(targetEntity: Role::class, mappedBy: 'users')]
  49.     private Collection $storedRoles;
  51.     #[ORM\OneToMany(mappedBy: 'user', targetEntity: SessionHistory::class, orphanRemoval: true)]
  52.     private Collection $sessionHistories;
  54.     public function __construct()
  55.     {
  56.         $this->storedRoles = new ArrayCollection();
  57.         $this->isValid = true;
  58.         $this->sessionHistories = new ArrayCollection();
  59.     }
  62.     public function __toString()
  63.     {
  64.         return $this->getUserIdentifier();
  65.     }
  67.     public function getId(): ?int
  68.     {
  69.         return $this->id;
  70.     }
  72.     /**
  73.      * @deprecated since Symfony 5.3, use getUserIdentifier instead
  74.      */
  75.     public function getUsername(): string
  76.     {
  77.         return (string) $this->username;
  78.     }
  80.     public function setUsername(string $username): self
  81.     {
  82.         $this->username = $username;
  84.         return $this;
  85.     }
  87.     /**
  88.      * A visual identifier that represents this user.
  89.      *
  90.      * @see UserInterface
  91.      */
  92.     public function getUserIdentifier(): string
  93.     {
  94.         return (string) $this->username;
  95.     }
  97.     /**
  98.      * @see UserInterface
  99.      */
  100.     public function getRoles(): array
  101.     {
  102.         $roles = $this->roles;
  103.         // guarantee every user at least has ROLE_USER
  104.         $roles[] = 'ROLE_USER';
  106.         foreach($this->getStoredRoles() as $singleRole){
  107.             $roles[] = $singleRole->getName();
  108.         }
  110.         return array_unique($roles);
  111.     }
  113.     public function setRoles(array $roles): self
  114.     {
  115.         $this->roles = $roles;
  117.         return $this;
  118.     }
  120.     /**
  121.      * @see PasswordAuthenticatedUserInterface
  122.      */
  123.     public function getPassword(): string
  124.     {
  125.         return $this->password;
  126.     }
  128.     public function setPassword(string $password): self
  129.     {
  130.         $this->password = $password;
  132.         return $this;
  133.     }
  135.     /**
  136.      * Returning a salt is only needed, if you are not using a modern
  137.      * hashing algorithm (e.g. bcrypt or sodium) in your security.yaml.
  138.      *
  139.      * @see UserInterface
  140.      */
  141.     public function getSalt(): ?string
  142.     {
  143.         return null;
  144.     }
  146.     /**
  147.      * @see UserInterface
  148.      */
  149.     public function eraseCredentials()
  150.     {
  151.         // If you store any temporary, sensitive data on the user, clear it here
  152.         // $this->plainPassword = null;
  153.     }
  155.     public function getIsValid(): ?bool
  156.     {
  157.         return $this->isValid;
  158.     }
  160.     public function setIsValid(?bool $isValid): self
  161.     {
  162.         $this->isValid = $isValid;
  164.         return $this;
  165.     }
  167.     public function isVerified(): bool
  168.     {
  169.         return $this->isVerified;
  170.     }
  172.     public function setIsVerified(bool $isVerified): self
  173.     {
  174.         $this->isVerified = $isVerified;
  176.         return $this;
  177.     }
  179.     /**
  180.      * @return Collection<int, Role>
  181.      */
  182.     public function getStoredRoles(): Collection
  183.     {
  184.         return $this->storedRoles;
  185.     }
  187.     public function addStoredRole(Role $storedRole): self
  188.     {
  189.         if (!$this->storedRoles->contains($storedRole)) {
  190.             $this->storedRoles->add($storedRole);
  191.             $storedRole->addUser($this);
  192.         }
  194.         return $this;
  195.     }
  197.     public function removeStoredRole(Role $storedRole): self
  198.     {
  199.         if ($this->storedRoles->removeElement($storedRole)) {
  200.             $storedRole->removeUser($this);
  201.         }
  203.         return $this;
  204.     }
  206.     /**
  207.      * @return Collection<int, SessionHistory>
  208.      */
  209.     public function getSessionHistories(): Collection
  210.     {
  211.         return $this->sessionHistories;
  212.     }
  214.     public function addSessionHistory(SessionHistory $sessionHistory): self
  215.     {
  216.         if (!$this->sessionHistories->contains($sessionHistory)) {
  217.             $this->sessionHistories->add($sessionHistory);
  218.             $sessionHistory->setUser($this);
  219.         }
  221.         return $this;
  222.     }
  224.     public function removeSessionHistory(SessionHistory $sessionHistory): self
  225.     {
  226.         if ($this->sessionHistories->removeElement($sessionHistory)) {
  227.             // set the owning side to null (unless already changed)
  228.             if ($sessionHistory->getUser() === $this) {
  229.                 $sessionHistory->setUser(null);
  230.             }
  231.         }
  233.         return $this;
  234.     }
  235. }