src/Entity/User/User.php line 24

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace App\Entity\User;
  7. use App\Entity\Core\Institution;
  8. use App\Entity\Core\SelfStudy\SelfStudy;
  9. use App\Repository\User\UserRepository;
  10. use App\Services\User\Canonicalizer;
  11. use DateTime;
  12. use Doctrine\ORM\Mapping as ORM;
  13. use JsonSerializable;
  14. use Scheb\TwoFactorBundle\Model\Totp\TotpConfiguration;
  15. use Scheb\TwoFactorBundle\Model\Totp\TotpConfigurationInterface;
  16. use Scheb\TwoFactorBundle\Model\Totp\TwoFactorInterface;
  17. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  18. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  19. use Symfony\Component\Security\Core\User\UserInterface;
  21. #[ORM\Table(name: 'user')]
  22. #[ORM\Entity(repositoryClass: UserRepository::class)]
  23. #[UniqueEntity(fields: ['username'], message: 'user.username.taken')]
  24. class User implements JsonSerializable, TwoFactorInterface, UserInterface, PasswordAuthenticatedUserInterface
  25. {
  26. public const string role_admin = 'ROLE_ADMIN';
  27. public const string role_student = 'ROLE_STUDENT';
  28. public const string role_teacher = 'ROLE_TEACHER';
  30. #[ORM\Column(name: 'password', type: 'string', length: 255, nullable: true)]
  31. protected ?string $password = null;
  33. #[ORM\Column(name: 'email', type: 'string', length: 255, unique: false, nullable: true)]
  34. protected ?string $email = null;
  36. #[ORM\Column(name: 'salt', type: 'string', length: 255, nullable: true)]
  37. protected ?string $salt = null;
  39. #[ORM\Column(name: 'email_canonical', type: 'string', length: 255, unique: false, nullable: true)]
  40. protected string $emailCanonical;
  42. #[ORM\Id]
  43. #[ORM\Column(type: 'integer')]
  44. #[ORM\GeneratedValue(strategy: 'AUTO')]
  45. protected int $id;
  47. #[ORM\Column(name: 'first_name', type: 'string', length: 255)]
  48. protected string $firstName;
  50. #[ORM\Column(name: 'surname', type: 'string', length: 255)]
  51. protected string $surname;
  53. #[ORM\JoinColumn(name: 'institution', referencedColumnName: 'id', onDelete: 'CASCADE', nullable: true)]
  54. #[ORM\ManyToOne(targetEntity: Institution::class, cascade: ['persist'])]
  55. protected ?Institution $institution = null;
  57. #[ORM\Column(name: 'nickname', type: 'string', length: 255, nullable: true)]
  58. protected string $nickname;
  60. #[ORM\Column(name: 'first_login', type: 'boolean', options: ['default' => true])]
  61. protected bool $firstLogin = true;
  63. #[ORM\Column(name: 'is_subscribed', type: 'boolean', options: ['default' => false])]
  64. protected bool $isSubscribed = false;
  66. #[ORM\Column(name: 'is_demo', type: 'boolean', options: ['default' => false])]
  67. protected bool $isDemo = false;
  69. #[ORM\Column(name: 'desired_grade', type: 'smallint', nullable: true)]
  70. private int $desiredGrade;
  72. #[ORM\Column(name: 'class_level', type: 'smallint', nullable: true)]
  73. private ?int $classLevel = null;
  75. #[ORM\Column(name: 'self_study_level_adjustment', type: 'smallint', options: ['default' => 0])]
  76. private int $selfStudyLevelAdjustment = 0;
  78. #[ORM\Column(type: 'string', nullable: true)]
  79. private ?string $userAgent = null;
  81. #[ORM\Column(name: 'show_audio', type: 'boolean', options: ['default' => false], nullable: true)]
  82. private ?bool $showAudio = null;
  84. #[ORM\Column(name: 'classroom_overview', type: 'boolean', options: ['default' => true], nullable: true)]
  85. private ?bool $classroomOverview = null;
  87. #[ORM\Column(name: 'expiration_basis', type: 'datetime', nullable: true)]
  88. private ?DateTime $expirationBasis;
  90. #[ORM\Column(name: 'expiration_self_study', type: 'datetime', nullable: true)]
  91. private ?DateTime $expirationSelfStudy;
  93. #[ORM\Column(name: 'expiration_textbook', type: 'datetime', nullable: true)]
  94. private ?DateTime $expirationTextbook;
  97. #[ORM\Column(name: 'last_login_with_unilogin', type: 'datetime', nullable: true)]
  98. private ?DateTime $lastLoginWithUnilogin; // note that the last_login in the database is handled by FOSUserBundle and will be removed
  99. #[ORM\JoinColumn(name: 'selected_self_study', referencedColumnName: 'id', nullable: true)]
  100. #[ORM\ManyToOne(targetEntity: SelfStudy::class)]
  101. private ?SelfStudy $selectedSelfStudy = null;
  103. #[ORM\Column(name: 'ekeys_user_id', type: 'string', nullable: true)]
  104. private ?string $ekeysUserId;
  106. #[ORM\Column(name: 'totp_secret', type: 'string', nullable: true)]
  107. private ?string $totpSecret;
  109. #[ORM\Column(name: 'totp_validated', type: 'boolean', options: ['default' => false])]
  110. private bool $totpValidated = false;
  112. #[ORM\Column(name: 'class_name', type: 'string', nullable: true)]
  113. private ?string $className;
  115. #[ORM\Column(name: 'username', type: 'string', length: 180, nullable: false)]
  116. protected string $username;
  118. #[ORM\Column(name: 'username_canonical', type: 'string', length: 180, nullable: false, unique: true)]
  119. protected string $usernameCanonical;
  121. #[ORM\Column(name: 'enabled', type: 'boolean', nullable: false)]
  122. protected bool $enabled = false;
  124. #[ORM\Column(name: 'roles', type: 'array', nullable: false)]
  125. protected array $roles = [];
  128. #[ORM\Column(name: 'last_login', type: 'datetime', nullable: true)]
  129. private ?DateTime $lastLogin;
  131. public function setUsername(string $username): User
  132. {
  133. $this->username = $username;
  134. $this->usernameCanonical = Canonicalizer::canonicalize($username);
  136. return $this;
  137. }
  139. public function getClassName(): ?string
  140. {
  141. return $this->className;
  142. }
  144. public function setClassName(?string $className): void
  145. {
  146. $this->className = $className;
  147. }
  149. public function setInstitution(?Institution $institution): User
  150. {
  151. $this->institution = $institution;
  153. return $this;
  154. }
  156. public function getInstitution(): ?Institution
  157. {
  158. return $this->institution;
  159. }
  161. public function getEkeysUserId(): ?string
  162. {
  163. return $this->ekeysUserId;
  164. }
  166. public function setEkeysUserId(?string $ekeysUserId): void
  167. {
  168. $this->ekeysUserId = $ekeysUserId;
  169. }
  171. public function getClassLevelName(?bool $isSelfStudy = false): string {
  172. $levelName = '';
  173. $classLevel = $isSelfStudy ? $this->getSelfStudyLevel() : $this->getClassLevel();
  175. if ($classLevel <= 3) {
  176. $levelName = 'indskoling';
  177. }
  178. elseif ($classLevel >= 4 && $classLevel <= 6) {
  179. $levelName = 'mellemtrin';
  180. }
  181. elseif ($classLevel >= 7) {
  182. $levelName = 'udskoling';
  183. }
  185. return $levelName;
  186. }
  188. public function getNickname(): string
  189. {
  190. if (!empty($this->nickname)) {
  191. return $this->nickname;
  192. }
  194. if (!empty($this->getFirstName()) && !empty($this->getSurname())) {
  195. return $this->getFirstName() . ' ' . $this->getSurname();
  196. }
  198. $nickname = $this->getFirstName();
  199. if ($surname = $this->getSurname()) {
  200. preg_match_all('/(?<=\s|^)[a-z]/i', $surname, $matches);
  201. $nickname .= implode('', $matches[0]);
  202. }
  204. return $nickname;
  205. }
  207. public function setNickname($nickname = null): User
  208. {
  209. if (!empty($nickname)) {
  210. $this->nickname = $nickname;
  212. return $this;
  213. }
  215. if (!empty($this->getFirstName()) && !empty($this->getSurname())) {
  216. $this->nickname = $this->getFirstName() . ' ' . $this->getSurname();
  218. return $this;
  219. }
  221. $nickname = $this->getFirstName();
  222. if ($surname = $this->getSurname()) {
  223. preg_match_all('/(?<=\s|^)[a-z]/i', $surname, $matches);
  224. $nickname .= implode('', $matches[0]);
  225. }
  227. $this->nickname = $nickname;
  229. return $this;
  230. }
  232. public function getFirstLogin(): bool
  233. {
  234. return $this->firstLogin;
  235. }
  237. public function setFirstLogin(bool $firstLogin): User
  238. {
  239. $this->firstLogin = $firstLogin;
  241. return $this;
  242. }
  244. public function getId(): int
  245. {
  246. return $this->id;
  247. }
  249. public function setId(int $id): void
  250. {
  251. $this->id = $id;
  252. }
  254. public function getSurname(): string
  255. {
  256. return $this->surname;
  257. }
  259. public function setSurname(string $surname): User
  260. {
  261. $this->surname = $surname;
  263. return $this;
  264. }
  266. public function getIsSubscribed(): bool
  267. {
  268. return $this->isSubscribed;
  269. }
  271. public function setIsSubscribed(bool $isSubscribed): void
  272. {
  273. $this->isSubscribed = $isSubscribed;
  274. }
  276. public function getFirstName(): string
  277. {
  278. return $this->firstName;
  279. }
  281. public function setFirstName(string $firstName): User
  282. {
  283. $this->firstName = $firstName;
  285. return $this;
  286. }
  288. public function isDemo(): bool
  289. {
  290. return $this->isDemo;
  291. }
  293. public function setIsDemo(bool $isDemo): void
  294. {
  295. $this->isDemo = $isDemo;
  296. }
  298. public function isDebugUser(): bool
  299. {
  300. return $this->getUsername() === "teacher1_demo";
  301. }
  304. public function getDesiredGrade(): ?int
  305. {
  306. return $this->desiredGrade;
  307. }
  309. public function setDesiredGrade(?int $desiredGrade): void
  310. {
  311. $this->desiredGrade = $desiredGrade;
  312. }
  314. public function getSelfStudyLevelAdjustment(): int
  315. {
  316. return $this->selfStudyLevelAdjustment;
  317. }
  319. public function setSelfStudyLevelAdjustment(int $levelAdjustment)
  320. {
  321. $this->selfStudyLevelAdjustment = $levelAdjustment;
  322. }
  324. public function getSelfStudyLevel(): ?int
  325. {
  326. return $this->getClassLevel() === null ? null : $this->getClassLevel() + $this->getSelfStudyLevelAdjustment();
  327. }
  329. public function getUserAgent(): ?string
  330. {
  331. return $this->userAgent;
  332. }
  334. public function setUserAgent(string $userAgent)
  335. {
  336. $this->userAgent = $userAgent;
  337. }
  339. public function getFullName(): string
  340. {
  341. return ucwords($this->firstName) . ' ' . ucwords($this->surname);
  342. }
  344. public function getCompactName(): string
  345. {
  346. return ucwords($this->firstName) . ' ' . strtoupper(substr($this->surname, 0, 2));
  347. }
  349. public function getClassLevel(): ?int
  350. {
  351. return $this->classLevel;
  352. }
  354. public function setClassLevel(?int $classLevel): void
  355. {
  356. $this->classLevel = $classLevel;
  357. }
  359. public function isShowAudio(): ?bool
  360. {
  361. return $this->showAudio;
  362. }
  364. public function setShowAudio(bool $showAudio): void
  365. {
  366. $this->showAudio = $showAudio;
  367. }
  369. public function getClassroomOverview(): ?bool
  370. {
  371. return $this->classroomOverview;
  372. }
  374. public function setClassroomOverview(bool $classroomOverview): void
  375. {
  376. $this->classroomOverview = $classroomOverview;
  377. }
  380. public function getExpirationBasis(): ?DateTime
  381. {
  382. return $this->expirationBasis;
  383. }
  385. public function setExpirationBasis(?DateTime $expirationBasis): void
  386. {
  387. $this->expirationBasis = $expirationBasis;
  388. }
  390. public function getExpirationSelfStudy(): ?DateTime
  391. {
  392. return $this->expirationSelfStudy;
  393. }
  395. public function setExpirationSelfStudy(?DateTime $expirationSelfStudy): void
  396. {
  397. $this->expirationSelfStudy = $expirationSelfStudy;
  398. }
  400. public function getExpirationTextbook(): ?DateTime
  401. {
  402. return $this->expirationTextbook;
  403. }
  405. public function setExpirationTextbook(?DateTime $expirationTextbook): void
  406. {
  407. $this->expirationTextbook = $expirationTextbook;
  408. }
  410. public function jsonSerialize(): mixed
  411. {
  412. return [
  413. "id" => $this->getId(),
  414. "name" => $this->getFullName(),
  415. "classLevel" => $this->getClassLevel()
  416. ];
  417. }
  419. public function getLastLoginWithUnilogin(): ?DateTime
  420. {
  421. return $this->lastLoginWithUnilogin;
  422. }
  424. public function getLastLogin(): ?DateTime
  425. {
  426. return $this->lastLogin;
  427. }
  429. public function setLastLogin(?DateTime $time = null)
  430. {
  431. $this->lastLogin = $time;
  433. return $this;
  434. }
  436. public function setEnabled($boolean): User
  437. {
  438. $this->enabled = (bool) $boolean;
  440. return $this;
  441. }
  443. public function setLastLoginWithUnilogin(DateTime $lastLoginWithUnilogin): void
  444. {
  445. $this->lastLoginWithUnilogin = $lastLoginWithUnilogin;
  446. }
  448. public function getSelectedSelfStudy(): ?SelfStudy
  449. {
  450. return $this->selectedSelfStudy;
  451. }
  453. public function setSelectedSelfStudy(SelfStudy $selectedSelfStudy): void
  454. {
  455. $this->selectedSelfStudy = $selectedSelfStudy;
  456. }
  458. public function setTotpSecret(string $secret): void
  459. {
  460. $this->totpSecret = $secret;
  461. }
  463. public function isTotpAuthenticationEnabled(): bool
  464. {
  465. return $this->totpValidated;
  466. }
  468. public function getTotpAuthenticationUsername(): string
  469. {
  470. return $this->username;
  471. }
  473. public function getTotpAuthenticationConfiguration(): ?TotpConfigurationInterface
  474. {
  475. // SHA1, 30 seconds and 6 digits is will make it work with Google authenticator and equivalent.
  476. return new TotpConfiguration($this->totpSecret, TotpConfiguration::ALGORITHM_SHA1, 30, 6);
  477. }
  479. public function isTotpValidated(): bool
  480. {
  481. return $this->totpValidated;
  482. }
  484. public function setTotpValidated(bool $totpValidated): void
  485. {
  486. $this->totpValidated = $totpValidated;
  487. }
  489. public function getRoles(): array
  490. {
  491. return $this->roles;
  492. }
  494. public function getPassword(): ?string
  495. {
  496. return $this->password;
  497. }
  499. public function getSalt(): ?string
  500. {
  501. return $this->salt;
  502. }
  504. public function eraseCredentials(): void
  505. {
  506. }
  508. public function getUsername(): string
  509. {
  510. return $this->username;
  511. }
  513. public function isEnabled(): bool
  514. {
  515. return $this->enabled;
  516. }
  518. /**
  519. * Avoid deprecation warning
  520. */
  521. public function getUserIdentifier(): string
  522. {
  523. return $this->username;
  524. }
  526. public function setRoles(array $roles): User
  527. {
  528. $this->roles = [];
  530. foreach ($roles as $role) {
  531. $this->addRole($role);
  532. }
  534. return $this;
  535. }
  537. public function addRole(string $role): void
  538. {
  539. $role = strtoupper($role);
  541. if (!in_array($role, $this->roles, true)) {
  542. $this->roles[] = $role;
  543. }
  544. }
  546. public function removeRole(string $role): void
  547. {
  548. if (false !== $key = array_search(strtoupper($role), $this->roles, true)) {
  549. unset($this->roles[$key]);
  550. $this->roles = array_values($this->roles);
  551. }
  552. }
  554. public function hasRole(string $role): bool
  555. {
  556. return in_array(strtoupper($role), $this->getRoles(), true);
  557. }
  559. public function getEmail(): ?string
  560. {
  561. return $this->email;
  562. }
  564. public function setEmail(string $email): void
  565. {
  566. $this->email = $email;
  567. $this->emailCanonical = Canonicalizer::canonicalize($email);
  568. }
  570. public function setSalt(string $salt): void
  571. {
  572. $this->salt = $salt;
  573. }
  575. public function setPassword(string $password): void
  576. {
  577. $this->password = $password;
  578. }
  580. public function __toString(): string
  581. {
  582. return $this->getUsername();
  583. }
  584. }