src/Entity/User.php line 109

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace App\Entity;
  7. use ApiPlatform\Core\Annotation\ApiResource;
  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;
  14. use Symfony\Component\Validator\Constraints as Assert;
  15. use Doctrine\Common\Collections\ArrayCollection;
  16. use Scheb\TwoFactorBundle\Model\Email\TwoFactorInterface;
  17. use Scheb\TwoFactorBundle\Model\TrustedDeviceInterface;
  19. /**
  20. * @UniqueEntity(fields={"email"})
  21. * @ORM\Entity
  22. * @ORM\Table(name="users")
  23. * @ApiResource(
  24. * iri="http://schema.org/Thing",
  25. * collectionOperations={
  26. * "get"={
  27. * "access_control"="is_granted('ROLE_ADMIN') or is_granted('ROLE_SUPER_ADMIN')",
  28. * "method"="GET",
  29. * "normalization_context"={
  30. * "groups"={
  31. * "output"
  32. * }
  33. * },
  34. * "denormalization_context"={
  35. * "groups"={
  36. * "input"
  37. * }
  38. * }
  39. * },
  40. * "post"={
  41. * "method"="POST",
  42. * "normalization_context"={
  43. * "groups"={
  44. * "output"
  45. * }
  46. * },
  47. * "denormalization_context"={
  48. * "groups"={
  49. * "input"
  50. * }
  51. * }
  52. * }
  53. * },
  54. * itemOperations={
  55. * "get"={
  56. * "access_control"="is_granted('IS_OWNER', object) or is_granted('ROLE_ADMIN') or is_granted('ROLE_SUPER_ADMIN')",
  57. * "method"="GET",
  58. * "normalization_context"={
  59. * "groups"={
  60. * "output"
  61. * }
  62. * },
  63. * "denormalization_context"={
  64. * "groups"={
  65. * "input"
  66. * }
  67. * }
  68. * },
  69. * "put"={
  70. * "access_control"="is_granted('IS_OWNER', object) or is_granted('ROLE_ADMIN') or is_granted('ROLE_SUPER_ADMIN')",
  71. * "method"="PUT",
  72. * "normalization_context"={
  73. * "groups"={
  74. * "output"
  75. * }
  76. * },
  77. * "denormalization_context"={
  78. * "groups"={
  79. * "input"
  80. * }
  81. * }
  82. * }
  83. * },
  84. * attributes={
  85. * "filters"={
  86. * "user.numeric_filter",
  87. * "user.search_filter",
  88. * "user.search_name_filter",
  89. * "user.order_filter",
  90. * "user.date_filter",
  91. * "user.null_filter",
  92. * "user.locked_filter"
  93. * },
  94. * "normalization_context"={
  95. * "groups"={""}
  96. * },
  97. * "denormalization_context"={
  98. * "groups"={""}
  99. * },
  100. * "pagination_items_per_page"=10,
  101. * "pagination_client_items_per_page"=true
  102. * }
  103. * )
  104. *
  105. * The most generic type of item.
  106. *
  107. * @see http://schema.org/Thing Documentation on Schema.org
  108. */
  109. class User implements UserInterface, PasswordAuthenticatedUserInterface, TwoFactorInterface, TrustedDeviceInterface
  110. {
  111. const ROLE_SUPER_ADMIN = 'ROLE_SUPER_ADMIN';
  112. const ROLE_ADMIN = 'ROLE_ADMIN';
  113. const ROLE_USER = 'ROLE_USER';
  114. const EMAIL_2FA_CODE_VALID_TIME = '-10 minutes';
  115. /**
  116. * @ORM\Id
  117. * @ORM\GeneratedValue(strategy="AUTO")
  118. * @ORM\Column(type="integer")
  119. * @Groups({"output"})
  120. *
  121. * @var int|null
  122. */
  123. protected $id;
  125. /**
  126. * @ORM\Column(type="string")
  127. * @Groups({"output", "input"})
  128. *
  129. * @var string|null
  130. */
  131. public $email;
  133. /**
  134. * @ORM\Column(type="boolean")
  135. * @Groups({"input", "output"})
  136. *
  137. * @var bool|null
  138. */
  139. public $enabled;
  141. /**
  142. * @ORM\Column(type="string", nullable=true)
  143. * @var string|null
  144. */
  145. public $salt;
  147. /**
  148. * @ORM\Column(type="string")
  149. * @var string|null
  150. */
  151. public $password;
  153. /**
  154. * @Groups({"input"})
  155. *
  156. * @var string|null
  157. */
  158. public $plainPassword;
  160. /**
  161. * @ORM\Column(type="datetime", nullable=true)
  162. * @Groups({"output"})
  163. *
  164. * @var \DateTimeInterface|null
  165. *
  166. */
  167. public $lastLogin;
  169. /**
  170. * @ORM\Column(type="string", nullable=true)
  171. *
  172. * @var string|null
  173. */
  174. public $confirmationToken;
  176. /**
  177. * @ORM\Column(type="datetime", nullable=true)
  178. *
  179. * @var string|null
  180. */
  181. public $passwordRequestedAt;
  183. /**
  184. * @ORM\Column(type="json")
  185. * @Groups({"input", "output"})
  186. *
  187. * @var array|null
  188. */
  189. public $roles;
  191. /**
  192. * @ORM\Column(type="datetime", nullable=true)
  193. * @Groups({"output"})
  194. *
  195. * @var \DateTimeInterface|null
  196. *
  197. */
  198. public $createdAt;
  200. /**
  201. * @ORM\ManyToOne(targetEntity="App\Entity\User")
  202. *
  203. * @var User|null
  204. */
  205. public $createdBy;
  207. /**
  208. * @ORM\Column(type="datetime", nullable=true)
  209. * @Groups({"output"})
  210. *
  211. * @var \DateTimeInterface|null
  212. *
  213. */
  214. public $updatedAt;
  216. /**
  217. * @ORM\Column(type="datetime", nullable=true)
  218. * @Groups({"output"})
  219. *
  220. * @var \DateTimeInterface|null
  221. *
  222. */
  223. public $statusUpdatedAt;
  225. /**
  226. * @ORM\Column(type="boolean", nullable=true)
  227. * @Groups({"input", "output"})
  228. *
  229. * @var bool|null
  230. */
  231. public $locked;
  233. /**
  234. * @ORM\ManyToOne(targetEntity="App\Entity\User")
  235. *
  236. * @var User|null
  237. */
  238. public $updatedBy;
  240. /**
  241. * @ORM\Column(type="string", length=180, nullable=false)
  242. * @Groups({"output", "input"})
  243. *
  244. * @var string|null
  245. */
  246. public $firstName;
  248. /**
  249. * @ORM\Column(type="string", length=180, nullable=true)
  250. * @Groups({"output", "input"})
  251. *
  252. * @var string|null
  253. */
  254. public $middleName;
  256. /**
  257. * @ORM\Column(type="string", length=180, nullable=false)
  258. * @Groups({"output", "input"})
  259. *
  260. * @var string|null
  261. */
  262. public $lastName;
  264. /**
  265. * @ORM\ManyToOne(targetEntity="App\Entity\PhoneNumber")
  266. * @Groups({"output", "input"})
  267. *
  268. * @var PhoneNumber|null
  269. */
  270. public $homePhoneNumber;
  272. /**
  273. * @ORM\ManyToOne(targetEntity="App\Entity\PhoneNumber")
  274. * @Groups({"output", "input"})
  275. *
  276. * @var PhoneNumber|null
  277. */
  278. public $workPhoneNumber;
  280. /**
  281. * @ORM\ManyToOne(targetEntity="App\Entity\PhoneNumber")
  282. * @Groups({"output", "input"})
  283. *
  284. * @var PhoneNumber|null
  285. */
  286. public $mobilePhoneNumber;
  288. /**
  289. * @ORM\ManyToOne(targetEntity="App\Entity\Lookup")
  290. * @Groups({"security_output", "output", "input"})
  291. *
  292. * @var Lookup|null
  293. */
  294. public $securityQuestion1;
  296. /**
  297. * @ORM\Column(type="string", length=180, nullable=false)
  298. * @Groups({"security_input", "input"})
  299. *
  300. * @var string|null
  301. */
  302. public $securityAnswer1;
  304. /**
  305. * @ORM\ManyToOne(targetEntity="App\Entity\Lookup")
  306. * @Groups({"security_output", "output", "input"})
  307. *
  308. * @var Lookup|null
  309. */
  310. public $securityQuestion2;
  312. /**
  313. * @ORM\Column(type="string", length=180, nullable=false)
  314. * @Groups({"security_input", "input"})
  315. *
  316. * @var string|null
  317. */
  318. public $securityAnswer2;
  320. /**
  321. * @ORM\ManyToOne(targetEntity="App\Entity\Lookup")
  322. * @Groups({"output", "input"})
  323. *
  324. * @var Lookup|null
  325. */
  326. public $primaryLanguage;
  328. /**
  329. * @ORM\ManyToOne(targetEntity="App\Entity\Lookup")
  330. * @Groups({"output", "input"})
  331. *
  332. * @var Lookup|null
  333. */
  334. public $suffix;
  336. /**
  337. * @ORM\ManyToOne(targetEntity="App\Entity\Lookup")
  338. * @Groups({"output", "input"})
  339. *
  340. * @var Lookup|null
  341. */
  342. public $referrerType;
  344. /**
  345. * @ORM\ManyToOne(targetEntity="App\Entity\Lookup")
  346. * @Groups({"output", "input"})
  347. *
  348. * @var Lookup|null
  349. */
  350. public $prefix;
  352. /**
  353. * @ORM\ManyToOne(targetEntity="App\Entity\Lookup")
  354. * @Groups({"output", "input"})
  355. *
  356. * @var Lookup|null
  357. */
  358. public $reference;
  360. /**
  361. * @ORM\Column(type="integer", nullable=true)
  362. *
  363. * @var int|null
  364. */
  365. public $attemptsLeft;
  367. /**
  368. * @ORM\OneToMany(targetEntity="App\Entity\Child", mappedBy="createdBy")
  369. * @ORM\JoinColumn(referencedColumnName="id")
  370. *
  371. * @var Collection<Child>
  372. *
  373. * @Assert\NotNull
  374. */
  375. public $children;
  377. /**
  378. * @ORM\OneToMany(targetEntity=UserGroup::class, mappedBy="user", orphanRemoval=true)
  379. */
  380. private $userGroups;
  382. public function __construct()
  383. {
  384. $this->children = new ArrayCollection();
  385. $this->userGroups = new ArrayCollection();
  386. }
  388. public function getId(): ?int
  389. {
  390. return $this->id;
  391. }
  394. public function addChild(Child $child): self
  395. {
  396. $this->children[] = $child;
  398. return $this;
  399. }
  401. public function removeChild(Child $child): self
  402. {
  403. $this->children->removeElement($child);
  405. return $this;
  406. }
  408. public function getChildren(): Collection
  409. {
  410. return $this->children;
  411. }
  413. public function setPasswordRequestedAt(?string $passwordRequestedAt): self
  414. {
  415. $this->passwordRequestedAt = $passwordRequestedAt;
  417. return $this;
  418. }
  420. public function setAttemptsLeft(?int $attemptsLeft): self
  421. {
  422. $this->attemptsLeft = $attemptsLeft;
  424. return $this;
  425. }
  427. public function getAttemptsLeft(): ?int
  428. {
  429. return $this->attemptsLeft;
  430. }
  432. /**
  433. * The public representation of the user (e.g. a username, an email address, etc.)
  434. *
  435. * @see UserInterface
  436. */
  437. public function getUserIdentifier(): string
  438. {
  439. return (string) $this->email;
  440. }
  442. /**
  443. * @deprecated since Symfony 5.3
  444. */
  445. public function getUsername(): string
  446. {
  447. return (string) $this->email;
  448. }
  450. /**
  451. * @see UserInterface
  452. */
  453. public function getRoles(): array
  454. {
  455. $roles = $this->roles;
  456. // guarantee every user at least has ROLE_USER
  457. $roles[] = 'ROLE_USER';
  459. return array_unique($roles);
  460. }
  462. public function setRoles(array $roles): self
  463. {
  464. $this->roles = $roles;
  466. return $this;
  467. }
  469. /**
  470. * @see PasswordAuthenticatedUserInterface
  471. */
  472. public function getPassword(): string
  473. {
  474. return $this->password;
  475. }
  477. public function setPassword(string $password): self
  478. {
  479. $this->password = $password;
  481. return $this;
  482. }
  484. public function getEmail(): string
  485. {
  486. return $this->email;
  487. }
  489. public function setEmail(string $email): self
  490. {
  491. $this->email = $email;
  493. return $this;
  494. }
  495. public function setHomePhoneNumber(?PhoneNumber $homePhoneNumber): self
  496. {
  497. $this->homePhoneNumber = $homePhoneNumber;
  499. return $this;
  500. }
  502. public function getHomePhoneNumber(): ?PhoneNumber
  503. {
  504. return $this->homePhoneNumber;
  505. }
  507. public function setWorkPhoneNumber(?PhoneNumber $workPhoneNumber): self
  508. {
  509. $this->workPhoneNumber = $workPhoneNumber;
  511. return $this;
  512. }
  514. public function getWorkPhoneNumber(): ?PhoneNumber
  515. {
  516. return $this->workPhoneNumber;
  517. }
  519. public function setMobilePhoneNumber(?PhoneNumber $mobilePhoneNumber): self
  520. {
  521. $this->mobilePhoneNumber = $mobilePhoneNumber;
  523. return $this;
  524. }
  526. public function getMobilePhoneNumber(): ?PhoneNumber
  527. {
  528. return $this->mobilePhoneNumber;
  529. }
  530. public function getEnabled(): bool
  531. {
  532. return $this->enabled;
  533. }
  535. public function setEnabled(bool $enabled): self
  536. {
  537. $this->enabled = $enabled;
  539. return $this;
  540. }
  542. public function getConfirmationToken(): ?string
  543. {
  544. return $this->confirmationToken;
  545. }
  547. public function setConfirmationToken(?string $confirmationToken): self
  548. {
  549. $this->confirmationToken = $confirmationToken;
  551. return $this;
  552. }
  553. /**
  554. * Returning a salt is only needed, if you are not using a modern
  555. * hashing algorithm (e.g. bcrypt or sodium) in your security.yaml.
  556. *
  557. * @see UserInterface
  558. */
  559. public function getSalt(): ?string
  560. {
  561. return null;
  562. }
  564. /**
  565. * @see UserInterface
  566. */
  567. public function eraseCredentials()
  568. {
  569. // If you store any temporary, sensitive data on the user, clear it here
  570. // $this->plainPassword = null;
  571. }
  573. /**
  574. * @return Collection|UserGroup[]
  575. */
  576. public function getUserGroups(): Collection
  577. {
  578. return $this->userGroups;
  579. }
  581. public function addUserGroup(UserGroup $userGroup): self
  582. {
  583. if (!$this->userGroups->contains($userGroup)) {
  584. $this->userGroups[] = $userGroup;
  585. $userGroup->setUser($this);
  586. }
  588. return $this;
  589. }
  591. public function removeUserGroup(UserGroup $userGroup): self
  592. {
  593. if ($this->userGroups->removeElement($userGroup)) {
  594. // set the owning side to null (unless already changed)
  595. if ($userGroup->getUser() === $this) {
  596. $userGroup->setUser(null);
  597. }
  598. }
  600. return $this;
  601. }
  603. /**
  604. * @ORM\Column(type="string", length=180, nullable=true)
  605. * @Groups({"output", "input"})
  606. *
  607. * @var string|null
  608. */
  609. public $incipientEmail;
  611. public function getIncipientEmail(): ?string
  612. {
  613. return $this->incipientEmail;
  614. }
  616. public function setIncipientEmail(?string $incipientEmail): self
  617. {
  618. $this->incipientEmail = $incipientEmail;
  619. return $this;
  620. }
  621. /**
  622. * @ORM\Column(type="boolean")
  623. *
  624. * @var bool
  625. */
  626. public $emailAuthEnabled = false;
  628. /**
  629. * @ORM\Column(type="string", length=6, nullable=true)
  630. *
  631. * @var string|null
  632. */
  633. public $emailAuthCode;
  635. /**
  636. * @ORM\Column(type="datetime", nullable=true)
  637. *
  638. * @var \DateTimeInterface|null
  639. */
  640. public $emailAuthCodeCreatedAt;
  643. public function isEmailAuthEnabled(): bool
  644. {
  645. return $this->emailAuthEnabled;
  646. }
  648. public function getEmailAuthRecipient(): string
  649. {
  650. return $this->email;
  651. }
  653. public function setEmailAuthCode(?string $authCode): void
  654. {
  655. $this->emailAuthCode = $authCode;
  656. $this->emailAuthCodeCreatedAt = $authCode ? new \DateTime() : null;
  657. }
  659. public function getEmailAuthCode(): string
  660. {
  661. if ($this->emailAuthCode === null) {
  662. return '';
  663. }
  665. if ($this->emailAuthCodeCreatedAt && $this->emailAuthCodeCreatedAt < new \DateTime(self::EMAIL_2FA_CODE_VALID_TIME)) {
  666. return '';
  667. }
  669. return $this->emailAuthCode;
  670. }
  673. public function setEmailAuthEnabled(bool $emailAuthEnabled): self
  674. {
  675. $this->emailAuthEnabled = $emailAuthEnabled;
  676. return $this;
  677. }
  679. public function getEmailAuthEnabled(): bool
  680. {
  681. return $this->emailAuthEnabled;
  682. }
  684. public function isEmailAuthCodeExpired(): bool
  685. {
  686. if ($this->emailAuthCodeCreatedAt === null) {
  687. return true;
  688. }
  689. return $this->emailAuthCodeCreatedAt < new \DateTime(self::EMAIL_2FA_CODE_VALID_TIME);
  690. }
  692. /**
  693. * @ORM\Column(type="string", length=6, nullable=true)
  694. * @var string|null
  695. */
  696. public $passwordResetCode;
  698. /**
  699. * @ORM\Column(type="datetime", nullable=true)
  700. * @var \DateTimeInterface|null
  701. */
  702. public $passwordResetCodeCreatedAt;
  704. /**
  705. * @ORM\Column(type="integer")
  706. * @var int
  707. */
  708. public $trustedTokenVersion = 0;
  710. public function getTrustedTokenVersion(): int
  711. {
  712. return $this->trustedTokenVersion;
  713. }
  715. }