src/Entity/User.php line 32

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Entity\Garages\Garage;
  6. use App\Entity\PointsCatalog\CatalogPointMovement;
  7. use App\Enum\UserRolesEnum;
  8. use App\Repository\UserRepository;
  9. use DateTime;
  10. use Doctrine\Common\Collections\ArrayCollection;
  11. use Doctrine\Common\Collections\Collection;
  12. use Doctrine\ORM\Mapping as ORM;
  13. use Gedmo\Mapping\Annotation as Gedmo;
  14. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  15. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  16. use Symfony\Component\Security\Core\User\UserInterface;
  17. use Symfony\Component\Validator\Constraints as Assert;
  18. use Symfony\Component\Validator\Constraints\Email;
  20. /**
  21.  * @ORM\Table(name="vulco_user")
  22.  *
  23.  * @ORM\Entity(repositoryClass=UserRepository::class)
  24.  *
  25.  * @Gedmo\SoftDeleteable(fieldName="removedAt", timeAware=false)
  26.  *
  27.  * https://symfony.com/doc/5.x/reference/constraints/UniqueEntity.html:
  28.  * (no he conseguit que funcioni)
  29.  * @UniqueEntity("email")
  30.  * @UniqueEntity("username")
  31.  */
  32. class User extends AbstractBase implements PasswordAuthenticatedUserInterface, UserInterface
  33. {
  34.     /**
  35.      * @ORM\ManyToOne(targetEntity="App\Entity\UserGroup", inversedBy="users")
  36.      *
  37.      * @ORM\JoinColumn(name="user_group_id", referencedColumnName="id", nullable=true, onDelete="SET NULL")
  38.      */
  39.     private ?UserGroup $userGroup = null;
  41.     /**
  42.      * @ORM\OneToMany(targetEntity="App\Entity\Garages\Garage", mappedBy="owner")
  43.      */
  44.     private ?Collection $garages;
  46.     /**
  47.      * @ORM\OneToMany(targetEntity="App\Entity\OnlineShop\Supplier", mappedBy="user")
  48.      */
  49.     private ?Collection $suppliers;
  51.     /**
  52.      * @ORM\ManyToMany(targetEntity="App\Entity\Province")
  53.      *
  54.      * @ORM\JoinTable(name="vulco_user_province",
  55.      *     joinColumns={@ORM\JoinColumn(name="user_id", referencedColumnName="id")},
  56.      *     inverseJoinColumns={@ORM\JoinColumn(name="province_id", referencedColumnName="id")}
  57.      * )
  58.      *
  59.      * @ORM\OrderBy({"name": "ASC"})
  60.      */
  61.     private ?Collection $workProvinces;
  63.     /**
  64.      * @ORM\OneToMany(targetEntity="App\Entity\Documents\DocumentDownload", mappedBy="user", orphanRemoval=true)
  65.      */
  66.     private ?Collection $documentDownloads;
  68.     /**
  69.      * @ORM\OneToMany(targetEntity="App\Entity\OnlineShop\SupplierDocumentDownload", mappedBy="user", orphanRemoval=true)
  70.      */
  71.     private ?Collection $supplierDocumentDownloads;
  73.     /**
  74.      * @ORM\OneToMany(targetEntity="App\Entity\Tracking\UserTracking", mappedBy="user", orphanRemoval=true)
  75.      */
  76.     private ?Collection $userTrackings;
  78.     /**
  79.      * @ORM\OneToMany(targetEntity="App\Entity\PointsCatalog\CatalogPointMovement", mappedBy="user", orphanRemoval=true)
  80.      */
  81.     private ?Collection $pointMovements;
  83.     /**
  84.      * @ORM\Column(type="string", length=180, unique=true)
  85.      * @Assert\Email
  86.      */
  87.     private string $email;
  89.     /**
  90.      * @ORM\Column(type="string", length=180, nullable=true)
  91.      *
  92.      * inhereted from legacy vulco FOSUserBundle
  93.      */
  94.     private ?string $emailCanonical = null;
  96.     /**
  97.      * @ORM\Column(type="string", length=180, unique=true)
  98.      */
  99.     private string $username;
  101.     /**
  102.      * @ORM\Column(type="string", length=180, nullable=true)
  103.      *
  104.      * inhereted from legacy vulco FOSUserBundle
  105.      */
  106.     private ?string $usernameCanonical = null;
  108.     /**
  109.      * @ORM\Column(type="string", length=255, nullable=true)
  110.      */
  111.     private ?string $name;
  113.     /**
  114.      * @ORM\Column(type="string", length=255, nullable=true)
  115.      */
  116.     private ?string $zone;
  118.     /**
  119.      * @ORM\Column(type="array")
  120.      */
  121.     private array $roles = [];
  123.     /**
  124.      * @ORM\Column(type="string")
  125.      */
  126.     private string $password;
  128.     /**
  129.      * @ORM\Column(type="string", nullable=true)
  130.      */
  131.     private ?string $salt = null;
  133.     /**
  134.      * @ORM\Column(type="datetime", name="last_login", nullable=true)
  135.      */
  136.     private ?\DateTimeInterface $lastLogin;
  138.     /**
  139.      * @ORM\Column(type="datetime", name="last_old_login", nullable=true)
  140.      */
  141.     private ?\DateTimeInterface $lastOldLogin;
  143.     /**
  144.      * @ORM\Column(type="datetime", name="last_visit_on", nullable=true)
  145.      */
  146.     private ?\DateTimeInterface $lastVisitOn;
  148.     /**
  149.      * @ORM\Column(type="datetime", name="password_requested_at", nullable=true)
  150.      */
  151.     private ?\DateTimeInterface $passwordRequestedAt;
  153.     /**
  154.      * @ORM\Column(type="string", name="internal_description", nullable=true)
  155.      */
  156.     private ?string $internalDescription;
  158.     /**
  159.      * @ORM\Column(type="boolean", name="enabled", nullable=false)
  160.      */
  161.     private bool $enabled = true;
  163.     /**
  164.      * @ORM\Column(type="boolean", nullable=true, options={"default": 0})
  165.      */
  166.     private bool $enableStatisticsManagement = false;
  168.     /**
  169.      * @ORM\Column(type="boolean", name="readed_confidentiality", nullable=false)
  170.      */
  171.     private bool $readedConfidentiality = false;
  173.     /**
  174.      * @ORM\Column(type="datetime", name="readed_confidentiality_at", nullable=true)
  175.      */
  176.     private ?\DateTimeInterface $readedConfidentialityAt;
  178.     /**
  179.      * @ORM\Column(type="string", name="login_token", nullable=true)
  180.      */
  181.     private ?string $token = null;
  183.     /**
  184.      * @ORM\Column(type="string", name="confirmation_token", length=180, nullable=true, unique=true)
  185.      */
  186.     private string $confirmationToken;
  188.     public function __construct()
  189.     {
  190.         $this->createdAt = new \DateTime();
  191.         $this->garages = new ArrayCollection();
  192.         $this->suppliers = new ArrayCollection();
  193.         $this->workProvinces = new ArrayCollection();
  194.         $this->documentDownloads = new ArrayCollection();
  195.         $this->supplierDocumentDownloads = new ArrayCollection();
  196.         $this->userTrackings = new ArrayCollection();
  197.         $this->pointMovements = new ArrayCollection();
  198.     }
  200.     public function getUserIdentifier(): string
  201.     {
  202.         return $this->getUsername();
  203.     }
  205.     public function getUserGroup(): ?UserGroup
  206.     {
  207.         return $this->userGroup;
  208.     }
  210.     public function setUserGroup(?UserGroup $userGroup): self
  211.     {
  212.         $this->userGroup = $userGroup;
  214.         return $this;
  215.     }
  217.     public function getGarages(): ?Collection
  218.     {
  219.         return $this->garages;
  220.     }
  222.     public function setGarages(?Collection $garages): self
  223.     {
  224.         $this->garages = $garages;
  226.         return $this;
  227.     }
  229.     public function addGarage(Garage $garage): self
  230.     {
  231.         if (!$this->garages->contains($garage)) {
  232.             $this->garages->add($garage);
  233.         }
  235.         return $this;
  236.     }
  238.     public function getSuppliers(): ?Collection
  239.     {
  240.         return $this->suppliers;
  241.     }
  243.     public function setSuppliers($suppliers): self
  244.     {
  245.         $this->suppliers = $suppliers;
  247.         return $this;
  248.     }
  250.     public function getWorkProvinces(): ?Collection
  251.     {
  252.         return $this->workProvinces;
  253.     }
  255.     public function setWorkProvinces(?Collection $workProvinces): self
  256.     {
  257.         $this->workProvinces = $workProvinces;
  259.         return $this;
  260.     }
  262.     public function getDocumentDownloads(): ?Collection
  263.     {
  264.         return $this->documentDownloads;
  265.     }
  267.     public function setDocumentDownloads(?Collection $documentDownloads): self
  268.     {
  269.         $this->documentDownloads = $documentDownloads;
  271.         return $this;
  272.     }
  274.     public function getSupplierDocumentDownloads(): ?Collection
  275.     {
  276.         return $this->supplierDocumentDownloads;
  277.     }
  279.     public function setSupplierDocumentDownloads(?Collection $supplierDocumentDownloads): self
  280.     {
  281.         $this->supplierDocumentDownloads = $supplierDocumentDownloads;
  283.         return $this;
  284.     }
  286.     public function getUserTrackings(): ?Collection
  287.     {
  288.         return $this->userTrackings;
  289.     }
  291.     public function setUserTrackings(?Collection $userTrackings): self
  292.     {
  293.         $this->userTrackings = $userTrackings;
  295.         return $this;
  296.     }
  298.     public function getPointMovements(): ?Collection
  299.     {
  300.         return $this->pointMovements;
  301.     }
  303.     public function setPointMovements(?Collection $pointMovements): self
  304.     {
  305.         $this->pointMovements = $pointMovements;
  307.         return $this;
  308.     }
  310.     public function getNameOrEmail(): string
  311.     {
  312.         return $this->getName() ?: $this->getEmail();
  313.     }
  315.     public function getNameAndEmailString(): string
  316.     {
  317.         return $this->getName() ? $this->getName().' ('.$this->getEmail().')' : $this->getEmail();
  318.     }
  320.     public function getUsername(): string
  321.     {
  322.         return $this->username;
  323.     }
  325.     public function setUsername(string $username): self
  326.     {
  327.         $this->username = $username;
  329.         return $this;
  330.     }
  332.     public function getRoles(): array
  333.     {
  334.         $roles = $this->roles;
  335.         $roles[] = UserRolesEnum::ROLE_USER_LONG; // guarantee every user at least has ROLE_USER
  337.         return array_unique($roles);
  338.     }
  340.     public function setRoles(array $roles): self
  341.     {
  342.         $this->roles = $roles;
  344.         return $this;
  345.     }
  347.     public function hasRole(string $role): bool
  348.     {
  349.         return in_array(strtoupper($role), $this->roles, true);
  350.     }
  352.     public function addRole(string $role): self
  353.     {
  354.         if (!$this->hasRole($role)) {
  355.             $this->roles[] = strtoupper($role);
  356.         }
  358.         return $this;
  359.     }
  361.     public function removeRole(string $role): self
  362.     {
  363.         if (false !== $key = array_search(strtoupper($role), $this->roles, true)) {
  364.             unset($this->roles[$key]);
  365.             $this->roles = array_values($this->roles);
  366.         }
  368.         return $this;
  369.     }
  371.     public function getUserRole()
  372.     {
  373.         $role = '';
  375.         if ($this->hasRole(UserRolesEnum::ROLE_ADMIN_LONG) || $this->hasRole(UserRolesEnum::ROLE_SUPER_ADMIN_LONG)) {
  376.             $role = UserRolesEnum::ROLE_ADMIN;
  377.         } elseif ($this->hasRole(UserRolesEnum::ROLE_MANAGER_LONG)) {
  378.             $role = UserRolesEnum::ROLE_MANAGER;
  379.         } elseif ($this->hasRole(UserRolesEnum::ROLE_ASSOCIATED_LONG)) {
  380.             $role = UserRolesEnum::ROLE_ASSOCIATED;
  381.         } elseif ($this->hasRole(UserRolesEnum::ROLE_ASSOCIATED_MANAGER_LONG)) {
  382.             $role = UserRolesEnum::ROLE_ASSOCIATED_MANAGER;
  383.         } elseif ($this->hasRole(UserRolesEnum::ROLE_COORDINATOR_LONG)) {
  384.             $role = UserRolesEnum::ROLE_COORDINATOR;
  385.         } elseif ($this->hasRole(UserRolesEnum::ROLE_PROVIDER_LONG)) {
  386.             $role = UserRolesEnum::ROLE_PROVIDER;
  387.         } elseif ($this->hasRole(UserRolesEnum::ROLE_QUALITY_ADVISOR_LONG)) {
  388.             $role = UserRolesEnum::ROLE_QUALITY_ADVISOR;
  389.         }
  391.         return $role;
  392.     }
  394.     public function getPassword(): string
  395.     {
  396.         return $this->password;
  397.     }
  399.     public function setPassword(string $password): self
  400.     {
  401.         $this->password = $password;
  403.         return $this;
  404.     }
  406.     public function getToken(): ?string
  407.     {
  408.         return $this->token;
  409.     }
  411.     public function setToken(string $token): self
  412.     {
  413.         $this->token = $token;
  415.         return $this;
  416.     }
  418.     public function getSalt(): ?string
  419.     {
  420.         return $this->salt;
  421.     }
  423.     public function setSalt(?string $salt): self
  424.     {
  425.         $this->salt = $salt;
  427.         return $this;
  428.     }
  430.     public function eraseCredentials(): void
  431.     {
  432.         // If you store any temporary, sensitive data on the user, clear it here
  433.         // $this->plainPassword = null;
  434.     }
  436.     public function getUsernameCanonical(): ?string
  437.     {
  438.         return $this->usernameCanonical;
  439.     }
  441.     public function setUsernameCanonical(?string $usernameCanonical): self
  442.     {
  443.         $this->usernameCanonical = $usernameCanonical;
  445.         return $this;
  446.     }
  448.     public function getEmail(): string
  449.     {
  450.         return $this->email;
  451.     }
  453.     public function setEmail(string $email): self
  454.     {
  455.         $this->email = strtolower($email);
  457.         return $this;
  458.     }
  460.     public function getEmailCanonical(): ?string
  461.     {
  462.         return $this->emailCanonical;
  463.     }
  465.     public function setEmailCanonical(?string $emailCanonical): self
  466.     {
  467.         $this->emailCanonical = $emailCanonical;
  469.         return $this;
  470.     }
  472.     public function getName(): ?string
  473.     {
  474.         return $this->name;
  475.     }
  477.     public function setName(?string $name): self
  478.     {
  479.         $this->name = $name;
  481.         return $this;
  482.     }
  484.     public function getZone(): ?string
  485.     {
  486.         return $this->zone;
  487.     }
  489.     public function setZone(?string $zone): self
  490.     {
  491.         $this->zone = $zone;
  493.         return $this;
  494.     }
  496.     public function getLastLogin(): ?\DateTimeInterface
  497.     {
  498.         return $this->lastLogin;
  499.     }
  501.     public function setLastLogin(?\DateTimeInterface $lastLogin): self
  502.     {
  503.         $this->lastLogin = $lastLogin;
  505.         return $this;
  506.     }
  508.     public function getLastOldLogin(): ?\DateTimeInterface
  509.     {
  510.         return $this->lastOldLogin;
  511.     }
  513.     public function setLastOldLogin(?\DateTimeInterface $lastOldLogin): self
  514.     {
  515.         $this->lastOldLogin = $lastOldLogin;
  517.         return $this;
  518.     }
  520.     public function getLastVisitOn(): ?\DateTimeInterface
  521.     {
  522.         return $this->lastVisitOn;
  523.     }
  525.     public function setLastVisitOn(?\DateTimeInterface $lastVisitOn): self
  526.     {
  527.         $this->lastVisitOn = $lastVisitOn;
  529.         return $this;
  530.     }
  532.     public function getPasswordRequestedAt(): ?\DateTimeInterface
  533.     {
  534.         return $this->passwordRequestedAt;
  535.     }
  537.     public function setPasswordRequestedAt(?\DateTimeInterface $passwordRequestedAt): self
  538.     {
  539.         $this->passwordRequestedAt = $passwordRequestedAt;
  541.         return $this;
  542.     }
  544.     public function getInternalDescription(): ?string
  545.     {
  546.         return $this->internalDescription;
  547.     }
  549.     public function setInternalDescription(?string $internalDescription): self
  550.     {
  551.         $this->internalDescription = $internalDescription;
  553.         return $this;
  554.     }
  556.     public function isEnabled(): bool
  557.     {
  558.         return $this->enabled;
  559.     }
  561.     public function getEnabled(): bool
  562.     {
  563.         return $this->isEnabled();
  564.     }
  566.     public function setEnabled(bool $enabled): self
  567.     {
  568.         $this->enabled = $enabled;
  570.         return $this;
  571.     }
  573.     public function isEnableStatisticsManagement(): bool
  574.     {
  575.         return $this->enableStatisticsManagement;
  576.     }
  578.     public function getEnableStatisticsManagement(): bool
  579.     {
  580.         return $this->isEnableStatisticsManagement();
  581.     }
  583.     public function setEnableStatisticsManagement(bool $enableStatisticsManagement): self
  584.     {
  585.         $this->enableStatisticsManagement = $enableStatisticsManagement;
  587.         return $this;
  588.     }
  590.     public function isReadedConfidentiality(): bool
  591.     {
  592.         return $this->readedConfidentiality;
  593.     }
  595.     public function setReadedConfidentiality(bool $readedConfidentiality): self
  596.     {
  597.         $this->readedConfidentiality = $readedConfidentiality;
  599.         return $this;
  600.     }
  602.     public function getReadedConfidentialityAt(): ?\DateTimeInterface
  603.     {
  604.         return $this->readedConfidentialityAt;
  605.     }
  607.     public function setReadedConfidentialityAt(?\DateTimeInterface $readedConfidentialityAt): self
  608.     {
  609.         $this->readedConfidentialityAt = $readedConfidentialityAt;
  611.         return $this;
  612.     }
  614.     public function getConfirmationToken(): string
  615.     {
  616.         return $this->confirmationToken;
  617.     }
  619.     public function setConfirmationToken(string $confirmationToken): self
  620.     {
  621.         $this->confirmationToken = $confirmationToken;
  623.         return $this;
  624.     }
  626.     public function belongsToUserGroup($userGroups): bool
  627.     {
  628.         $result = false;
  629.         if (null !== $userGroups && null !== $this->getUserGroup()) {
  630.             /** @var UserGroup $userGroup */
  631.             foreach ($userGroups as $userGroup) {
  632.                 if ($userGroup->getId() === $this->getUserGroup()->getId()) {
  633.                     $result = true;
  634.                     break;
  635.                 }
  636.             }
  637.         }
  639.         return $result;
  640.     }
  642.     public function belongsToUsers($users): bool
  643.     {
  644.         $result = false;
  645.         if (null !== $users) {
  646.             /** @var User $user */
  647.             foreach ($users as $user) {
  648.                 if ($user->getId() === $this->getId()) {
  649.                     $result = true;
  650.                     break;
  651.                 }
  652.             }
  653.         }
  655.         return $result;
  656.     }
  658.     public function getCatalogPointsAmount(): float
  659.     {
  660.         $catalogPointsAmount = 0.0;
  661.         /** @var CatalogPointMovement $pointMovement */
  662.         foreach ($this->pointMovements as $pointMovement) {
  663.             $catalogPointsAmount += $pointMovement->getPoints();
  664.         }
  666.         return $catalogPointsAmount;
  667.     }
  669.     public function getCatalogPointsAmountUntilDate(DateTime $date): float
  670.     {
  671.         $catalogPointsAmount = 0.0;
  672.         $dateStr = $date->format('Y-m-d');
  673.         /** @var CatalogPointMovement $pointMovement */
  674.         foreach ($this->pointMovements as $pointMovement) {
  675.             $pointMovementDateStr = $pointMovement->getDate()->format(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT);
  676.             if (strtotime($pointMovementDateStr) <= strtotime($dateStr)) {
  677.                 $catalogPointsAmount += $pointMovement->getPoints();
  678.             }
  679.         }
  681.         return $catalogPointsAmount;
  682.     }
  684.     public function getOwnerEarnedPointsWithinCalendarYear(\DateTimeInterface $date): float
  685.     {
  686.         $catalogPointsAmount = 0.0;
  687.         $firstDate = \DateTimeImmutable::createFromFormat(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT, $date->format('Y').'-01-01');
  688.         $lastDate = \DateTimeImmutable::createFromFormat(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT, $date->format('Y').'-12-31');
  689.         $firstDateYearStr = $firstDate->format(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT);
  690.         $lastDateYearStr = $lastDate->format(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT);
  691.         /** @var CatalogPointMovement $pointMovement */
  692.         foreach ($this->pointMovements as $pointMovement) {
  693.             // if the pointMovement date is within the given calendar year
  694.             $pointMovementDateStr = $pointMovement->getDate()->format(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT);
  695.             // si son puntos positivos (los que gasta son negativos) y no es una devolucion
  696.             if ($pointMovementDateStr >= $firstDateYearStr && $pointMovementDateStr <= $lastDateYearStr && !$pointMovement->isReturnMovement() && ($pointMovement->getPoints() > 0.00001)) {
  697.                 $catalogPointsAmount += $pointMovement->getPoints();
  698.             }
  699.         }
  701.         return $catalogPointsAmount;
  702.     }
  704.     public function getGarageEarnedPointsWithinCalendarYear(Garage $garage, \DateTimeInterface $date): float
  705.     {
  706.         $catalogPointsAmount = 0.0;
  707.         $firstDate = \DateTimeImmutable::createFromFormat(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT, $date->format('Y').'-01-01');
  708.         $lastDate = \DateTimeImmutable::createFromFormat(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT, $date->format('Y').'-12-31');
  709.         $firstDateYearStr = $firstDate->format(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT);
  710.         $lastDateYearStr = $lastDate->format(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT);
  711.         /** @var CatalogPointMovement $pointMovement */
  712.         foreach ($this->pointMovements as $pointMovement) {
  713.             // if the pointMovement belongs to the given garage
  714.             if ($pointMovement->getGarage() && $pointMovement->getGarage()->getId() === $garage->getId()) {
  715.                 // if the pointMovement date is within the given calendar year
  716.                 $pointMovementDateStr = $pointMovement->getDate()->format(MiniAbstractBase::DEFAULT_DATE_DATABASE_FORMAT);
  717.                 // si son puntos positivos (los que gasta son negativos) y no es una devolucion
  718.                 if ($pointMovementDateStr >= $firstDateYearStr && $pointMovementDateStr <= $lastDateYearStr && !$pointMovement->isReturnMovement() && ($pointMovement->getPoints() > 0.00001)) {
  719.                     $catalogPointsAmount += $pointMovement->getPoints();
  720.                 }
  721.             }
  722.         }
  724.         return $catalogPointsAmount;
  725.     }
  727.     public function __toString(): string
  728.     {
  729.         return $this->id ? $this->getUsername() : MiniAbstractBase::DEFAULT_EMPTY_STRING;
  730.     }
  731. }