src/App/Entity/UsageEvent.php line 31

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Utility\ReflectionHelper;
  6. use DateTime;
  7. use Doctrine\ORM\Mapping as ORM;
  8. use Exception;
  10. /**
  11. * Usage Event: track what users do in order to decide how the platform presentation or behaviour should change for them.
  12. *
  13. * While Business-, Application-, and Webrequest-Events are tracked for statistical use in the Data Warehouse, Usage
  14. * Events are collected to keep track of how a given user uses our platform, because the behaviour of a user can change
  15. * the behaviour of our software. Example: if a user has seen the recurrent job editor at least once, then stop showing
  16. * them an info box related to recurrent jobs on the Dashboard.
  17. *
  18. * The big advantage of this event format is that it is very lean in terms of storage space - for every combination
  19. * of user<->eventType, only one database row is needed; no matter how often event X is tracked for user Y,
  20. * this one row of information is sufficient to answer the questions "how often did the event occur?" and
  21. * "when was the last time the event occured?".
  22. *
  23. * @see ActivityMonitoringEvent for an extended explanation and a comparison with Activity Monitoring Events
  24. *
  25. * @ORM\Entity()
  26. *
  27. * @ORM\Table(
  28. * name="usage_events"
  29. * )
  30. */
  31. class UsageEvent
  32. {
  33. public const EVENT_TYPE_USER_HAS_SEEN_JOB_EDITOR = 0;
  34. public const EVENT_TYPE_USER_HAS_SENT_MULTIPLE_MESSAGES = 1;
  35. public const EVENT_TYPE_USER_HAS_COMPLETED_BASE_PROFILE = 2;
  36. public const EVENT_TYPE_USER_HAS_COMPLETED_EXTENDED_PROFILE = 3;
  37. public const EVENT_TYPE_USER_HAS_COMPLETED_SUBSCRIPTION = 4;
  38. public const EVENT_TYPE_USER_HAS_SEEN_SUBSCRIPTION_PAGE = 5;
  39. public const EVENT_TYPE_USER_RATES_POSITIVE = 6;
  40. public const EVENT_TYPE_USER_HAS_RATED = 7;
  41. public const EVENT_TYPE_USER_HAS_CLICKED_RATING_LINK = 8;
  42. public const EVENT_TYPE_USER_RECEIVED_FIVE_MESSAGES_EXCLUDING_JOBRADAR = 9;
  43. public const EVENT_TYPE_JOBSEEKER_HAS_USED_SEARCH_FOR_RECURRENT_JOBS = 10;
  44. public const EVENT_TYPE_JOBSEEKER_HAS_CLICKED_DETAIL_VIEW_OF_RECURRENT_JOB = 11;
  45. public const EVENT_TYPE_JOBSEEKER_HAS_CLICKED_PHONE_BUTTON = 12;
  46. public const EVENT_TYPE_USER_REACTED_TO_JOBRADAR = 13;
  47. public const EVENT_TYPE_JOBSEEKER_SENT_MESSAGE = 14;
  48. public const EVENT_TYPE_JOBOFFERER_SENT_MESSAGE = 15;
  49. public const EVENT_TYPE_JOBOFFERER_CLICKED_SHARE_RECURRENT_JOB_ICON = 16;
  50. public const EVENT_TYPE_USER_HAS_ADDED_PROFILE_PICTURE = 17;
  51. public const EVENT_TYPE_USER_SENT_CONVERSATION_MESSAGE = 18;
  52. public const EVENT_TYPE_USER_HAS_BEEN_INFORMED_ABOUT_PAYMENT_ESCALATED = 19;
  53. public const EVENT_TYPE_USER_HAS_DELETED_PROFILE_PICTURE = 20;
  54. public const EVENT_TYPE_NEW_USER_HAS_CONFIRMED_ACCOUNT = 21;
  55. public const EVENT_TYPE_JOBOFFERER_HAS_USED_SEARCH_FOR_WANTED_JOBS = 22;
  56. public const EVENT_TYPE_JOBOFFERER_HAS_CLICKED_DETAIL_VIEW_OF_WANTED_JOB = 23;
  57. public const EVENT_TYPE_JOBOFFERER_HAS_CLICKED_PHONE_BUTTON = 24;
  58. public const EVENT_TYPE_JOBSEEKER_CLICKED_SHARE_WANTED_JOB_ICON = 25;
  59. public const EVENT_TYPE_GG_USER_HAS_LOGGED_IN = 26;
  60. public const EVENT_TYPE_USER_HAS_RECEIVED_CANCELLATION_EMAIL = 27;
  61. public const EVENT_TYPE_USER_HAS_CLICKED_JOBLIFT_JOBOFFER = 28;
  62. public const EVENT_TYPE_WISAG_WAS_INFORMED_ABOUT_PREMIUM_MESSAGES = 29;
  63. public const EVENT_TYPE_USER_HAS_GOT_SELFDESCRIPTION_PROPOSAL = 30;
  64. public const EVENT_TYPE_USER_HAS_CHANGED_SELFDESCRIPTION_PROPOSAL = 31;
  65. public const EVENT_TYPE_NEW_GERMAN_PERSONNEL_BILLED_JOB = 32;
  66. public const EVENT_TYPE_EXTERNAL_PARTNER_RECURRENT_JOB_HAS_BEEN_PROLONGED = 33;
  67. public const EVENT_TYPE_USER_HAS_BEEN_INFORMED_ABOUT_RECURRENT_JOBS_BELONGING_TO_JOBOO_GMBH = 34;
  68. public const EVENT_TYPE_USER_HAS_REQUESTED_MYDAYS_VOUCHER = 35;
  69. public const EVENT_TYPE_USER_HAS_VISITED_EXTERNAL_JOBOFFER = 36;
  70. public const EVENT_TYPE_JOBSEEKER_HAS_CLICKED_PHONE_BUTTON_IN_RECURRENT_JOBS_SEARCH = 37;
  71. public const EVENT_TYPE_JOBSEEKER_HAS_CLICKED_PHONE_BUTTON_IN_RECURRENT_JOBS_SEARCH_ALL_JOBS = 38;
  72. public const EVENT_TYPE_JOBOFFERER_GOT_75_PERCENT_DISCOUNT_CODE = 39;
  73. public const EVENT_TYPE_JOBOFFERER_GOT_FREE_MONTH_CODE = 40;
  74. public const EVENT_TYPE_USER_SAW_MEMBERSHIP_MODAL = 41;
  75. public const EVENT_TYPE_USER_HAS_BEEN_SENT_GOOGLE_RATING_REQUEST = 42;
  76. public const EVENT_TYPE_USER_HAS_BEEN_INFORMED_ABOUT_SCHEDULING_STATUS_CHANGE = 43;
  78. /**
  79. * @ORM\Id
  80. *
  81. * @ORM\ManyToOne(targetEntity="App\Entity\User", cascade={"persist"})
  82. *
  83. * @ORM\JoinColumn(name="users_id", referencedColumnName="id", nullable=false, onDelete="CASCADE")
  84. */
  85. private User $user;
  87. public function setUser(User $user): void
  88. {
  89. $this->user = $user;
  90. }
  92. public function getUser(): User
  93. {
  94. return $this->user;
  95. }
  97. /**
  98. * @ORM\Id
  99. *
  100. * @ORM\Column(name="event_type", type="smallint", nullable=false)
  101. */
  102. private int $eventType;
  104. /**
  105. * @throws Exception
  106. */
  107. public function setEventType(int $eventType): void
  108. {
  109. if (!ReflectionHelper::hasConstWithValue(self::class, 'EVENT_TYPE_', $eventType)) {
  110. throw new Exception('Value ' . $eventType . ' not allowed for eventType.');
  111. }
  112. $this->eventType = $eventType;
  113. }
  115. public function getEventType(): int
  116. {
  117. return $this->eventType;
  118. }
  120. /**
  121. * @ORM\Column(name="last_occurred_at", type="datetime", nullable=false)
  122. */
  123. private DateTime $lastOccurredAt;
  125. public function getLastOccurredAt(): DateTime
  126. {
  127. return $this->lastOccurredAt;
  128. }
  130. public function setLastOccurredAt(DateTime $lastOccurredAt)
  131. {
  132. $this->lastOccurredAt = $lastOccurredAt;
  133. }
  135. /**
  136. * @ORM\Column(name="number_of_occurrences", type="integer", nullable=false)
  137. */
  138. private int $numberOfOccurrences;
  140. public function setNumberOfOccurrences(int $numberOfOccurrences): void
  141. {
  142. $this->numberOfOccurrences = $numberOfOccurrences;
  143. }
  145. public function getNumberOfOccurrences(): int
  146. {
  147. return $this->numberOfOccurrences;
  148. }
  149. }