src/Entity/User.php line 76

Open in your IDE?
  1. <?php
  3. /**
  4.  * @package BLUUE
  5.  * @author Thomas HERISSON (contact@scaledev.fr)
  6.  * @copyright 2021 - ScaleDEV SAS, 12 RUE CHARLES MORET, 10120 ST ANDRE LES VERGERS
  7.  * @license commercial
  8.  */
  10. declare(strict_types=1);
  12. namespace App\Entity;
  14. use ApiPlatform\Core\Annotation\ApiResource;
  15. use DateTime;
  16. use Symfony\Component\Uid\Uuid;
  17. use Doctrine\ORM\Mapping as ORM;
  18. use App\Repository\UserRepository;
  19. use Gedmo\Mapping\Annotation as Gedmo;
  20. use App\DoctrineExtensions\IsActiveEntity;
  21. use App\Entity\Traits\OpensslServiceEntity;
  22. use Doctrine\Common\Collections\Collection;
  23. use Doctrine\Common\Collections\ArrayCollection;
  24. use Symfony\Bridge\Doctrine\IdGenerator\UuidGenerator;
  25. use Symfony\Component\Validator\Constraints as Assert;
  26. use Symfony\Component\Security\Core\User\UserInterface;
  27. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  28. use App\DoctrineExtensions\Timestampable\Traits\UserTimestampableEntity;
  29. use App\DoctrineExtensions\SoftDeleteable\Traits\UserSoftDeleteableEntity;
  30. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  31. use Symfony\Component\Serializer\Annotation\Groups;
  33. /**
  34.  * @ApiResource(
  35.  *  formats={"json"},
  36.  *  security="is_granted('ROLE_USER')",
  37.  *  normalizationContext= {"groups"= {"get"}},
  38.  *  denormalizationContext={"groups"={"write"}},
  39.  *  collectionOperations={
  40.  *      "get"={
  41.  *          "security"="is_granted('ROLE_READ_ONLY')"
  42.  *      },
  43.  *      "post"={
  44.  *          "security"="is_granted('ROLE_SUPER_ADMIN')"
  45.  *      }
  46.  *  },
  47.  *  itemOperations={
  48.  *      "get",
  49.  *      "put"={
  50.  *          "security"="is_granted('ROLE_SUPER_ADMIN')"
  51.  *      },
  52.  *      "patch"={
  53.  *          "security"="is_granted('ROLE_SUPER_ADMIN')"
  54.  *      },
  55.  *      "delete"={
  56.  *          "security"="is_granted('ROLE_SUPER_ADMIN')"
  57.  *      }
  58.  *  }
  59.  * )
  60.  * @ORM\Entity(repositoryClass=UserRepository::class)
  61.  * @ORM\Table(name="user", indexes={
  62.  *     @ORM\Index(name="name", columns={"firstname", "lastname"}),
  63.  *     @ORM\Index(name="is_active", columns={"is_active"}),
  64.  *     @ORM\Index(name="deleted_at", columns={"deleted_at"}),
  65.  *     @ORM\Index(name="created_at", columns={"created_at"}),
  66.  *     @ORM\Index(name="updated_at", columns={"updated_at"})
  67.  * })
  68.  * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false, hardDelete=false)
  69.  * @UniqueEntity(
  70.  *     fields={"email", "deletedAt"},
  71.  *     errorPath="email",
  72.  *     message="This email is already in use.",
  73.  *     ignoreNull=false
  74.  * )
  75.  */
  76. class User implements UserInterface, PasswordAuthenticatedUserInterface
  77. {
  78.     use UserTimestampableEntity;
  79.     use UserSoftDeleteableEntity;
  80.     use IsActiveEntity;
  81.     use OpensslServiceEntity;
  83.     /**
  84.      * @ORM\Id
  85.      * @ORM\Column(type="uuid")
  86.      * @ORM\GeneratedValue(strategy="CUSTOM")
  87.      * @ORM\CustomIdGenerator(class=UuidGenerator::class)
  88.      * @Groups({"get", "userSearch"})
  89.      */
  90.     private ?Uuid $id = null;
  92.     /**
  93.      * @ORM\Column(type="string", length=32)
  94.      * @Groups({"get", "write"})
  95.      */
  96.     private string $firstname;
  98.     /**
  99.      * @ORM\Column(type="string", length=32, nullable=true)
  100.      * @Groups({"get", "write"})
  101.      */
  102.     private ?string $lastname = null;
  104.     /**
  105.      * @ORM\Column(type="string", length=128)
  106.      * @Assert\Email
  107.      * @Groups({"get", "write"})
  108.      */
  109.     private string $email;
  111.     /**
  112.      * @ORM\Column(type="string", length=32, nullable=true)
  113.      * @Groups({"get", "write"})
  114.      */
  115.     private ?string $mobilePhone;
  117.     /**
  118.      * @var ?string The hashed password
  119.      * @ORM\Column(type="string", nullable=true)
  120.      */
  121.     private ?string $password = null;
  123.     /**
  124.      * @ORM\Column(type="string", length=40, nullable=true)
  125.      */
  126.     private ?string $token;
  128.     /**
  129.      * @ORM\Column(type="datetime", nullable=true)
  130.      */
  131.     private ?DateTime $token_validity;
  133.     /**
  134.      * @ORM\Column(type="string", length=128, nullable=true)
  135.      * @Groups({"get"})
  136.      */
  137.     private ?string $loginName = null;
  139.     /**
  140.      * @ORM\Column(type="string", length=20, nullable=true)
  141.      */
  142.     private ?string $apiPin = null;
  144.     /**
  145.      * @ORM\Column(type="string", length=40, nullable=true)
  146.      */
  147.     private ?string $apiToken = null;
  149.     /**
  150.      * @ORM\Column(type="datetime", nullable=true)
  151.      */
  152.     private ?DateTime $apiTokenValidity;
  154.     /**
  155.      * @ORM\Column(type="json", nullable=true)
  156.      * @Groups({"get"})
  157.      */
  158.     private array $config = [];
  160.     /**
  161.      * @ORM\ManyToOne(targetEntity=Profile::class, inversedBy="users")
  162.      * @Groups({"get"})
  163.      */
  164.     private ?Profile $profile;
  166.     /**
  167.      * @ORM\Column(type="text", nullable=true)
  168.      * @Groups({"get"})
  169.      */
  170.     private ?string $emailSignature = null;
  172.     /**
  173.      * @ORM\OneToMany(targetEntity=UserLoginLog::class, mappedBy="user", fetch="EXTRA_LAZY")
  174.      */
  175.     private Collection $userLoginLogs;
  177.     /**
  178.      * @ORM\OneToMany(targetEntity=Notification::class, mappedBy="user", fetch="EXTRA_LAZY")
  179.      */
  180.     private Collection $notifications;
  182.     /**
  183.      * @ORM\OneToMany(targetEntity=UserContext::class, mappedBy="user", fetch="EXTRA_LAZY")
  184.      */
  185.     private Collection $userContexts;
  187.     /**
  188.      * @ORM\ManyToOne(targetEntity=Language::class, inversedBy="users")
  189.      * @Groups({"get"})
  190.      * #[ApiProperty(readableLink: false, writableLink: false)]
  191.      */
  192.     private ?Language $language = null;
  194.     /**
  195.      * @ORM\Column(type="text", nullable=true)
  196.      * @Groups({"get"})
  197.      */
  198.     private ?string $note = null;
  200.     /**
  201.      * @ORM\Column(type="boolean", options={"default" : "0"})
  202.      */
  203.     private bool $isSolo = false;
  205.     /**
  206.      * @ORM\OneToMany(targetEntity=MailServer::class, mappedBy="user", fetch="EXTRA_LAZY")
  207.      */
  208.     private Collection $mail_servers;
  210.     /**
  211.      * @ORM\OneToMany(targetEntity=TeamUser::class, mappedBy="user", fetch="EXTRA_LAZY")
  212.      */
  213.     private Collection $teamUsers;
  215.     /**
  216.      * @ORM\OneToMany(targetEntity=UsersEstablishments::class, mappedBy="user")
  217.      */
  218.     private ?Collection $usersEstablishments;
  220.     public function __construct()
  221.     {
  222.         $this->userLoginLogs = new ArrayCollection();
  223.         $this->notifications = new ArrayCollection();
  224.         $this->userContexts = new ArrayCollection();
  225.         $this->mail_servers = new ArrayCollection();
  226.         $this->teamUsers = new ArrayCollection();
  227.         $this->usersEstablishments = new ArrayCollection();
  228.     }
  230.     /**
  231.      * @Groups({"get"})
  232.      * @return string
  233.      */
  234.     public function getUserIdentifier(): string
  235.     {
  236.         return $this->email;
  237.     }
  239.     /**
  240.      * @Groups({"get"})
  241.      * @return string
  242.      * @deprecated since symfony 5.3
  243.      */
  244.     public function getUsername(): string
  245.     {
  246.         return $this->getUserIdentifier();
  247.     }
  249.     /**
  250.      * @return Uuid|null
  251.      */
  252.     public function getId(): ?Uuid
  253.     {
  254.         return $this->id;
  255.     }
  257.     /**
  258.      * @return string|null
  259.      */
  260.     public function getFirstname(): ?string
  261.     {
  262.         return $this->firstname;
  263.     }
  265.     /**
  266.      * @return string|null
  267.      */
  268.     public function getLastname(): ?string
  269.     {
  270.         return $this->lastname;
  271.     }
  273.     /**
  274.      * @return string|null
  275.      */
  276.     public function getEmail(): ?string
  277.     {
  278.         return $this->email;
  279.     }
  281.     /**
  282.      * @return string|null
  283.      */
  284.     public function getMobilePhone(): ?string
  285.     {
  286.         return $this->mobilePhone;
  287.     }
  289.     /**
  290.      * @return string|null
  291.      */
  292.     public function getPassword(): ?string
  293.     {
  294.         return $this->password;
  295.     }
  297.     /**
  298.      * @return string|null
  299.      */
  300.     public function getToken(): ?string
  301.     {
  302.         return $this->token;
  303.     }
  305.     /**
  306.      * @return DateTime|null
  307.      */
  308.     public function getTokenValidity(): ?DateTime
  309.     {
  310.         return $this->token_validity;
  311.     }
  313.     /**
  314.      * @return string|null
  315.      */
  316.     public function getLoginName(): ?string
  317.     {
  318.         return $this->loginName;
  319.     }
  321.     /**
  322.      * @return string|null
  323.      */
  324.     public function getApiPin(): ?string
  325.     {
  326.         $apiPin = $this->apiPin;
  327.         $apiPin = $apiPin ? $this->openssl->decrypt($apiPin) : null;
  328.         return $apiPin;
  329.     }
  331.     /**
  332.      * @return string|null
  333.      */
  334.     public function getApiToken(): ?string
  335.     {
  336.         return $this->apiToken;
  337.     }
  339.     /**
  340.      * @return DateTime|null
  341.      */
  342.     public function getApiTokenValidity(): ?DateTime
  343.     {
  344.         return $this->apiTokenValidity;
  345.     }
  347.     /**
  348.      * @return array
  349.      */
  350.     public function getConfig(): array
  351.     {
  352.         return $this->config;
  353.     }
  355.     /**
  356.      * @param string $firstname
  357.      * @return $this
  358.      */
  359.     public function setFirstname(string $firstname): self
  360.     {
  361.         $this->firstname = $firstname;
  362.         return $this;
  363.     }
  365.     /**
  366.      * @param string|null $lastname
  367.      * @return $this
  368.      */
  369.     public function setLastname(?string $lastname): self
  370.     {
  371.         $this->lastname = $lastname;
  372.         return $this;
  373.     }
  375.     /**
  376.      * @param string $email
  377.      * @return $this
  378.      */
  379.     public function setEmail(string $email): self
  380.     {
  381.         $this->email = $email;
  382.         return $this;
  383.     }
  385.     /**
  386.      * @param string|null $mobilePhone
  387.      * @return $this
  388.      */
  389.     public function setMobilePhone(?string $mobilePhone): self
  390.     {
  391.         $this->mobilePhone = $mobilePhone;
  392.         return $this;
  393.     }
  395.     /**
  396.      * @param string|null $password
  397.      * @return $this
  398.      */
  399.     public function setPassword(?string $password = null): self
  400.     {
  401.         $this->password = $password;
  402.         return $this;
  403.     }
  405.     /**
  406.      * @param string|null $token
  407.      * @return $this
  408.      */
  409.     public function setToken(?string $token): self
  410.     {
  411.         $this->token = $token;
  412.         return $this;
  413.     }
  415.     /**
  416.      * @param DateTime|null $token_validity
  417.      * @return $this
  418.      */
  419.     public function setTokenValidity(?DateTime $token_validity): self
  420.     {
  421.         $this->token_validity = $token_validity;
  422.         return $this;
  423.     }
  425.     /**
  426.      * @param string|null $loginName
  427.      * @return $this
  428.      */
  429.     public function setLoginName(?string $loginName): self
  430.     {
  431.         $this->loginName = $loginName;
  432.         return $this;
  433.     }
  435.     /**
  436.      * @param string|null $apiPin
  437.      * @return $this
  438.      */
  439.     public function setApiPin(?string $apiPin): self
  440.     {
  441.         $apiPin = $apiPin ? $this->openssl->encrypt($apiPin) : null;
  442.         $this->apiPin = $apiPin;
  443.         return $this;
  444.     }
  446.     /**
  447.      * @param string|null $apiToken
  448.      * @return $this
  449.      */
  450.     public function setApiToken(?string $apiToken): self
  451.     {
  452.         $this->apiToken = $apiToken;
  453.         return $this;
  454.     }
  456.     /**
  457.      * @param DateTime|null $apiTokenValidity
  458.      * @return $this
  459.      */
  460.     public function setApiTokenValidity(?DateTime $apiTokenValidity): self
  461.     {
  462.         $this->apiTokenValidity = $apiTokenValidity;
  463.         return $this;
  464.     }
  466.     /**
  467.      * @param array $config
  468.      * @return $this
  469.      */
  470.     public function setConfig(array $config): self
  471.     {
  472.         $this->config = $config;
  473.         return $this;
  474.     }
  476.     /**
  477.      * @Groups({"get"})
  478.      * @return array
  479.      */
  480.     public function getRoles(): array
  481.     {
  482.         if ($this->profile) {
  483.             return $this->profile->getRoles();
  484.         }
  485.         return [];
  486.     }
  488.     /**
  489.      * @return Profile|null
  490.      */
  491.     public function getProfile(): ?Profile
  492.     {
  493.         return $this->profile;
  494.     }
  496.     /**
  497.      * @param Profile|null $profile
  498.      * @return $this
  499.      */
  500.     public function setProfile(?Profile $profile): self
  501.     {
  502.         $this->profile = $profile;
  503.         return $this;
  504.     }
  506.     /**
  507.      * @return string|null
  508.      */
  509.     public function getEmailSignature(): ?string
  510.     {
  511.         return $this->emailSignature;
  512.     }
  514.     /**
  515.      * @param string|null $emailSignature
  516.      * @return User
  517.      */
  518.     public function setEmailSignature(?string $emailSignature): User
  519.     {
  520.         $this->emailSignature = $emailSignature;
  521.         return $this;
  522.     }
  524.     /**
  525.      * Returning a salt is only needed, if you are not using a modern
  526.      * hashing algorithm (e.g. bcrypt or sodium) in your security.yaml.
  527.      *
  528.      * @see UserInterface
  529.      */
  530.     public function getSalt(): ?string
  531.     {
  532.         return null;
  533.     }
  535.     /**
  536.      * @see UserInterface
  537.      */
  538.     public function eraseCredentials()
  539.     {
  540.         // If you store any temporary, sensitive data on the user, clear it here
  541.         // $this->plainPassword = null;
  542.     }
  544.     /**
  545.      * @return Collection|UserLoginLog[]
  546.      */
  547.     public function getUserLoginLogs(): Collection
  548.     {
  549.         return $this->userLoginLogs;
  550.     }
  552.     /**
  553.      * @param UserLoginLog $userLoginLog
  554.      * @return $this
  555.      */
  556.     public function addUserLoginLog(UserLoginLog $userLoginLog): self
  557.     {
  558.         if (!$this->userLoginLogs->contains($userLoginLog)) {
  559.             $this->userLoginLogs[] = $userLoginLog;
  560.             $userLoginLog->setUser($this);
  561.         }
  562.         return $this;
  563.     }
  565.     /**
  566.      * @param UserLoginLog $userLoginLog
  567.      * @return $this
  568.      */
  569.     public function removeUserLoginLog(UserLoginLog $userLoginLog): self
  570.     {
  571.         if ($this->userLoginLogs->removeElement($userLoginLog)) {
  572.             if ($userLoginLog->getUser() === $this) {
  573.                 $userLoginLog->setUser(null);
  574.             }
  575.         }
  576.         return $this;
  577.     }
  579.     /**
  580.      * @return Collection|Notification[]
  581.      */
  582.     public function getNotifications(): Collection
  583.     {
  584.         return $this->notifications;
  585.     }
  587.     /**
  588.      * @param Notification $notification
  589.      * @return $this
  590.      */
  591.     public function addNotification(Notification $notification): self
  592.     {
  593.         if (!$this->notifications->contains($notification)) {
  594.             $this->notifications[] = $notification;
  595.             $notification->setUser($this);
  596.         }
  597.         return $this;
  598.     }
  600.     /**
  601.      * @param Notification $notification
  602.      * @return $this
  603.      */
  604.     public function removeNotification(Notification $notification): self
  605.     {
  606.         if ($this->notifications->removeElement($notification)) {
  607.             if ($notification->getUser() === $this) {
  608.                 $notification->setUser(null);
  609.             }
  610.         }
  611.         return $this;
  612.     }
  614.     /**
  615.      * @return Collection|UserContext[]
  616.      */
  617.     public function getUserContexts(): Collection
  618.     {
  619.         return $this->userContexts;
  620.     }
  622.     /**
  623.      * @Groups({"get"})
  624.      * @return string
  625.      */
  626.     public function getLocale(): string
  627.     {
  628.         return 'en';
  629.     }
  631.     /**
  632.      * @return Language|null
  633.      */
  634.     public function getLanguage(): ?Language
  635.     {
  636.         return $this->language;
  637.     }
  639.     /**
  640.      * @param Language|null $language
  641.      * @return $this
  642.      */
  643.     public function setLanguage(?Language $language): self
  644.     {
  645.         $this->language = $language;
  646.         return $this;
  647.     }
  649.     /**
  650.      * @return string|null
  651.      */
  652.     public function getNote(): ?string
  653.     {
  654.         $note = $this->note;
  655.         if ($note) {
  656.             $note = $this->openssl->decrypt($note);
  657.         }
  658.         return $note;
  659.     }
  661.     /**
  662.      * @param string|null $note
  663.      * @return $this
  664.      */
  665.     public function setNote(?string $note): self
  666.     {
  667.         $this->note = $note;
  668.         return $this;
  669.     }
  671.     /**
  672.      * @return bool|null
  673.      */
  674.     public function getIsSolo(): ?bool
  675.     {
  676.         return $this->isSolo;
  677.     }
  679.     /**
  680.      * @param bool $isSolo
  681.      * @return $this
  682.      */
  683.     public function setIsSolo(bool $isSolo): self
  684.     {
  685.         $this->isSolo = $isSolo;
  686.         return $this;
  687.     }
  689.     /**
  690.      * @Groups({"get", "userSearch"})
  691.      * @return string
  692.      */
  693.     public function getName(): string
  694.     {
  695.         return $this->firstname . ' ' . $this->lastname;
  696.     }
  698.     /**
  699.      * @return Collection|MailServer[]
  700.      */
  701.     public function getMailServers(): Collection
  702.     {
  703.         return $this->mail_servers;
  704.     }
  706.     /**
  707.      * @return Collection|TeamUser[]
  708.      */
  709.     public function getTeamUsers(): Collection
  710.     {
  711.         return $this->teamUsers;
  712.     }
  714.     /**
  715.      * @Groups({"get"})
  716.      * @return string
  717.      */
  718.     public function getProfileName(): string
  719.     {
  720.         return $this->profile->getName();
  721.     }
  723.     /**
  724.      * @Groups({"get"})
  725.      * @return int
  726.      */
  727.     public function getLimitPerPage(): int
  728.     {
  729.         $userConfig = $this->getConfig();
  731.         if (!isset($userConfig['core']['list']['limit']) || !$userConfig['core']['list']['limit']) {
  732.             $limit = 25;
  733.         } else {
  734.             $limit = (int) $userConfig['core']['list']['limit'];
  735.         }
  737.         return $limit;
  738.     }
  740.     /**
  741.      * @return Collection<int, UsersEstablishments>
  742.      */
  743.     public function getUsersEstablishments(): Collection
  744.     {
  745.         return $this->usersEstablishments;
  746.     }
  748.     public function addUsersEstablishment(UsersEstablishments $usersEstablishment): self
  749.     {
  750.         if (!$this->usersEstablishments->contains($usersEstablishment)) {
  751.             $this->usersEstablishments[] = $usersEstablishment;
  752.             $usersEstablishment->setUser($this);
  753.         }
  755.         return $this;
  756.     }
  758.     public function removeUsersEstablishment(UsersEstablishments $usersEstablishment): self
  759.     {
  760.         if ($this->usersEstablishments->removeElement($usersEstablishment)) {
  761.             // set the owning side to null (unless already changed)
  762.             if ($usersEstablishment->getUser() === $this) {
  763.                 $usersEstablishment->setUser(null);
  764.             }
  765.         }
  767.         return $this;
  768.     }
  769. }