vendor/sulu/sulu/src/Sulu/Bundle/SecurityBundle/Entity/User.php line 32

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of Sulu.
  5. *
  6. * (c) Sulu GmbH
  7. *
  8. * This source file is subject to the MIT license that is bundled
  9. * with this source code in the file LICENSE.
  10. */
  12. namespace Sulu\Bundle\SecurityBundle\Entity;
  14. use Doctrine\Common\Collections\ArrayCollection;
  15. use Doctrine\Common\Collections\Collection;
  16. use JMS\Serializer\Annotation\ExclusionPolicy;
  17. use JMS\Serializer\Annotation\Expose;
  18. use JMS\Serializer\Annotation\Groups;
  19. use JMS\Serializer\Annotation\SerializedName;
  20. use JMS\Serializer\Annotation\VirtualProperty;
  21. use Sulu\Bundle\ContactBundle\Entity\ContactInterface;
  22. use Sulu\Bundle\CoreBundle\Entity\ApiEntity;
  23. use Sulu\Bundle\SecurityBundle\Entity\TwoFactor\TwoFactorTrait;
  24. use Sulu\Component\Persistence\Model\AuditableInterface;
  25. use Sulu\Component\Persistence\Model\AuditableTrait;
  26. use Sulu\Component\Security\Authentication\UserInterface;
  27. use Symfony\Component\Security\Core\User\EquatableInterface;
  28. use Symfony\Component\Security\Core\User\LegacyPasswordAuthenticatedUserInterface;
  29. use Symfony\Component\Security\Core\User\UserInterface as SymfonyUserInterface;
  31. #[ExclusionPolicy('all')]
  32. class User extends ApiEntity implements UserInterface, EquatableInterface, AuditableInterface, PasswordAuthenticatedUserInterface, LegacyPasswordAuthenticatedUserInterface
  33. {
  34. use AuditableTrait;
  35. use TwoFactorTrait;
  37. /**
  38. * @var int
  39. */
  40. #[Expose]
  41. #[Groups(['frontend', 'fullUser'])]
  42. protected $id;
  44. /**
  45. * @var string
  46. */
  47. #[Expose]
  48. #[Groups(['frontend', 'fullUser', 'profile'])]
  49. protected $username;
  51. /**
  52. * @var string|null
  53. */
  54. #[Expose]
  55. #[Groups(['fullUser', 'profile'])]
  56. protected $email;
  58. /**
  59. * @var string
  60. */
  61. protected $password;
  63. /**
  64. * @var string
  65. */
  66. #[Expose]
  67. #[Groups(['frontend', 'fullUser', 'profile'])]
  68. protected $locale;
  70. /**
  71. * @var string
  72. */
  73. protected $salt;
  75. /**
  76. * @var string|null
  77. */
  78. #[Expose]
  79. protected $privateKey;
  81. /**
  82. * @var string|null
  83. */
  84. protected $apiKey;
  86. /**
  87. * @var bool
  88. */
  89. #[Expose]
  90. protected $locked = false;
  92. /**
  93. * @var bool
  94. */
  95. #[Expose]
  96. protected $enabled = true;
  98. /**
  99. * @var \DateTime|null
  100. */
  101. protected $lastLogin;
  103. /**
  104. * @var string|null
  105. */
  106. protected $confirmationKey;
  108. /**
  109. * @var string|null
  110. */
  111. protected $passwordResetToken;
  113. /**
  114. * @var \DateTime|null
  115. */
  116. private $passwordResetTokenExpiresAt;
  118. /**
  119. * @var int|null
  120. */
  121. private $passwordResetTokenEmailsSent;
  123. /**
  124. * @var ContactInterface
  125. */
  126. #[Expose]
  127. #[Groups(['frontend', 'fullUser'])]
  128. protected $contact;
  130. /**
  131. * @var Collection|UserRole[]
  132. */
  133. #[Expose]
  134. protected $userRoles;
  136. /**
  137. * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  138. *
  139. * @var Collection|UserGroup[]
  140. */
  141. #[Expose]
  142. protected $userGroups;
  144. /**
  145. * @var Collection|UserSetting[]
  146. */
  147. protected $userSettings;
  149. /**
  150. * Constructor.
  151. */
  152. public function __construct()
  153. {
  154. $this->apiKey = \md5(\uniqid());
  156. $this->userRoles = new ArrayCollection();
  157. $this->userGroups = new ArrayCollection();
  158. $this->userSettings = new ArrayCollection();
  159. }
  161. /**
  162. * Get id.
  163. *
  164. * @return int
  165. */
  166. public function getId()
  167. {
  168. return $this->id;
  169. }
  171. /**
  172. * Set username.
  173. *
  174. * @param string $username
  175. *
  176. * @return self
  177. */
  178. public function setUsername($username)
  179. {
  180. $this->username = $username;
  182. return $this;
  183. }
  185. /**
  186. * Get username.
  187. *
  188. * @return string
  189. */
  190. #[SerializedName('username')]
  191. #[Groups(['frontend', 'fullUser'])]
  192. public function getUsername()
  193. {
  194. return $this->username;
  195. }
  197. public function getUserIdentifier(): string
  198. {
  199. return $this->username;
  200. }
  202. /**
  203. * Set password.
  204. *
  205. * @param string $password
  206. *
  207. * @return self
  208. */
  209. public function setPassword($password)
  210. {
  211. $this->password = $password;
  213. return $this;
  214. }
  216. /**
  217. * Get password.
  218. */
  219. public function getPassword(): ?string
  220. {
  221. return $this->password;
  222. }
  224. /**
  225. * Set locale.
  226. *
  227. * @param string $locale
  228. *
  229. * @return self
  230. */
  231. public function setLocale($locale)
  232. {
  233. $this->locale = $locale;
  235. return $this;
  236. }
  238. /**
  239. * Get locale.
  240. *
  241. * @return string
  242. */
  243. public function getLocale()
  244. {
  245. return $this->locale;
  246. }
  248. /**
  249. * Set salt.
  250. *
  251. * @param string $salt
  252. *
  253. * @return self
  254. */
  255. public function setSalt($salt)
  256. {
  257. $this->salt = $salt;
  259. return $this;
  260. }
  262. /**
  263. * Get salt.
  264. *
  265. * @deprecated The salt functionality was deprecated in Sulu 2.5 and will be removed in Sulu 3.0
  266. * Modern password algorithm do not longer require a salt.
  267. */
  268. public function getSalt(): ?string
  269. {
  270. return $this->salt;
  271. }
  273. /**
  274. * Set privateKey.
  275. *
  276. * @param string|null $privateKey
  277. *
  278. * @return self
  279. */
  280. public function setPrivateKey($privateKey)
  281. {
  282. $this->privateKey = $privateKey;
  284. return $this;
  285. }
  287. /**
  288. * Get privateKey.
  289. *
  290. * @return string|null
  291. */
  292. public function getPrivateKey()
  293. {
  294. return $this->privateKey;
  295. }
  297. /**
  298. * Removes the password of the user.
  299. */
  300. public function eraseCredentials(): void
  301. {
  302. }
  304. /**
  305. * Set apiKey.
  306. *
  307. * @param string|null $apiKey
  308. *
  309. * @return self
  310. */
  311. public function setApiKey($apiKey)
  312. {
  313. $this->apiKey = $apiKey;
  315. return $this;
  316. }
  318. /**
  319. * Get apiKey.
  320. *
  321. * @return string|null
  322. */
  323. public function getApiKey()
  324. {
  325. return $this->apiKey;
  326. }
  328. /**
  329. * Set locked.
  330. *
  331. * @param bool $locked
  332. *
  333. * @return self
  334. */
  335. public function setLocked($locked)
  336. {
  337. $this->locked = $locked;
  339. return $this;
  340. }
  342. public function getLocked()
  343. {
  344. return $this->locked;
  345. }
  347. /**
  348. * Set enabled.
  349. *
  350. * @param bool $enabled
  351. *
  352. * @return self
  353. */
  354. public function setEnabled($enabled)
  355. {
  356. $this->enabled = $enabled;
  358. return $this;
  359. }
  361. public function getEnabled()
  362. {
  363. return $this->enabled;
  364. }
  366. /**
  367. * Set lastLogin.
  368. *
  369. * @param \DateTime|null $lastLogin
  370. *
  371. * @return self
  372. */
  373. public function setLastLogin($lastLogin)
  374. {
  375. $this->lastLogin = $lastLogin;
  377. return $this;
  378. }
  380. /**
  381. * Get lastLogin.
  382. *
  383. * @return \DateTime|null
  384. */
  385. public function getLastLogin()
  386. {
  387. return $this->lastLogin;
  388. }
  390. /**
  391. * Set confirmationKey.
  392. *
  393. * @param string|null $confirmationKey
  394. *
  395. * @return self
  396. */
  397. public function setConfirmationKey($confirmationKey)
  398. {
  399. $this->confirmationKey = $confirmationKey;
  401. return $this;
  402. }
  404. /**
  405. * Get confirmationKey.
  406. *
  407. * @return string|null
  408. */
  409. public function getConfirmationKey()
  410. {
  411. return $this->confirmationKey;
  412. }
  414. /**
  415. * Set passwordResetToken.
  416. *
  417. * @param string|null $passwordResetToken
  418. *
  419. * @return self
  420. */
  421. public function setPasswordResetToken($passwordResetToken)
  422. {
  423. $this->passwordResetToken = $passwordResetToken;
  425. return $this;
  426. }
  428. /**
  429. * Get passwordResetToken.
  430. *
  431. * @return string|null
  432. */
  433. public function getPasswordResetToken()
  434. {
  435. return $this->passwordResetToken;
  436. }
  438. /**
  439. * Set email.
  440. *
  441. * @param string|null $email
  442. *
  443. * @return self
  444. */
  445. public function setEmail($email)
  446. {
  447. $this->email = $email;
  449. return $this;
  450. }
  452. /**
  453. * Get email.
  454. *
  455. * @return string|null
  456. */
  457. public function getEmail()
  458. {
  459. return $this->email;
  460. }
  462. /**
  463. * Set tokenExpiresAt.
  464. *
  465. * @param \DateTime|null $passwordResetTokenExpiresAt
  466. *
  467. * @return self
  468. */
  469. public function setPasswordResetTokenExpiresAt($passwordResetTokenExpiresAt)
  470. {
  471. $this->passwordResetTokenExpiresAt = $passwordResetTokenExpiresAt;
  473. return $this;
  474. }
  476. /**
  477. * Get passwordResetTokenExpiresAt.
  478. *
  479. * @return \DateTime|null
  480. */
  481. public function getPasswordResetTokenExpiresAt()
  482. {
  483. return $this->passwordResetTokenExpiresAt;
  484. }
  486. /**
  487. * Set passwordResetTokenEmailsSent.
  488. *
  489. * @param int|null $passwordResetTokenEmailsSent
  490. *
  491. * @return self
  492. */
  493. public function setPasswordResetTokenEmailsSent($passwordResetTokenEmailsSent)
  494. {
  495. $this->passwordResetTokenEmailsSent = $passwordResetTokenEmailsSent;
  497. return $this;
  498. }
  500. /**
  501. * Get passwordResetTokenEmailsSent.
  502. *
  503. * @return int|null
  504. */
  505. public function getPasswordResetTokenEmailsSent()
  506. {
  507. return $this->passwordResetTokenEmailsSent;
  508. }
  510. public function isEqualTo(SymfonyUserInterface $user): bool
  511. {
  512. if (!$user instanceof self) {
  513. return false;
  514. }
  516. return $this->id === $user->getId()
  517. && $this->password === $user->getPassword()
  518. && $this->salt === $user->getSalt()
  519. && $this->username === $user->getUsername()
  520. && $this->locked === $user->getLocked()
  521. && $this->enabled === $user->getEnabled();
  522. }
  524. /**
  525. * Add userRoles.
  526. *
  527. * @return self
  528. */
  529. public function addUserRole(UserRole $userRoles)
  530. {
  531. $this->userRoles[] = $userRoles;
  533. return $this;
  534. }
  536. /**
  537. * Remove userRoles.
  538. */
  539. public function removeUserRole(UserRole $userRoles)
  540. {
  541. $this->userRoles->removeElement($userRoles);
  542. }
  544. /**
  545. * Get userRoles.
  546. *
  547. * @return ArrayCollection
  548. */
  549. public function getUserRoles()
  550. {
  551. return $this->userRoles;
  552. }
  554. #[VirtualProperty]
  555. #[Groups(['frontend'])]
  556. public function getRoles(): array
  557. {
  558. $roles = ['ROLE_USER'];
  560. foreach ($this->getUserRoles() as $userRole) {
  561. /* @var UserRole $userRole */
  562. $roles[] = $userRole->getRole()->getIdentifier();
  563. }
  565. return $roles;
  566. }
  568. public function getRoleObjects()
  569. {
  570. $roles = [];
  571. foreach ($this->getUserRoles() as $userRole) {
  572. $roles[] = $userRole->getRole();
  573. }
  575. return $roles;
  576. }
  578. /**
  579. * Add userGroups.
  580. *
  581. * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  582. *
  583. * @return self
  584. */
  585. public function addUserGroup(UserGroup $userGroups)
  586. {
  587. $this->userGroups[] = $userGroups;
  589. return $this;
  590. }
  592. /**
  593. * Remove userGroups.
  594. *
  595. * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  596. */
  597. public function removeUserGroup(UserGroup $userGroups)
  598. {
  599. $this->userGroups->removeElement($userGroups);
  600. }
  602. /**
  603. * Get userGroups.
  604. *
  605. * @deprecated The group functionality was deprecated in Sulu 2.1 and will be removed in Sulu 3.0
  606. *
  607. * @return ArrayCollection
  608. */
  609. public function getUserGroups()
  610. {
  611. return $this->userGroups;
  612. }
  614. /**
  615. * Add userSettings.
  616. *
  617. * @return self
  618. */
  619. public function addUserSetting(UserSetting $userSettings)
  620. {
  621. $this->userSettings[] = $userSettings;
  623. return $this;
  624. }
  626. /**
  627. * Remove userSettings.
  628. */
  629. public function removeUserSetting(UserSetting $userSettings)
  630. {
  631. $this->userSettings->removeElement($userSettings);
  632. }
  634. /**
  635. * Get userSettings.
  636. *
  637. * @return Collection|UserSetting[]
  638. */
  639. public function getUserSettings()
  640. {
  641. return $this->userSettings;
  642. }
  644. #[VirtualProperty]
  645. #[Groups(['frontend'])]
  646. public function getSettings()
  647. {
  648. $userSettingValues = [];
  649. foreach ($this->userSettings as $userSetting) {
  650. $userSettingValues[$userSetting->getKey()] = \json_decode($userSetting->getValue(), true);
  651. }
  653. return $userSettingValues;
  654. }
  656. /**
  657. * Set contact.
  658. *
  659. * @return self
  660. */
  661. public function setContact(?ContactInterface $contact = null)
  662. {
  663. $this->contact = $contact;
  665. return $this;
  666. }
  668. /**
  669. * Get contact.
  670. *
  671. * @return ContactInterface
  672. */
  673. public function getContact()
  674. {
  675. return $this->contact;
  676. }
  678. /**
  679. * @return string
  680. */
  681. #[VirtualProperty]
  682. #[SerializedName('fullName')]
  683. #[Groups(['frontend', 'fullUser'])]
  684. public function getFullName()
  685. {
  686. return null !== $this->getContact() ?
  687. $this->getContact()->getFullName() : $this->getUsername();
  688. }
  690. /**
  691. * @return string
  692. */
  693. #[VirtualProperty]
  694. #[Groups(['profile'])]
  695. public function getFirstName()
  696. {
  697. return $this->contact->getFirstName();
  698. }
  700. /**
  701. * Set firstName.
  702. *
  703. * @return $this
  704. */
  705. public function setFirstName($firstName)
  706. {
  707. $this->contact->setFirstName($firstName);
  709. return $this;
  710. }
  712. /**
  713. * @return string
  714. */
  715. #[VirtualProperty]
  716. #[Groups(['profile'])]
  717. public function getLastName()
  718. {
  719. return $this->contact->getLastName();
  720. }
  722. /**
  723. * Set lastName.
  724. *
  725. * @return $this
  726. */
  727. public function setLastName($lastName)
  728. {
  729. $this->contact->setLastName($lastName);
  731. return $this;
  732. }
  733. }