src/Entity/User.php line 32

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Entity\Building\Building;
  6. use App\Entity\Building\BuildingListField;
  7. use App\Entity\Client\Client;
  8. use App\Entity\Client\ClientGroup;
  9. use App\Entity\Common\UrlDomain;
  10. use App\Entity\Extension\DisabledTrait;
  11. use App\Entity\Extension\TimestampableTrait;
  12. use App\Entity\Gauge\Gauge;
  13. use App\Entity\Gauge\GaugeListField;
  14. use App\Repository\UserRepository;
  15. use App\Utils\Units;
  16. use Doctrine\Common\Collections\ArrayCollection;
  17. use Doctrine\Common\Collections\Collection;
  18. use Doctrine\ORM\Mapping as ORM;
  19. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  20. use Symfony\Component\Security\Core\User\UserInterface;
  21. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  22. use Symfony\Component\Validator\Constraints as Assert;
  23. use Symfony\Component\Serializer\Annotation\Groups;
  25. /**
  26. * @ORM\Entity(repositoryClass=UserRepository::class)
  27. * @ORM\Table(name="users")
  28. *
  29. * @UniqueEntity("username")
  30. * @UniqueEntity("email")
  31. */
  32. class User implements UserInterface, PasswordAuthenticatedUserInterface
  33. {
  34. use TimestampableTrait;
  35. use DisabledTrait;
  37. /**
  38. * @var null|int
  39. * @ORM\Id()
  40. * @ORM\GeneratedValue()
  41. * @ORM\Column(type="integer")
  42. * @Groups({"list"})
  43. */
  44. private ?int $id = null;
  46. /**
  47. * @var string
  48. * @ORM\Column(type="string", length=180, unique=true)
  49. *
  50. * @Assert\NotBlank
  51. * @Assert\Type(type="string")
  52. * @Assert\Email
  53. * @Groups({"profile", "list"})
  54. */
  55. private string $email;
  57. /**
  58. * @var string
  59. * @ORM\Column(type="string", unique=true)
  60. *
  61. * @Assert\NotBlank
  62. * @Assert\Type(type="string")
  63. */
  64. private string $username;
  66. /**
  67. * @var string The hashed password
  68. * @ORM\Column(type="string")
  69. *
  70. * @Assert\NotBlank
  71. * @Assert\Type(type="string")
  72. */
  73. private string $password;
  75. /**
  76. * @var bool
  77. * @ORM\Column(type="boolean")
  78. *
  79. * @Assert\NotNull
  80. * @Assert\Type(type="boolean")
  81. * @Groups({"profile"})
  82. */
  83. private bool $hasDarkMode;
  85. /**
  86. * @var Role
  87. * @ORM\ManyToOne(targetEntity="App\Entity\Role", inversedBy="users")
  88. * @ORM\JoinColumn(name="role_id", referencedColumnName="id", nullable=false)
  89. * @Assert\NotBlank
  90. */
  91. private Role $role;
  93. /**
  94. * @var string|null
  95. * @ORM\Column(type="string", nullable=true)
  96. * @Groups({"list"})
  97. */
  98. private ?string $firstname;
  100. /**
  101. * @var string|null
  102. * @ORM\Column(type="string", nullable=true)
  103. * @Groups({"list"})
  104. */
  105. private ?string $lastname;
  107. /**
  108. * @var string|null
  109. * @ORM\Column(type="string", nullable=true)
  110. * @Groups({"list"})
  111. * @Assert\Length(
  112. * min = 9,
  113. * max = 13,
  114. * minMessage = "Telefon musí mít alespoň {{ limit }} znaků (bez mezer).",
  115. * maxMessage = "Telefon musí může mít maximálně {{ limit }} znaků."
  116. * )
  117. */
  118. private ?string $phone;
  120. /**
  121. * @var Client
  122. * @ORM\ManyToOne(targetEntity="App\Entity\Client\Client", inversedBy="users")
  123. * @ORM\JoinColumn(name="client_id", nullable=false)
  124. * @Groups({"list"})
  125. */
  126. private Client $client;
  128. /**
  129. * @var ClientGroup|null
  130. * @ORM\ManyToOne(targetEntity="App\Entity\Client\ClientGroup", inversedBy="users")
  131. */
  132. private ?ClientGroup $clientGroup;
  134. /**
  135. * @var boolean
  136. * @ORM\Column(type="boolean")
  137. * @Groups({"list"})
  138. */
  139. private bool $enabled;
  141. /**
  142. * @var string|null
  143. * @ORM\Column(type="string", nullable=true)
  144. */
  145. private ?string $entryPage = null;
  147. /**
  148. * @var Gauge|null
  149. * @ORM\ManyToOne(targetEntity="App\Entity\Gauge\Gauge")
  150. * @ORM\JoinColumn(name="entry_page_gauge_id", referencedColumnName="id", nullable=true)
  151. */
  152. private ?Gauge $entryPageGauge = null;
  154. /**
  155. * @var int
  156. * @ORM\Column(type="integer")
  157. */
  158. private int $primaryUnit = Units::KWH_VALUE; // default unit
  160. /**
  161. * @var Collection|Building[]
  162. * @ORM\ManyToMany(targetEntity="App\Entity\Building\Building", inversedBy="users", cascade={"persist"})
  163. * @ORM\OrderBy({"name" = "ASC"})
  164. * @ORM\JoinTable(name="users_buildings")
  165. */
  166. private $buildings;
  168. /**
  169. * @var Collection|BuildingListField[]
  170. * @ORM\OneToMany(targetEntity="App\Entity\Building\BuildingListField", mappedBy="user", cascade={"persist"}, orphanRemoval=true)
  171. * @ORM\OrderBy({"position" = "ASC"})
  172. * @Groups("user")
  173. */
  174. private $buildingListFields;
  176. /**
  177. * @var Collection|GaugeListField[]
  178. * @ORM\OneToMany(targetEntity="App\Entity\Gauge\GaugeListField", mappedBy="user", cascade={"persist"}, orphanRemoval=true)
  179. * @ORM\OrderBy({"position" = "ASC"})
  180. * @Groups("user")
  181. */
  182. private $gaugeListFields;
  184. /**
  185. * @var Collection|ActivityLog[]
  186. * @ORM\OneToMany(targetEntity="App\Entity\ActivityLog", mappedBy="user")
  187. */
  188. private $activities;
  190. /**
  191. * just for creating form (not in dtb)
  192. * @var boolean
  193. */
  194. private bool $sendInitMail = false;
  196. /**
  197. * @var boolean
  198. * @ORM\Column(type="boolean")
  199. */
  200. private bool $emailReporting;
  202. /**
  203. * @var boolean
  204. * @ORM\Column(type="boolean")
  205. */
  206. private bool $smsReporting;
  208. /**
  209. * @var boolean
  210. * @ORM\Column(type="boolean", options={"default": 0})
  211. */
  212. private bool $incidentEmailReporting;
  214. /**
  215. * @var boolean
  216. * @ORM\Column(type="boolean", options={"default" : 1})
  217. */
  218. private bool $emailReminder;
  220. /**
  221. * @var Client|null
  222. * @ORM\OneToOne(targetEntity="App\Entity\Client\Client", mappedBy="mainManager")
  223. */
  224. private ?Client $mainManagerOf;
  225. /**
  226. * @var Collection|UserWidget[]
  227. * @ORM\OneToMany(targetEntity="App\Entity\UserWidget", mappedBy="user")
  228. */
  229. private $widgets;
  231. /**
  232. * @var \DateTime|null
  233. *
  234. * @ORM\Column(name="agreement_at", type="datetime", nullable=true)
  235. */
  236. private ?\DateTime $agreementAt;
  238. /**
  239. * @var Collection|UrlDomain[]
  240. * @ORM\ManyToMany(targetEntity="App\Entity\Common\UrlDomain", inversedBy="users", cascade={"persist"})
  241. * @ORM\OrderBy({"name" = "ASC"})
  242. */
  243. private Collection $allowedDomains;
  245. /**
  246. * @var \DateTimeInterface|null
  247. *
  248. * @ORM\Column(name="last_activity_at", type="datetime", nullable=true)
  249. */
  250. protected ?\DateTimeInterface $lastActivity;
  252. public function __construct()
  253. {
  254. $this->email = '';
  255. $this->username = '';
  256. $this->password = '';
  258. $this->enabled = false;
  259. $this->emailReporting = true;
  260. $this->smsReporting = false;
  261. $this->incidentEmailReporting = false;
  262. $this->hasDarkMode = false;
  263. $this->emailReminder = true;
  265. $this->buildings = new ArrayCollection();
  266. $this->buildingListFields = new ArrayCollection();
  267. $this->activities = new ArrayCollection();
  268. $this->widgets = new ArrayCollection();
  269. $this->allowedDomains = new ArrayCollection();
  270. }
  273. /**
  274. * @return int|null
  275. */
  276. public function getId(): ?int
  277. {
  278. return $this->id;
  279. }
  281. /**
  282. * A visual identifier that represents this user.
  283. *
  284. * @see UserInterface
  285. */
  286. public function getUsername(): string
  287. {
  288. return $this->username ?? '';
  289. }
  291. /**
  292. * @param string $username
  293. * @return $this
  294. */
  295. public function setUsername(string $username): self
  296. {
  297. $this->username = $username;
  299. return $this;
  300. }
  303. /**
  304. * @see UserInterface
  305. */
  306. public function getPassword(): string
  307. {
  308. return $this->password;
  309. }
  311. /**
  312. * @param string $password
  313. * @return $this
  314. */
  315. public function setPassword(string $password): self
  316. {
  317. $this->password = $password;
  319. return $this;
  320. }
  322. /**
  323. * @see UserInterface
  324. */
  325. public function getSalt(): ?string
  326. {
  327. return null;
  328. // not needed when using the "bcrypt" algorithm in security.yaml
  329. }
  331. /**
  332. * @see UserInterface
  333. */
  334. public function eraseCredentials(): void
  335. {
  336. // If you store any temporary, sensitive data on the user, clear it here
  337. // $this->plainPassword = null;
  338. }
  340. /**
  341. * @return string
  342. */
  343. public function getEmail(): string
  344. {
  345. return $this->email;
  346. }
  348. /**
  349. * @param string $email
  350. * @return User
  351. */
  352. public function setEmail(string $email): User
  353. {
  354. $this->email = $email;
  355. return $this;
  356. }
  358. /**
  359. * @return bool|null
  360. */
  361. public function getHasDarkMode(): ?bool
  362. {
  363. return $this->hasDarkMode;
  364. }
  366. /**
  367. * @param bool $hasDarkMode
  368. * @return $this
  369. */
  370. public function setHasDarkMode(bool $hasDarkMode): self
  371. {
  372. $this->hasDarkMode = $hasDarkMode;
  374. return $this;
  375. }
  378. /**
  379. * @return string|null
  380. */
  381. public function getFirstname(): ?string
  382. {
  383. return $this->firstname;
  384. }
  386. /**
  387. * @param string|null $firstname
  388. * @return User
  389. */
  390. public function setFirstname(?string $firstname): User
  391. {
  392. $this->firstname = $firstname;
  393. return $this;
  394. }
  396. /**
  397. * @return string|null
  398. */
  399. public function getLastname(): ?string
  400. {
  401. return $this->lastname;
  402. }
  404. /**
  405. * @param string|null $lastname
  406. * @return User
  407. */
  408. public function setLastname(?string $lastname): User
  409. {
  410. $this->lastname = $lastname;
  411. return $this;
  412. }
  414. /**
  415. * @return string
  416. */
  417. public function getName(): string
  418. {
  419. return $this->firstname . ' ' . $this->lastname;
  420. }
  422. /**
  423. * @return string|null
  424. */
  425. public function getPhone(): ?string
  426. {
  427. return $this->phone;
  428. }
  430. /**
  431. * @param string|null $phone
  432. * @return User
  433. */
  434. public function setPhone(?string $phone): User
  435. {
  436. $this->phone = $phone;
  437. return $this;
  438. }
  440. /**
  441. * @return Client
  442. */
  443. public function getClient(): Client
  444. {
  445. return $this->client;
  446. }
  448. /**
  449. * @param Client $client
  450. * @return User
  451. */
  452. public function setClient(Client $client): User
  453. {
  454. $this->client = $client;
  455. return $this;
  456. }
  458. /**
  459. * @return ClientGroup|null
  460. */
  461. public function getClientGroup(): ?ClientGroup
  462. {
  463. return $this->clientGroup;
  464. }
  466. /**
  467. * @param ClientGroup|null $clientGroup
  468. * @return User
  469. */
  470. public function setClientGroup(?ClientGroup $clientGroup): User
  471. {
  472. $this->clientGroup = $clientGroup;
  473. return $this;
  474. }
  476. /**
  477. * @return bool
  478. */
  479. public function isEnabled(): bool
  480. {
  481. return $this->enabled;
  482. }
  484. /**
  485. * @param bool $enabled
  486. * @return User
  487. */
  488. public function setEnabled(bool $enabled): User
  489. {
  490. $this->enabled = $enabled;
  491. return $this;
  492. }
  494. /**
  495. * @return string|null
  496. */
  497. public function getEntryPage(): ?string
  498. {
  499. return $this->entryPage;
  500. }
  502. /**
  503. * @param string|null $entryPage
  504. * @return User
  505. */
  506. public function setEntryPage(?string $entryPage): User
  507. {
  508. $this->entryPage = $entryPage;
  509. return $this;
  510. }
  512. /**
  513. * @return Gauge|null
  514. */
  515. public function getEntryPageGauge(): ?Gauge
  516. {
  517. return $this->entryPageGauge;
  518. }
  520. /**
  521. * @param Gauge|null $entryPageGauge
  522. * @return User
  523. */
  524. public function setEntryPageGauge(?Gauge $entryPageGauge): User
  525. {
  526. $this->entryPageGauge = $entryPageGauge;
  527. return $this;
  528. }
  530. /**
  531. * @return int
  532. */
  533. public function getPrimaryUnit(): int
  534. {
  535. return $this->primaryUnit;
  536. }
  538. /**
  539. * @param int $primaryUnit
  540. * @return User
  541. */
  542. public function setPrimaryUnit(int $primaryUnit): User
  543. {
  544. $this->primaryUnit = $primaryUnit;
  545. return $this;
  546. }
  548. /**
  549. * @return Building[]|Collection
  550. */
  551. public function getBuildings()
  552. {
  553. return $this->buildings;
  554. }
  556. /**
  557. * @param Building[]|Collection $buildings
  558. * @return User
  559. */
  560. public function setBuildings($buildings): User
  561. {
  562. $this->buildings = $buildings;
  563. return $this;
  564. }
  566. /**
  567. * @return bool
  568. */
  569. public function isEmailReporting(): bool
  570. {
  571. return $this->emailReporting;
  572. }
  574. /**
  575. * @param bool $emailReporting
  576. * @return User
  577. */
  578. public function setEmailReporting(bool $emailReporting): User
  579. {
  580. $this->emailReporting = $emailReporting;
  581. return $this;
  582. }
  584. /**
  585. * @return bool
  586. */
  587. public function isSmsReporting(): bool
  588. {
  589. return $this->smsReporting;
  590. }
  592. /**
  593. * @param bool $smsReporting
  594. * @return User
  595. */
  596. public function setSmsReporting(bool $smsReporting): User
  597. {
  598. $this->smsReporting = $smsReporting;
  599. return $this;
  600. }
  602. /**
  603. * @return bool|null
  604. */
  605. public function getEnabled(): ?bool
  606. {
  607. return $this->enabled;
  608. }
  610. /**
  611. * @return bool|null
  612. */
  613. public function getEmailReporting(): ?bool
  614. {
  615. return $this->emailReporting;
  616. }
  618. /**
  619. * @return bool|null
  620. */
  621. public function getSmsReporting(): ?bool
  622. {
  623. return $this->smsReporting;
  624. }
  626. /**
  627. * @return bool
  628. */
  629. public function isIncidentEmailReporting(): bool
  630. {
  631. return $this->incidentEmailReporting;
  632. }
  634. /**
  635. * @return bool|null
  636. */
  637. public function getIncidentEmailReporting(): ?bool
  638. {
  639. return $this->incidentEmailReporting;
  640. }
  642. /**
  643. * @param bool $incidentEmailReporting
  644. * @return User
  645. */
  646. public function setIncidentEmailReporting(bool $incidentEmailReporting): User
  647. {
  648. $this->incidentEmailReporting = $incidentEmailReporting;
  649. return $this;
  650. }
  652. /**
  653. * @param Building $building
  654. * @return $this
  655. */
  656. public function addBuilding(Building $building): self
  657. {
  658. if (!$this->buildings->contains($building)) {
  659. $this->buildings[] = $building;
  660. }
  662. return $this;
  663. }
  665. /**
  666. * @param Building $building
  667. * @return $this
  668. */
  669. public function removeBuilding(Building $building): self
  670. {
  671. if ($this->buildings->contains($building)) {
  672. $this->buildings->removeElement($building);
  673. }
  675. return $this;
  676. }
  678. /**
  679. * @return BuildingListField[]|Collection
  680. */
  681. public function getBuildingListFields()
  682. {
  683. return $this->buildingListFields;
  684. }
  686. /**
  687. * @param BuildingListField[]|Collection $buildingListFields
  688. * @return User
  689. */
  690. public function setBuildingListFields($buildingListFields): self
  691. {
  692. $this->buildingListFields = $buildingListFields;
  693. return $this;
  694. }
  696. /**
  697. * @return Role
  698. */
  699. public function getRole(): Role
  700. {
  701. return $this->role;
  702. }
  704. /**
  705. * @param Role $role
  706. * @return User
  707. */
  708. public function setRole(Role $role): User
  709. {
  710. $this->role = $role;
  711. return $this;
  712. }
  714. /**
  715. * @return string[]
  716. */
  717. public function getRoles(): array
  718. {
  719. $roles = [];
  720. $roles[] = $this->getRole()->getName();
  722. // guarantee every user at least has ROLE_USER
  723. if (!in_array('ROLE_USER', $roles, true)) {
  724. $roles[] = 'ROLE_USER';
  725. }
  727. return array_unique($roles);
  728. }
  730. /**
  731. * @return Collection|ActivityLog[]
  732. */
  733. public function getActivities(): Collection
  734. {
  735. return $this->activities;
  736. }
  738. /**
  739. * @return GaugeListField[]|Collection
  740. */
  741. public function getGaugeListFields()
  742. {
  743. return $this->gaugeListFields;
  744. }
  746. /**
  747. * @param GaugeListField[]|Collection $gaugeListFields
  748. * @return User
  749. */
  750. public function setGaugeListFields($gaugeListFields)
  751. {
  752. $this->gaugeListFields = $gaugeListFields;
  753. return $this;
  754. }
  756. /***
  757. * @return string
  758. */
  759. public function __toString() :string
  760. {
  761. return $this->getName();
  762. }
  764. /**
  765. * @return Client|null
  766. */
  767. public function getMainManagerOf(): ?Client
  768. {
  769. return $this->mainManagerOf;
  770. }
  772. /**
  773. * @param Client|null $mainManagerOf
  774. * @return User
  775. */
  776. public function setMainManagerOf(?Client $mainManagerOf): User
  777. {
  778. $this->mainManagerOf = $mainManagerOf;
  779. return $this;
  780. }
  782. /**
  783. * @return bool
  784. */
  785. public function isSendInitMail(): bool
  786. {
  787. return $this->sendInitMail;
  788. }
  790. /**
  791. * @param bool $sendInitMail
  792. * @return User
  793. */
  794. public function setSendInitMail(bool $sendInitMail): User
  795. {
  796. $this->sendInitMail = $sendInitMail;
  797. return $this;
  798. }
  800. /**
  801. * @return string
  802. */
  803. public function getUserIdentifier(): string
  804. {
  805. return $this->getUsername();
  806. }
  808. /**
  809. * @return bool
  810. */
  811. public function isEmailReminder(): bool
  812. {
  813. return $this->emailReminder;
  814. }
  816. /**
  817. * @param bool $emailReminder
  818. * @return User
  819. */
  820. public function setEmailReminder(bool $emailReminder): User
  821. {
  822. $this->emailReminder = $emailReminder;
  823. return $this;
  824. }
  826. /**
  827. * @return UserWidget[]|Collection
  828. */
  829. public function getWidgets()
  830. {
  831. return $this->widgets;
  832. }
  834. /**
  835. * @param UserWidget $userWidget
  836. * @return $this
  837. */
  838. public function addWidget(UserWidget $userWidget): User
  839. {
  840. $userWidget->setUser($this);
  842. if (!$this->widgets->contains($userWidget)) {
  843. $this->widgets[] = $userWidget;
  844. }
  846. return $this;
  847. }
  849. /**
  850. * @return \DateTime|null
  851. */
  852. public function getAgreementAt(): ?\DateTime
  853. {
  854. return $this->agreementAt;
  855. }
  857. /**
  858. * @param \DateTime|null $agreementAt
  859. * @return User
  860. */
  861. public function setAgreementAt(?\DateTime $agreementAt): User
  862. {
  863. $this->agreementAt = $agreementAt;
  864. return $this;
  865. }
  867. /**
  868. * @return Building[]|Collection
  869. */
  870. public function getAllowedBuildings()
  871. {
  872. if ($this->getRole()->hasPermission('ROLE_CAN_SEE_ALL_BUILDINGS')) {
  873. return $this->getClient()->getBuildings();
  874. }
  876. return $this->getBuildings();
  877. }
  879. /**
  880. * @return array
  881. */
  882. public function getAllowedGauges():array
  883. {
  884. $gauges = [];
  886. foreach ($this->getAllowedBuildings() as $building) {
  887. foreach ($building->getGauges() as $gauge) {
  888. $gauges[] = $gauge;
  889. }
  890. }
  891. return $gauges;
  892. }
  894. public function getAllowedDomains(): Collection
  895. {
  896. return $this->allowedDomains;
  897. }
  899. public function setAllowedDomains(Collection $allowedDomains): User
  900. {
  901. $this->allowedDomains = $allowedDomains;
  902. return $this;
  903. }
  905. public function addAllowedDomain(UrlDomain $domain): User
  906. {
  907. if (!$this->allowedDomains->contains($domain)) {
  908. $this->allowedDomains->add($domain);
  909. }
  911. return $this;
  912. }
  914. public function hasAccessToDomain(string $hostDomain):bool
  915. {
  916. foreach ($this->allowedDomains as $domainOnj) {
  917. if (in_array($hostDomain, $domainOnj->getAliases(), true)) {
  918. return true;
  919. }
  920. }
  922. return false;
  923. }
  925. public function getDefaultDomain(): UrlDomain
  926. {
  927. foreach ($this->allowedDomains as $domain) {
  928. if ($domain->getName() === UrlDomain::DEFAULT_DOMAIN) {
  929. return $domain;
  930. }
  931. }
  933. return $this->allowedDomains->first();
  934. }
  936. public function getLastActivity(): ?\DateTimeInterface
  937. {
  938. return $this->lastActivity;
  939. }
  941. public function setLastActivity(?\DateTimeInterface $lastActivity): User
  942. {
  943. $this->lastActivity = $lastActivity;
  944. return $this;
  945. }
  946. }