src/Entity/Account/User.php line 50

Open in your IDE?
  1. <?php
  3. namespace App\Entity\Account;
  5. use App\Entity\Channel\Channel;
  6. use App\Entity\Channel\Group;
  7. use App\Entity\Channel\Service;
  8. use App\Entity\Channel\UserFromChannel;
  9. use App\Entity\ChannelUserData\ChannelUserData;
  10. use App\Entity\Common\Address;
  11. use App\Entity\Common\Contact;
  12. use App\Entity\Common\ImportableData\ImportableDataInterface;
  13. use App\Entity\Common\ImportableData\ImportableDataTrait;
  14. use App\Entity\Sync\SyncableWithExcludedPropertiesInterface;
  15. use App\Repository\Account\UserRepository;
  16. use Doctrine\Common\Collections\ArrayCollection;
  17. use Doctrine\Common\Collections\Collection;
  18. use Doctrine\ORM\Mapping as ORM;
  19. use Drosalys\Bundle\ApiBundle\Serializer\Attributes\IdGroups;
  20. use DrosalysWeb\ObjectExtensions\Blame\Model\BlameInterface;use DrosalysWeb\ObjectExtensions\Blame\Model\BlameTrait;
  21. use DrosalysWeb\ObjectExtensions\Timestamp\Model\TimestampInterface;
  22. use DrosalysWeb\ObjectExtensions\Timestamp\Model\TimestampTrait;
  23. use Nellapp\Bundle\SDKBundle\Auth\Entity\UserInterface;
  24. use Nellapp\Bundle\SDKBundle\Auth\Entity\UserMethodTrait;
  25. use Nellapp\Bundle\SDKBundle\Auth\Entity\UserWithContact\UserWithContactInterface;
  26. use Nellapp\Bundle\SDKBundle\Auth\Entity\UserWithContact\UserWithContactTrait;
  27. use Nellapp\Bundle\SDKBundle\Sync\EntityKeys;
  28. use OpenApi\Annotations as OA;
  29. use Symfony\Bridge\Doctrine\IdGenerator\UuidGenerator;
  30. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  31. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  32. use Symfony\Component\Serializer\Annotation as Serial;
  33. use Symfony\Component\Validator\Constraints as Assert;
  35. /**
  36. * @method self|null getCreatedBy()
  37. * @method self setCreatedBy(self $createdBy)
  38. * @method self|null getUpdatedBy()
  39. * @method self setUpdatedBy(self $updatedBy)
  40. */
  41. #[UniqueEntity(fields: 'email', message: 'user.entity.email.UniqueEntity', groups: ['register', 'user_edition', 'super_admin_user_edition', 'admin_user_edition', 'flow_channel_user_create_step1', 'admin_learner_profile', 'admin_admin_profile'])]
  42. #[UniqueEntity(fields: 'id', message: 'user.entity.id.UniqueEntity', groups: ['register', 'flow_channel_user_create_step1'])]
  43. #[
  44. ORM\Entity(repositoryClass: UserRepository::class),
  45. ORM\Table(name: 'account_users'),
  46. ORM\Index(fields: ['email'], flags: ['fulltext']),
  47. ORM\Index(fields: ['firstName'], flags: ['fulltext']),
  48. ORM\Index(fields: ['lastName'], flags: ['fulltext']),
  49. ]
  50. class User implements
  51. UserInterface,
  52. UserWithContactInterface,
  53. PasswordAuthenticatedUserInterface,
  54. TimestampInterface,
  55. BlameInterface,
  56. SyncableWithExcludedPropertiesInterface,
  57. ImportableDataInterface
  58. {
  59. use BlameTrait;
  60. use TimestampTrait;
  61. use UserMethodTrait;
  62. use UserWithContactTrait;
  63. use ImportableDataTrait;
  65. #[
  66. ORM\Id, ORM\GeneratedValue(strategy: 'CUSTOM'),
  67. ORM\CustomIdGenerator(class: UuidGenerator::class),
  68. ORM\Column(type: 'string', length: 36)
  69. ]
  70. #[Serial\Groups(['Profile', 'Manager', 'Sync', 'GlobalJSVariable', 'activity:get'])]
  71. private ?string $id = null;
  73. #[ORM\Column(type: 'string', length: 180, unique: true)]
  74. #[
  75. Assert\NotBlank(message: 'user.entity.email.NotBlank', groups: ['register', 'user_edition', 'admin_user_edition', 'super_admin_user_edition', 'group_user', 'flow_channel_user_create_step1', 'admin_learner_profile', 'admin_admin_profile']),
  76. Assert\Email(message: 'user.entity.email.Email', mode: 'strict', groups: ['register', 'user_edition', 'admin_user_edition', 'super_admin_user_edition', 'group_user', 'flow_channel_user_create_step1', 'admin_learner_profile', 'admin_admin_profile']),
  77. Assert\Length(
  78. min: 6,
  79. max: 64,
  80. minMessage: 'user.entity.email.Length.min',
  81. maxMessage: 'user.entity.email.Length.max',
  82. groups: ['register', 'user_edition', 'admin_user_edition', 'super_admin_user_edition', 'group_user', 'flow_channel_user_create_step1', 'admin_learner_profile', 'admin_admin_profile']),
  83. ]
  84. #[Serial\Groups(['Profile', 'Manager', 'UserPostManager', 'Sync', 'activity:get'])]
  85. private ?string $email = null;
  87. /**
  88. * @var string[]
  89. */
  90. #[ORM\Column(type: 'json')]
  91. #[Serial\Groups(['Profile', 'Sync'])]
  92. private array $roles = [];
  94. #[ORM\Column(type: 'string')]
  95. #[
  96. Assert\NotBlank(message: 'user.entity.password.NotBlank', groups: ['register', 'user_edition']),
  97. Assert\Length(
  98. min: 8,
  99. max: 255,
  100. minMessage: 'user.entity.password.Length.min',
  101. maxMessage: 'user.entity.password.Length.max',
  102. groups: ['register', 'user_edition']),
  103. Assert\Regex(
  104. pattern: '/(?=.*[0-9])/',
  105. message: 'user.entity.password.Regex.digit',
  106. groups: ['register', 'user_edition']),
  107. Assert\Regex(
  108. pattern: '/(?=.*[A-Z])/',
  109. message: 'user.entity.password.Regex.up',
  110. groups: ['register', 'user_edition']),
  111. Assert\Regex(
  112. pattern: '/(?=.*[a-z])/',
  113. message: 'user.entity.password.Regex.low',
  114. groups: ['register', 'user_edition']),
  115. ]
  116. private ?string $password = null;
  118. #[ORM\Column(type: 'boolean')]
  119. #[
  120. Assert\NotNull(message: 'user.entity.enabled.NotNull'),
  121. Assert\Type(type: 'boolean', message: 'user.entity.enabled.Type')
  122. ]
  123. private bool $enabled = true;
  125. #[ORM\Column(type: 'string', length: 63, nullable: true)]
  126. private ?string $passwordToken = null;
  128. #[ORM\Column(type: 'datetime', nullable: true)]
  129. private ?\DateTimeInterface $passwordTokenAt = null;
  131. #[ORM\Column(type: 'string', nullable: true)]
  132. #[
  133. Assert\NotBlank(message: 'user.entity.firstName.NotBlank', groups: ['register', 'user_edition', 'admin_user_edition', 'super_admin_user_edition', 'group_user', 'flow_channel_user_create_step2', 'admin_learner_profile', 'admin_admin_profile']),
  134. Assert\Length(
  135. min: 2,
  136. max: 255,
  137. minMessage: 'user.entity.firstName.Length.min',
  138. maxMessage: 'user.entity.firstName.Length.max',
  139. groups: ['register', 'user_edition', 'admin_user_edition', 'super_admin_user_edition', 'group_user', 'flow_channel_user_create_step2', 'admin_learner_profile', 'admin_admin_profile'])
  140. ]
  141. #[Serial\Groups(['Profile', 'Manager', 'UserPostManager', 'Sync', 'GlobalJSVariable', 'activity:get'])]
  142. private ?string $firstName = null;
  144. #[ORM\Column(type: 'string', nullable: true)]
  145. #[
  146. Assert\NotBlank(message: 'user.entity.lastName.NotBlank', groups: ['register', 'user_edition', 'admin_user_edition', 'super_admin_user_edition', 'group_user', 'flow_channel_user_create_step2', 'admin_learner_profile', 'admin_admin_profile']),
  147. Assert\Length(
  148. min: 2,
  149. max: 255,
  150. minMessage: 'user.entity.lastName.Length.min',
  151. maxMessage: 'user.entity.lastName.Length.max',
  152. groups: ['register', 'user_edition', 'admin_user_edition', 'super_admin_user_edition', 'group_user', 'flow_channel_user_create_step2', 'admin_learner_profile', 'admin_admin_profile'])
  153. ]
  154. #[Serial\Groups(['Profile', 'Manager', 'UserPostManager', 'Sync', 'GlobalJSVariable', 'activity:get'])]
  155. private ?string $lastName = null;
  157. #[ORM\Column(type: 'string', length: 20, nullable: true)]
  158. #[Assert\Length(
  159. min: 8,
  160. max: 20,
  161. minMessage: 'user.entity.phone.Length.min',
  162. maxMessage: 'user.entity.phone.Length.max',
  163. groups: ['user_edition', 'admin_user_edition', 'super_admin_user_edition', 'flow_channel_user_create_step2', 'admin_learner_profile', 'admin_admin_profile'])
  164. ]
  165. private ?string $phoneNumber = null;
  167. #[ORM\Column(type: 'text', nullable: true)]
  168. #[Serial\Groups(['Profile', 'Sync'])]
  169. private ?string $description = null;
  171. #[ORM\Column(type: 'string', nullable: true)]
  172. #[Assert\Length(max: 255, groups: ['user_edition'])]
  173. private ?string $roleDescription = null;
  175. #[ORM\Column(type: 'boolean', nullable: true)]
  176. private ?bool $avatar = null;
  178. #[ORM\Column(type: 'text', nullable: true)]
  179. #[Serial\Groups(['Sync', 'Manager', 'GlobalJSVariable', 'activity:get'])]
  180. private ?string $avatarPath = null;
  182. #[ORM\Column(type: 'string', length: 2, nullable: true)]
  183. #[Assert\Choice(choices: ['m', 'f', 'o'], message: 'user.entity.gender.Choice', groups: ['user_edition', 'admin_user_edition', 'super_admin_user_edition', 'admin_learner_profile', 'admin_admin_profile'])]
  184. private ?string $gender = null;
  186. #[ORM\Column(type: 'date', nullable: true)]
  187. private ?\DateTimeInterface $birthAt = null;
  189. #[ORM\Embedded(class: Address::class)]
  190. #[Assert\Valid(groups: ['user_edition', 'flow_channel_user_create_step2', 'admin_learner_profile', 'admin_admin_profile'])]
  191. private ?Address $address = null;
  193. #[ORM\Column(type: 'boolean')]
  194. private bool $isVerified = false;
  196. #[ORM\OneToOne(mappedBy: 'user', targetEntity: UserFromChannel::class, cascade: ['remove'], orphanRemoval: true)]
  197. private ?UserFromChannel $userFromChannel = null;
  199. #[ORM\OneToOne(inversedBy: 'user', targetEntity: Contact::class, cascade: ['persist'])]
  200. #[ORM\JoinColumn(nullable: true, onDelete: 'SET NULL')]
  201. #[IdGroups(['Sync'])]
  202. private ?Contact $contact = null;
  204. #[ORM\Column(type: 'datetime', nullable: true)]
  205. #[Serial\Groups(['Profile', 'Sync', 'UserPutSigningDate'])]
  206. private ?\DateTime $signingLimitDate = null;
  208. #[ORM\Column(type: 'datetime', nullable: true)]
  209. private ?\DateTime $lastConnectedAt = null;
  211. #[ORM\Column(type: 'boolean', nullable: false)]
  212. private bool $shownAlert = false; // Modal alert displayed for general informations
  214. #[ORM\OneToMany(mappedBy: 'user', targetEntity: ChannelUserData::class)]
  215. private ?Collection $channelUserDatas;
  217. #[ORM\ManyToMany(targetEntity: Group::class, mappedBy: 'users', fetch: 'EXTRA_LAZY')]
  218. private ?Collection $groups;
  220. #[ORM\ManyToMany(targetEntity: Service::class, mappedBy: 'users', fetch: 'EXTRA_LAZY')]
  221. private ?Collection $services;
  223. public function __construct()
  224. {
  225. $this->channelUserDatas = new ArrayCollection();
  226. $this->groups = new ArrayCollection();
  227. $this->services = new ArrayCollection();
  228. }
  230. /**
  231. * Overrides UserMethodTrait::__serialize(): the SDK trait serializes id/email/token,
  232. * but core's User has no $token property (renamed to $passwordToken in 160c40a2,
  233. * Nov 2023) — core is the OAuth server, it never needed the SDK's OAuth-client Token.
  234. */
  235. public function __serialize(): array
  236. {
  237. return [
  238. 'id' => $this->id,
  239. 'email' => $this->email,
  240. ];
  241. }
  243. public function __unserialize(array $data): void
  244. {
  245. $this->id = $data['id'];
  246. $this->email = $data['email'];
  247. }
  249. public static function getSyncKey(): string
  250. {
  251. return EntityKeys::USER;
  252. }
  254. public function getSyncDisplayLabel(): string
  255. {
  256. return $this->getEmail() ?? 'Email';
  257. }
  259. public static function getExcludedProperties(): array
  260. {
  261. return [
  262. 'lastConnectedAt',
  263. ];
  264. }
  266. #[
  267. Serial\SerializedName('username'),
  268. Serial\Groups(['Profile', 'Manager', 'Sync'])
  269. ]
  270. public function getUsername(): string
  271. {
  272. return $this;
  273. }
  275. /**
  276. * @OA\Property(type="array", @OA\Items(type="string"))
  277. */
  278. #[
  279. Serial\Groups(['Profile'])
  280. ]
  281. public function getChannelIds(): array
  282. {
  283. return $this->getChannelUserDatas()->map(fn(ChannelUserData $cud) => $cud->getChannel()->getId())->toArray();
  284. }
  286. public function getRoles(): array
  287. {
  288. return array_unique(array_merge($this->roles, [
  289. 'ROLE_USER',
  290. ]));
  291. }
  293. public function setRoles(array $roles): static
  294. {
  295. $this->roles = array_unique(array_values($roles));
  297. return $this;
  298. }
  300. public function getPassword(): ?string
  301. {
  302. return $this->password;
  303. }
  305. public function setPassword(string $password): static
  306. {
  307. $this->password = $password;
  309. return $this;
  310. }
  312. public function getEnabled(): ?bool
  313. {
  314. return $this->enabled;
  315. }
  317. public function setEnabled(bool $enabled): static
  318. {
  319. $this->enabled = $enabled;
  321. return $this;
  322. }
  324. public function toggleEnabled(): static
  325. {
  326. $this->enabled = !$this->enabled;
  327. return $this;
  328. }
  330. public function getPasswordToken(): ?string
  331. {
  332. return $this->passwordToken;
  333. }
  335. public function setPasswordToken(?string $passwordToken): static
  336. {
  337. $this->passwordToken = $passwordToken;
  339. return $this;
  340. }
  342. public function getPasswordTokenAt(): ?\DateTimeInterface
  343. {
  344. return $this->passwordTokenAt;
  345. }
  347. public function setPasswordTokenAt(?\DateTimeInterface $passwordTokenAt): static
  348. {
  349. $this->passwordTokenAt = $passwordTokenAt;
  351. return $this;
  352. }
  354. public function getPhoneNumber(): ?string
  355. {
  356. return $this->phoneNumber;
  357. }
  359. public function setPhoneNumber(?string $phoneNumber): static
  360. {
  361. $this->phoneNumber = $phoneNumber;
  363. return $this;
  364. }
  366. public function getRoleDescription(): ?string
  367. {
  368. return $this->roleDescription;
  369. }
  371. public function setRoleDescription(?string $roleDescription): static
  372. {
  373. $this->roleDescription = $roleDescription;
  375. return $this;
  376. }
  378. public function getGender(): ?string
  379. {
  380. return $this->gender;
  381. }
  383. public function setGender(?string $gender): static
  384. {
  385. $this->gender = $gender;
  387. return $this;
  388. }
  390. public function getBirthAt(): ?\DateTimeInterface
  391. {
  392. return $this->birthAt;
  393. }
  395. public function setBirthAt(?\DateTimeInterface $birthAt): static
  396. {
  397. $this->birthAt = $birthAt;
  399. return $this;
  400. }
  402. /**
  403. * @return \DateTime|null
  404. */
  405. public function getLastConnectedAt(): ?\DateTime
  406. {
  407. return $this->lastConnectedAt;
  408. }
  410. /**
  411. * @param \DateTime|null $lastConnectedAt
  412. */
  413. public function setLastConnectedAt(?\DateTime $lastConnectedAt): static
  414. {
  415. $this->lastConnectedAt = $lastConnectedAt;
  417. return $this;
  418. }
  421. public function getAddress(): Address
  422. {
  423. return $this->address ?: $this->address = new Address();
  424. }
  426. public function setAddress(Address $address): static
  427. {
  428. $this->address = $address;
  430. return $this;
  431. }
  433. public function isVerified(): bool
  434. {
  435. return $this->isVerified;
  436. }
  438. public function setIsVerified(bool $isVerified): static
  439. {
  440. $this->isVerified = $isVerified;
  442. return $this;
  443. }
  445. public function getGroups(): ?Collection
  446. {
  447. return $this->groups;
  448. }
  450. public function getGroupsByChannel(Channel $channel): ?array
  451. {
  452. return array_filter($this->groups->toArray(), function (Group $group) use ($channel) {
  453. return $group->getChannel() === $channel;
  454. });
  455. }
  457. public function setGroups(?Collection $groups): User
  458. {
  459. $this->groups = $groups;
  460. return $this;
  461. }
  463. public function getServices(): ?Collection
  464. {
  465. return $this->services;
  466. }
  468. public function getUserFromChannel(): ?UserFromChannel
  469. {
  470. return $this->userFromChannel;
  471. }
  473. public function setUserFromChannel(?UserFromChannel $userFromChannel): self
  474. {
  475. $this->userFromChannel = $userFromChannel;
  477. return $this;
  478. }
  480. public function isShownAlert(): bool
  481. {
  482. return $this->shownAlert;
  483. }
  485. public function setShownAlert(bool $shownAlert): User
  486. {
  487. $this->shownAlert = $shownAlert;
  488. return $this;
  489. }
  491. public function serialize(): ?string
  492. {
  493. return serialize([
  494. $this->id,
  495. $this->email,
  496. $this->password,
  497. $this->enabled,
  498. ]);
  499. }
  501. public function unserialize($data): void
  502. {
  503. list(
  504. $this->id,
  505. $this->email,
  506. $this->password,
  507. $this->enabled
  508. ) = unserialize($data);
  509. }
  510. }