src/Entity/Eg/Admin/User.php line 24

Open in your IDE?
  1. <?php
  3. namespace App\Entity\Eg\Admin;
  5. use App\Entity\DictionaryImport;
  6. use App\Entity\Eg\Osm\City;
  7. use App\Entity\Eg\Osm\Organization;
  8. use App\Repository\UserRepository;
  9. use Doctrine\Common\Collections\ArrayCollection;
  10. use Doctrine\Common\Collections\Collection;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  13. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  14. use Symfony\Component\Security\Core\User\UserInterface;
  16. #[ORM\Table(name: 'eg_admin_user')]
  17. #[ORM\Entity(repositoryClass: UserRepository::class)]
  18. #[ORM\HasLifecycleCallbacks]
  19. #[UniqueEntity(fields: ['username'], message: 'user.is_already.with_this_username')]
  20. #[UniqueEntity(fields: ['email'], message: 'user.is_already.with_this_email')]
  21. #[ORM\UniqueConstraint(name: 'uniq_e524bf7592fc23a8', columns: ['username_canonical'])]
  22. #[ORM\UniqueConstraint(name: 'uniq_e524bf75c05fb297', columns: ['confirmation_token'])]
  23. #[ORM\UniqueConstraint(name: 'uniq_e524bf75a0d96fbf', columns: ['email_canonical'])]
  24. class User implements UserInterface, PasswordAuthenticatedUserInterface
  25. {
  26.     private const SYSTEM_USERS = [
  27.         'root',
  28.         'visitor',
  29.     ];
  30.     private const ROLE_SUPER_ADMIN = 'ROLE_SUPER_ADMIN';
  31.     private const ROLE_DEFAULT = 'ROLE_USER';
  33.     #[ORM\Id]
  34.     #[ORM\GeneratedValue(strategy: 'IDENTITY')]
  35.     #[ORM\Column(type: 'integer')]
  36.     private ?int $id = null;
  38.     /**
  39.      * @var string
  40.      */
  41.     #[ORM\Column(type: 'string', length: 180, unique: true)]
  42.     private $username;
  44.     /**
  45.      * @var string
  46.      */
  47.     #[ORM\Column(type: 'string', length: 180, nullable: false)]
  48.     private $usernameCanonical;
  50.     /**
  51.      * @var string
  52.      */
  53.     #[ORM\Column(type: 'string', length: 180, nullable: false)]
  54.     private $email;
  56.     /**
  57.      * @var string
  58.      */
  59.     #[ORM\Column(type: 'string', length: 180, nullable: false)]
  60.     private $emailCanonical;
  62.     /**
  63.      * @var bool
  64.      */
  65.     #[ORM\Column(type: 'boolean', nullable: false)]
  66.     private $enabled;
  68.     /**
  69.      * @var string|null
  70.      */
  71.     #[ORM\Column(type: 'string', length: 255, nullable: true)]
  72.     private $salt;
  74.     /**
  75.      * @var string
  76.      */
  77.     #[ORM\Column(type: 'string', length: 255, nullable: false)]
  78.     private $password;
  80.     /**
  81.      * @var \DateTimeInterface|null
  82.      */
  83.     #[ORM\Column(type: 'datetime', nullable: true)]
  84.     private $lastLogin;
  86.     /**
  87.      * @var string|null
  88.      */
  89.     #[ORM\Column(type: 'string', length: 180, nullable: true)]
  90.     private $confirmationToken;
  92.     /**
  93.      * @var \DateTimeInterface|null
  94.      */
  95.     #[ORM\Column(type: 'datetime', nullable: true)]
  96.     private $passwordRequestedAt;
  98.     /**
  99.      * @var array
  100.      */
  101.     #[ORM\Column(type: 'array', nullable: false)]
  102.     private $roles = [];
  104.     /**
  105.      * @var string|null
  106.      */
  107.     #[ORM\Column(type: 'string', length: 24, nullable: true)]
  108.     private $startingEntity;
  110.     /**
  111.      * @var string|null
  112.      */
  113.     #[ORM\Column(type: 'string', length: 12, nullable: true)]
  114.     private $startingAction;
  116.     /**
  117.      * @var int|null
  118.      */
  119.     #[ORM\Column(type: 'integer', nullable: true)]
  120.     private $startingId;
  122.     /**
  123.      * @var string
  124.      */
  125.     #[ORM\Column(type: 'string', length: 7, nullable: false)]
  126.     private $color;
  128.     /**
  129.      * @var \DateTimeInterface|null
  130.      */
  131.     #[ORM\Column(type: 'datetime', nullable: true)]
  132.     private $deletedAt;
  134.     /** @var Collection<int, Organization> */
  135.     #[ORM\ManyToMany(targetEntity: Organization::class, inversedBy: 'users')]
  136.     #[ORM\JoinTable(name: 'eg_admin_user_organization_join')]
  137.     private Collection $organizations;
  139.     /**
  140.      * @var Collection
  141.      */
  142.     #[ORM\JoinTable(name: 'eg_admin_user_group_join')]
  143.     #[ORM\JoinColumn(name: 'user_id', referencedColumnName: 'id')]
  144.     #[ORM\InverseJoinColumn(name: 'group_id', referencedColumnName: 'id')]
  145.     #[ORM\ManyToMany(targetEntity: UserGroup::class, inversedBy: 'users')]
  146.     private $groups;
  148.     /** @var Collection<int, City> */
  149.     #[ORM\ManyToMany(targetEntity: City::class, inversedBy: 'users')]
  150.     #[ORM\JoinTable(name: 'eg_osm_user_city_join')]
  151.     private Collection $cities;
  153.     #[ORM\Column(type: 'datetimetz', nullable: true)]
  154.     private $createdAt;
  156.     #[ORM\Column(type: 'datetimetz', nullable: true)]
  157.     private $updatedAt;
  159.     #[ORM\OneToMany(targetEntity: DictionaryImport::class, mappedBy: 'createdBy')]
  160.     private $dictionaryImports;
  162.     public static function getSystemUsers(): array
  163.     {
  164.         return self::SYSTEM_USERS;
  165.     }
  167.     public static function getRoleSuperAdmin(): string
  168.     {
  169.         return self::ROLE_SUPER_ADMIN;
  170.     }
  172.     public function __construct()
  173.     {
  174.         $this->organizations = new ArrayCollection();
  175.         $this->groups = new ArrayCollection();
  176.         $this->cities = new ArrayCollection();
  177.         $now = new \DateTime();
  179.         $this->setCreatedAt($now);
  180.         $this->setUpdatedAt($now);
  181.         $this->dictionaryImports = new ArrayCollection();
  182.     }
  184.     public function __toString(): string
  185.     {
  186.         return $this->getUserIdentifier();
  187.     }
  189.     #[ORM\PreUpdate]
  190.     public function onPreUpdate(): void
  191.     {
  192.         $this->setUpdatedAt(new \DateTime());
  193.     }
  195.     /**
  196.      * Metoda do kanonizowania stringów (zabezpieczania pól)
  197.      */
  198.     public function canonicalize($string)
  199.     {
  200.         if (null === $string) {
  201.             return;
  202.         }
  204.         $encoding = mb_detect_encoding($string);
  205.         $result = $encoding
  206.             ? mb_convert_case($string, MB_CASE_LOWER, $encoding)
  207.             : mb_convert_case($string, MB_CASE_LOWER);
  209.         return $result;
  210.     }
  212.     public function isGranted(string $role, bool $checkSuperAdmin = true): bool
  213.     {
  214.         if ($this->hasRole($role) || $this->hasRole('ROLE_SUPER_ADMIN') && $checkSuperAdmin) {
  215.             return true;
  216.         }
  218.         foreach ($this->getGroups() as $group) {
  219.             if ($group->hasRole($role) || $group->hasRole('ROLE_SUPER_ADMIN') && $checkSuperAdmin) {
  220.                 return true;
  221.             }
  222.         }
  224.         return false;
  225.     }
  227.     public function hasRole(string $role): bool
  228.     {
  229.         return \in_array(\strtoupper($role), $this->getRoles(), true);
  230.     }
  232.     public function getId(): ?int
  233.     {
  234.         return $this->id;
  235.     }
  237.     /**
  238.      * @deprecated since Symfony 5.3, use getUserIdentifier instead
  239.      */
  240.     public function getUsername(): ?string
  241.     {
  242.         return $this->username;
  243.     }
  245.     public function setUsername(string $username): self
  246.     {
  247.         $this->username = $username;
  248.         $this->setUsernameCanonical(
  249.             $this->canonicalize($username)
  250.         );
  252.         return $this;
  253.     }
  255.     public function getUsernameCanonical(): ?string
  256.     {
  257.         return $this->usernameCanonical;
  258.     }
  260.     public function setUsernameCanonical(string $usernameCanonical): self
  261.     {
  262.         $this->usernameCanonical = $usernameCanonical;
  264.         return $this;
  265.     }
  267.     public function getEmail(): ?string
  268.     {
  269.         return $this->email;
  270.     }
  272.     public function setEmail(string $email): self
  273.     {
  274.         $this->email = $email;
  275.         $this->setEmailCanonical(
  276.             $this->canonicalize($email)
  277.         );
  279.         return $this;
  280.     }
  282.     public function getEmailCanonical(): ?string
  283.     {
  284.         return $this->emailCanonical;
  285.     }
  287.     public function setEmailCanonical(string $emailCanonical): self
  288.     {
  289.         $this->emailCanonical = $emailCanonical;
  291.         return $this;
  292.     }
  294.     public function getEnabled(): ?bool
  295.     {
  296.         return $this->enabled;
  297.     }
  299.     public function setEnabled(bool $enabled): self
  300.     {
  301.         $this->enabled = $enabled;
  303.         return $this;
  304.     }
  306.     /**
  307.      * Returning a salt is only needed, if you are not using a modern
  308.      * hashing algorithm (e.g. bcrypt or sodium) in your security.yaml.
  309.      *
  310.      * @see UserInterface
  311.      */
  312.     public function getSalt(): ?string
  313.     {
  314.         return null;
  315.     }
  317.     /**
  318.      * @see PasswordAuthenticatedUserInterface
  319.      */
  320.     public function getPassword(): ?string
  321.     {
  322.         return $this->password;
  323.     }
  325.     public function setPassword(string $password): self
  326.     {
  327.         $this->password = $password;
  329.         return $this;
  330.     }
  332.     public function getLastLogin(): ?\DateTimeInterface
  333.     {
  334.         return $this->lastLogin;
  335.     }
  337.     public function setLastLogin(?\DateTimeInterface $lastLogin): self
  338.     {
  339.         $this->lastLogin = $lastLogin;
  341.         return $this;
  342.     }
  344.     public function getConfirmationToken(): ?string
  345.     {
  346.         return $this->confirmationToken;
  347.     }
  349.     public function setConfirmationToken(?string $confirmationToken): self
  350.     {
  351.         $this->confirmationToken = $confirmationToken;
  353.         return $this;
  354.     }
  356.     public function getPasswordRequestedAt(): ?\DateTimeInterface
  357.     {
  358.         return $this->passwordRequestedAt;
  359.     }
  361.     public function setPasswordRequestedAt(?\DateTimeInterface $passwordRequestedAt): self
  362.     {
  363.         $this->passwordRequestedAt = $passwordRequestedAt;
  365.         return $this;
  366.     }
  368.     /**
  369.      * @see UserInterface
  370.      */
  371.     public function getRoles(): ?array
  372.     {
  373.         $roles = $this->roles;
  375.         foreach ($this->getGroups() as $group) {
  376.             $roles = \array_merge($roles, $group->getRoles());
  377.         }
  379.         // guarantee every user at least has ROLE_USER
  380.         $roles[] = self::ROLE_DEFAULT;
  382.         return \array_unique($roles);
  383.     }
  385.     public function addRole(string $role): self
  386.     {
  387.         if (!in_array($role, $this->roles)) {
  388.             $this->roles[] = $role;
  389.         }
  391.         return $this;
  392.     }
  394.     public function setRoles(array $roles): self
  395.     {
  396.         $this->roles = $roles;
  398.         return $this;
  399.     }
  401.     public function getStartingEntity(): ?string
  402.     {
  403.         return $this->startingEntity;
  404.     }
  406.     public function setStartingEntity(?string $startingEntity): self
  407.     {
  408.         $this->startingEntity = $startingEntity;
  410.         return $this;
  411.     }
  413.     public function getStartingAction(): ?string
  414.     {
  415.         return $this->startingAction;
  416.     }
  418.     public function setStartingAction(?string $startingAction): self
  419.     {
  420.         $this->startingAction = $startingAction;
  422.         return $this;
  423.     }
  425.     public function getStartingId(): ?int
  426.     {
  427.         return $this->startingId;
  428.     }
  430.     public function setStartingId(?int $startingId): self
  431.     {
  432.         $this->startingId = $startingId;
  434.         return $this;
  435.     }
  437.     public function getColor(): ?string
  438.     {
  439.         return $this->color;
  440.     }
  442.     public function setColor(string $color): self
  443.     {
  444.         $this->color = $color;
  446.         return $this;
  447.     }
  449.     public function getDeletedAt(): ?\DateTimeInterface
  450.     {
  451.         return $this->deletedAt;
  452.     }
  454.     public function setDeletedAt(?\DateTimeInterface $deletedAt): self
  455.     {
  456.         $this->deletedAt = $deletedAt;
  458.         return $this;
  459.     }
  461.     /** @return Collection<int, Organization> */
  462.     public function getOrganizations(): Collection
  463.     {
  464.         return $this->organizations;
  465.     }
  467.     /**
  468.      * @return Collection<int, UserGroup>
  469.      */
  470.     public function getGroups(): Collection
  471.     {
  472.         return $this->groups;
  473.     }
  475.     public function addGroup(UserGroup $group): self
  476.     {
  477.         if (!$this->groups->contains($group)) {
  478.             $this->groups[] = $group;
  479.         }
  481.         return $this;
  482.     }
  484.     public function removeGroup(UserGroup $group): self
  485.     {
  486.         $this->groups->removeElement($group);
  488.         return $this;
  489.     }
  491.     /** @return Collection<int, City> */
  492.     public function getCities(): Collection
  493.     {
  494.         return $this->cities;
  495.     }
  497.     /**
  498.      * @see UserInterface
  499.      */
  500.     public function eraseCredentials()
  501.     {
  502.         // If you store any temporary, sensitive data on the user, clear it here
  503.         //
  504.     }
  506.     /**
  507.      * A visual identifier that represents this user.
  508.      *
  509.      * @see UserInterface
  510.      */
  511.     public function getUserIdentifier(): string
  512.     {
  513.         return (string) $this->username;
  514.     }
  516.     public function getCreatedAt(): ?\DateTimeInterface
  517.     {
  518.         return $this->createdAt;
  519.     }
  521.     public function setCreatedAt(?\DateTimeInterface $createdAt): self
  522.     {
  523.         $this->createdAt = $createdAt;
  525.         return $this;
  526.     }
  528.     public function getUpdatedAt(): ?\DateTimeInterface
  529.     {
  530.         return $this->updatedAt;
  531.     }
  533.     public function setUpdatedAt(?\DateTimeInterface $updatedAt): self
  534.     {
  535.         $this->updatedAt = $updatedAt;
  537.         return $this;
  538.     }
  540.     public function isSuperAdmin(): bool
  541.     {
  542.         return $this->hasRole('ROLE_SUPER_ADMIN');
  543.     }
  545.     /**
  546.      * @return Collection<int, DictionaryImport>
  547.      */
  548.     public function getDictionaryImports(): Collection
  549.     {
  550.         return $this->dictionaryImports;
  551.     }
  553.     public function addDictionaryImport(DictionaryImport $dictionaryImport): self
  554.     {
  555.         if (!$this->dictionaryImports->contains($dictionaryImport)) {
  556.             $this->dictionaryImports[] = $dictionaryImport;
  557.             $dictionaryImport->setCreatedBy($this);
  558.         }
  560.         return $this;
  561.     }
  562. }