src/App/Entity/NotificationState.php line 22

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Service\NotificationService;
  6. use App\Utility\GuidUtility;
  7. use DateTime;
  8. use Doctrine\ORM\Mapping as ORM;
  9. use Exception;
  11. /**
  12. * @ORM\Entity
  13. *
  14. * @ORM\Table(
  15. * name="notification_states",
  16. * uniqueConstraints={
  17. *
  18. * @ORM\UniqueConstraint(name="notification_type_user_idx", columns={"notification_type", "users_id"})
  19. * }
  20. * )
  21. */
  22. class NotificationState
  23. {
  24. /**
  25. * @var string
  26. *
  27. * @ORM\GeneratedValue(strategy="CUSTOM")
  28. *
  29. * @ORM\CustomIdGenerator(class="App\Utility\DatabaseIdGenerator")
  30. *
  31. * @ORM\Column(name="id", type="guid")
  32. *
  33. * @ORM\Id
  34. */
  35. protected $id;
  37. public function setId(string $id): void
  38. {
  39. GuidUtility::validOrThrow($id);
  40. $this->id = $id;
  41. }
  43. public function getId()
  44. {
  45. return $this->id;
  46. }
  48. /**
  49. * @var User
  50. *
  51. * @ORM\ManyToOne(targetEntity="App\Entity\User", inversedBy="notificationStates", cascade={"persist"})
  52. *
  53. * @ORM\JoinColumn(name="users_id", referencedColumnName="id", nullable=false, onDelete="CASCADE")
  54. */
  55. protected $user;
  57. public function setUser(User $user): void
  58. {
  59. $this->user = $user;
  60. }
  62. public function getUser(): User
  63. {
  64. return $this->user;
  65. }
  67. /**
  68. * @var int
  69. *
  70. * @ORM\Column(name="notification_type", type="smallint", nullable=false)
  71. */
  72. protected $notificationType;
  74. /**
  75. * @throws Exception
  76. */
  77. public function setNotificationType(int $notificationType): void
  78. {
  79. if (!in_array($notificationType, NotificationService::NOTIFICATION_TYPES)) {
  80. throw new Exception('Value ' . $notificationType . ' not allowed for notificationType.');
  81. }
  82. $this->notificationType = $notificationType;
  83. }
  85. public function getNotificationType(): int
  86. {
  87. return $this->notificationType;
  88. }
  90. /**
  91. * @var int
  92. *
  93. * @ORM\Column(name="number_of_sent_notifications", type="smallint", nullable=false)
  94. *
  95. * @throws Exception
  96. */
  97. protected $numberOfSentNotifications;
  99. public function setNumberOfSentNotifications(int $numberOfSentNotifications): void
  100. {
  101. if ($numberOfSentNotifications < 0) {
  102. throw new Exception('Value ' . $numberOfSentNotifications . ' not allowed for numberOfSentNotifications.');
  103. }
  104. $this->numberOfSentNotifications = $numberOfSentNotifications;
  105. }
  107. public function getNumberOfSentNotifications(): int
  108. {
  109. return $this->numberOfSentNotifications;
  110. }
  112. /**
  113. * @var DateTime
  114. *
  115. * @ORM\Column(name="latest_notification_sent_at", type="datetime", nullable=false)
  116. */
  117. protected $latestNotificationSentAt;
  119. public function setLatestNotificationSentAt(DateTime $latestNotificationSentAt): void
  120. {
  121. $this->latestNotificationSentAt = $latestNotificationSentAt;
  122. }
  124. public function getLatestNotificationSentAt(): DateTime
  125. {
  126. return $this->latestNotificationSentAt;
  127. }
  129. /**
  130. * This is a field which can be filled with arbitrary string data, with content specific
  131. * to each notification type.
  132. *
  133. * @var string|null
  134. *
  135. * @ORM\Column(name="notification_details", type="text", length=4096, nullable=true)
  136. */
  137. protected $notificationDetails;
  139. public function setNotificationDetails(?string $notificationDetails): void
  140. {
  141. $this->notificationDetails = $notificationDetails;
  142. }
  144. public function getNotificationDetails(): ?string
  145. {
  146. return $this->notificationDetails;
  147. }
  148. }