src/Entity/User.php line 129

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use Doctrine\Common\Collections\ArrayCollection;
  6. use Doctrine\Common\Collections\Collection;
  7. use Doctrine\ORM\Mapping as ORM;
  8. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  9. use Symfony\Component\Security\Core\User\UserInterface;
  10. use Symfony\Component\Validator\Constraints as Assert;
  11. use Rollerworks\Component\PasswordStrength\Validator\Constraints as RollerworksPassword;
  13. /**
  14. * @ORM\Entity(repositoryClass="App\Repository\UserRepository")
  15. * @ORM\Table(name="users")
  16. * @UniqueEntity(fields={"email"}, message="There is already an account with this email")
  17. */
  18. class User implements UserInterface
  19. {
  20. /**
  21. * @ORM\Id()
  22. * @ORM\GeneratedValue()
  23. * @ORM\Column(type="integer")
  24. */
  25. private $id;
  27. /**
  28. * @ORM\Column(type="string", length=180, unique=true)
  29. */
  30. private $email;
  32. /**
  33. * @ORM\Column(type="json")
  34. */
  35. private $roles = [];
  37. /**
  38. * @var string The hashed password
  39. * @ORM\Column(type="string")
  40. * @RollerworksPassword\PasswordStrength(minLength=8, minStrength=3)
  41. */
  42. private $password;
  44. /**
  45. * @ORM\ManyToMany(targetEntity="App\Entity\Newsletter", inversedBy="subscribers")
  46. */
  47. private $subscriptions;
  49. /**
  50. * @ORM\OneToMany(targetEntity="App\Entity\ApplicationRole", mappedBy="user")
  51. */
  52. private $applicationRoles;
  54. /**
  55. * @ORM\Column(type="boolean")
  56. */
  57. private $verified;
  59. /**
  60. * @ORM\Column(type="string", length=255, nullable=true)
  61. */
  62. private $verificationToken;
  64. /**
  65. * @ORM\Column(type="string", length=255, nullable=true)
  66. */
  67. private $title;
  69. /**
  70. * @ORM\Column(type="string", length=255)
  71. */
  72. private $forename;
  74. /**
  75. * @ORM\Column(type="string", length=255)
  76. */
  77. private $surname;
  79. /**
  80. * @ORM\OneToMany(targetEntity="App\Entity\Audit", mappedBy="user")
  81. */
  82. private $audits;
  84. /**
  85. * @ORM\OneToMany(targetEntity="App\Entity\Comment", mappedBy="user")
  86. */
  87. private $comments;
  89. /**
  90. * @ORM\OneToMany(targetEntity="App\Entity\Student", mappedBy="user")
  91. */
  92. private $studentships;
  94. /**
  95. * @ORM\OneToMany(targetEntity=ApplicationReportRole::class, mappedBy="createdBy")
  96. */
  97. private $applicationReportRoles;
  99. public const TITLES = [
  100. 'dr' => 'Dr',
  101. 'prof' => 'Professor',
  102. 'mr' => 'Mr',
  103. 'ms' => 'Ms',
  104. 'mrs' => 'Mrs',
  105. 'miss' => 'Miss',
  106. ];
  108. public function __construct()
  109. {
  110. $this->subscriptions = new ArrayCollection();
  111. $this->applicationRoles = new ArrayCollection();
  113. $this->setRoles(['ROLE_USER']);
  114. $this->setVerified(false);
  115. $this->setVerificationToken(uniqid());
  116. $this->audits = new ArrayCollection();
  117. $this->comments = new ArrayCollection();
  118. $this->studentships = new ArrayCollection();
  119. $this->applicationReportRoles = new ArrayCollection();
  120. }
  123. public function getId(): ?int
  124. {
  125. return $this->id;
  126. }
  129. public function getEmail(): ?string
  130. {
  131. return strpos($this->email, '@') ? $this->email : null;
  132. }
  134. public function setEmail(?string $email): self
  135. {
  136. $this->email = $email;
  138. return $this;
  139. }
  141. public function getUsername(): string
  142. {
  143. return (string)$this->email;
  144. }
  146. /**
  147. * A visual identifier that represents this user.
  148. *
  149. * @see UserInterface
  150. */
  151. public function getUserIdentifier(): string
  152. {
  153. return (string) $this->email;
  154. }
  156. public function getRoles(): array
  157. {
  158. $roles = $this->roles;
  159. // guarantee every user at least has ROLE_USER
  160. $roles[] = 'ROLE_USER';
  162. return array_unique($roles);
  163. }
  165. public function setRoles(array $roles): self
  166. {
  167. $this->roles = $roles;
  169. return $this;
  170. }
  172. public function removeRoles(array $roles)
  173. {
  174. $currentRoles = $this->getRoles();
  176. $this->roles = array_diff($currentRoles, $roles);
  178. return $this;
  179. }
  181. public function getPassword(): string
  182. {
  183. return (string)$this->password;
  184. }
  186. public function setPassword(string $password): self
  187. {
  188. $this->password = $password;
  190. return $this;
  191. }
  194. public function getSalt()
  195. {
  196. // not needed when using the "bcrypt" algorithm in security.yaml
  197. }
  199. public function eraseCredentials()
  200. {
  201. // If you store any temporary, sensitive data on the user, clear it here
  202. // $this->plainPassword = null;
  203. }
  205. public function isUserAdmin()
  206. {
  207. foreach($this->roles as $role) {
  208. if ($role == "ROLE_ADMIN") {
  209. return true;
  210. }
  211. }
  212. return false;
  213. }
  216. public function getFullName(): ?string
  217. {
  218. $title = $this->getTitle() ? self::TITLES[$this->getTitle()] : '';
  220. return implode(' ', array_filter([
  221. $title,
  222. $this->getForename(),
  223. $this->getSurname(),
  224. ]));
  225. }
  228. /**
  229. * @return Collection|Newsletter[]
  230. */
  231. public function getSubscriptions(): Collection
  232. {
  233. return $this->subscriptions;
  234. }
  236. public function addSubscription(Newsletter $subscription): self
  237. {
  238. if (!$this->subscriptions->contains($subscription)) {
  239. $this->subscriptions[] = $subscription;
  240. }
  242. return $this;
  243. }
  245. public function removeSubscription(Newsletter $subscription): self
  246. {
  247. if ($this->subscriptions->contains($subscription)) {
  248. $this->subscriptions->removeElement($subscription);
  249. }
  251. return $this;
  252. }
  255. /**
  256. * @return Collection|ApplicationRole[]
  257. */
  258. public function getApplicationRoles(): Collection
  259. {
  260. return $this->applicationRoles;
  261. }
  263. /**
  264. * Get all application roles where the role type acronym is not 'RL' or 'RM'
  265. *
  266. * @return Collection|ApplicationRole[]
  267. */
  268. public function getFilteredApplicationRoles(): Collection
  269. {
  270. return $this->applicationRoles->filter(function ($role) {
  271. $acronym = $role->getApplicationRoleType()->getAcronym();
  272. return $acronym !== 'RL' && $acronym !== 'RM' && $acronym !== '3R';
  273. });
  274. }
  276. public function addApplicationRole(ApplicationRole $applicationRole): self
  277. {
  278. if (!$this->applicationRoles->contains($applicationRole)) {
  279. $this->applicationRoles[] = $applicationRole;
  280. $applicationRole->setUser($this);
  281. }
  283. return $this;
  284. }
  286. public function removeApplicationRole(ApplicationRole $applicationRole): self
  287. {
  288. if ($this->applicationRoles->contains($applicationRole)) {
  289. $this->applicationRoles->removeElement($applicationRole);
  290. // set the owning side to null (unless already changed)
  291. if ($applicationRole->getUser() === $this) {
  292. $applicationRole->setUsery(null);
  293. }
  294. }
  296. return $this;
  297. }
  300. public function isVerified(): ?bool
  301. {
  302. return $this->verified;
  303. }
  305. public function setVerified(bool $verified): self
  306. {
  307. $this->verified = $verified;
  309. return $this;
  310. }
  313. public function getVerificationToken(): ?string
  314. {
  315. return $this->verificationToken;
  316. }
  318. public function setVerificationToken(?string $verificationToken): self
  319. {
  320. $this->verificationToken = $verificationToken;
  322. return $this;
  323. }
  326. public function getApplications(): Collection
  327. {
  328. $applications = new ArrayCollection();
  329. foreach ($this->applicationRoles as $role) {
  330. $applications->add($role->getApplication());
  331. }
  333. return $applications;
  334. }
  336. public function getTitle(): ?string
  337. {
  338. return $this->title;
  339. }
  341. public function setTitle(?string $title): self
  342. {
  343. $this->title = $title;
  345. return $this;
  346. }
  348. public function getForename(): ?string
  349. {
  350. return $this->forename;
  351. }
  353. public function getForenameById($id): ?string
  354. {
  355. return $this->getDoctrine()->getRepository(User::class)->find($id);
  356. }
  358. public function setForename(string $forename): self
  359. {
  360. $this->forename = $forename;
  362. return $this;
  363. }
  365. public function getSurname(): ?string
  366. {
  367. return $this->surname;
  368. }
  370. public function setSurname(string $surname): self
  371. {
  372. $this->surname = $surname;
  374. return $this;
  375. }
  377. public function getVerified(): ?bool
  378. {
  379. return $this->verified;
  380. }
  382. /**
  383. * @return Collection|Audit[]
  384. */
  385. public function getAudits(): Collection
  386. {
  387. return $this->audits;
  388. }
  390. public function addAudit(Audit $audit): self
  391. {
  392. if (!$this->audits->contains($audit)) {
  393. $this->audits[] = $audit;
  394. $audit->setUser($this);
  395. }
  397. return $this;
  398. }
  400. public function removeAudit(Audit $audit): self
  401. {
  402. if ($this->audits->contains($audit)) {
  403. $this->audits->removeElement($audit);
  404. // set the owning side to null (unless already changed)
  405. if ($audit->getUser() === $this) {
  406. $audit->setUser(null);
  407. }
  408. }
  410. return $this;
  411. }
  413. /**
  414. * @return Collection|Comment[]
  415. */
  416. public function getComments(): Collection
  417. {
  418. return $this->comments;
  419. }
  421. public function addComment(Comment $comment): self
  422. {
  423. if (!$this->comments->contains($comment)) {
  424. $this->comments[] = $comment;
  425. $comment->setUser($this);
  426. }
  428. return $this;
  429. }
  431. public function removeComment(Comment $comment): self
  432. {
  433. if ($this->comments->contains($comment)) {
  434. $this->comments->removeElement($comment);
  435. // set the owning side to null (unless already changed)
  436. if ($comment->getUser() === $this) {
  437. $comment->setUser(null);
  438. }
  439. }
  441. return $this;
  442. }
  444. /**
  445. * @return Collection|Student[]
  446. */
  447. public function getStudentships(): Collection
  448. {
  449. return $this->studentships;
  450. }
  452. public function addStudentship(Student $studentship): self
  453. {
  454. if (!$this->studentships->contains($studentship)) {
  455. $this->studentships[] = $studentship;
  456. $studentship->setUser($this);
  457. }
  459. return $this;
  460. }
  462. public function removeStudentship(Student $studentship): self
  463. {
  464. if ($this->studentships->contains($studentship)) {
  465. $this->studentships->removeElement($studentship);
  466. // set the owning side to null (unless already changed)
  467. if ($studentship->getUser() === $this) {
  468. $studentship->setUser(null);
  469. }
  470. }
  472. return $this;
  473. }
  475. /**
  476. * @return Collection<int, ApplicationReportRole>
  477. */
  478. public function getApplicationReportRoles(): Collection
  479. {
  480. return $this->applicationReportRoles;
  481. }
  483. public function addApplicationReportRole(ApplicationReportRole $applicationReportRole): self
  484. {
  485. if (!$this->applicationReportRoles->contains($applicationReportRole)) {
  486. $this->applicationReportRoles[] = $applicationReportRole;
  487. $applicationReportRole->setCreatedBy($this);
  488. }
  490. return $this;
  491. }
  493. public function removeApplicationReportRole(ApplicationReportRole $applicationReportRole): self
  494. {
  495. if ($this->applicationReportRoles->removeElement($applicationReportRole)) {
  496. // set the owning side to null (unless already changed)
  497. if ($applicationReportRole->getCreatedBy() === $this) {
  498. $applicationReportRole->setCreatedBy(null);
  499. }
  500. }
  502. return $this;
  503. }
  504. }