src/App/Entity/SearchtermEnteredEvent.php line 22

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Utility\GuidUtility;
  6. use App\Utility\ReflectionHelper;
  7. use DateTime;
  8. use Doctrine\ORM\Mapping as ORM;
  9. use Exception;
  11. /**
  12. * @ORM\Entity
  13. *
  14. * @ORM\Table(
  15. * name="searchterm_entered_events",
  16. * indexes={
  17. *
  18. * @ORM\Index(name="occured_at_idx", columns={"occured_at"})
  19. * }
  20. * )
  21. */
  22. class SearchtermEnteredEvent
  23. {
  24. public const CONTEXT_JOBSEEKER_REGISTRATION = 0;
  25. public const CONTEXT_JOBOFFERER_REGISTRATION = 1;
  26. public const CONTEXT_WANTED_JOB_CREATION = 2;
  27. public const CONTEXT_RECURRENT_JOB_CREATION = 3;
  28. public const CONTEXT_WANTED_JOBS_SEARCH_LOGGED_IN = 4;
  29. public const CONTEXT_WANTED_JOBS_SEARCH_ANONYMOUS = 5;
  30. public const CONTEXT_RECURRENT_JOBS_SEARCH_LOGGED_IN = 6;
  31. public const CONTEXT_RECURRENT_JOBS_SEARCH_ANONYMOUS = 7;
  33. /**
  34. * @throws Exception
  35. */
  36. public function __construct(
  37. DateTime $occuredAt,
  38. string $searchterm,
  39. int $context
  40. ) {
  41. $this->occuredAt = $occuredAt;
  42. $this->searchterm = $searchterm;
  44. if (!ReflectionHelper::hasConstWithValue(self::class, 'CONTEXT_', $context)) {
  45. throw new Exception('Value ' . $context . ' not allowed for $context.');
  46. }
  48. $this->context = $context;
  49. }
  51. /**
  52. * @ORM\GeneratedValue(strategy="CUSTOM")
  53. *
  54. * @ORM\CustomIdGenerator(class="App\Utility\DatabaseIdGenerator")
  55. *
  56. * @ORM\Column(name="id", type="guid")
  57. *
  58. * @ORM\Id
  59. */
  60. private ?string $id;
  62. public function setId(string $id): void
  63. {
  64. GuidUtility::validOrThrow($id);
  65. $this->id = $id;
  66. }
  68. public function getId(): ?string
  69. {
  70. return $this->id;
  71. }
  73. /**
  74. * @ORM\Column(name="occured_at", type="datetime", nullable=false)
  75. */
  76. private DateTime $occuredAt;
  78. public function getOccuredAt(): DateTime
  79. {
  80. return $this->occuredAt;
  81. }
  83. /**
  84. * @ORM\Column(name="searchterm", type="string", nullable=false)
  85. */
  86. private string $searchterm;
  88. public function getSearchterm(): string
  89. {
  90. return $this->searchterm;
  91. }
  93. /**
  94. * @var array|string[]|null
  95. *
  96. * @ORM\Column(name="additional_searchterms", type="array", nullable=true)
  97. */
  98. private ?array $additionalSearchterms = null;
  100. public function setAdditionalSearchterms(?array $additionalSearchterms = null): void
  101. {
  102. $this->additionalSearchterms = $additionalSearchterms;
  103. }
  105. /**
  106. * @return array|string[]|null
  107. */
  108. public function getAdditionalSearchterms(): ?array
  109. {
  110. return $this->additionalSearchterms;
  111. }
  113. /**
  114. * @ORM\Column(name="context", type="integer", nullable=false)
  115. */
  116. private int $context;
  118. public function getContext(): int
  119. {
  120. return $this->context;
  121. }
  123. /**
  124. * @ORM\Column(name="number_of_occupational_fields", type="integer", nullable=true)
  125. */
  126. private ?int $numberOfOccupationalFields = null;
  128. public function setNumberOfOccupationalFields(?int $numberOfOccupationalFields = null): void
  129. {
  130. $this->numberOfOccupationalFields = $numberOfOccupationalFields;
  131. }
  133. public function getNumberOfOccupationalFields(): ?int
  134. {
  135. return $this->numberOfOccupationalFields;
  136. }
  138. /**
  139. * @ORM\Column(name="number_of_relevant_occupational_fields", type="integer", nullable=true)
  140. */
  141. private ?int $numberOfRelevantOccupationalFields = null;
  143. public function setNumberOfRelevantOccupationalFields(?int $numberOfRelevantOccupationalFields = null): void
  144. {
  145. $this->numberOfRelevantOccupationalFields = $numberOfRelevantOccupationalFields;
  146. }
  148. public function getNumberOfRelevantOccupationalFields(): ?int
  149. {
  150. return $this->numberOfRelevantOccupationalFields;
  151. }
  153. /**
  154. * @ORM\Column(name="number_of_relevant_professions", type="integer", nullable=true)
  155. */
  156. private ?int $numberOfRelevantProfessions = null;
  158. public function setNumberOfRelevantProfessions(?int $numberOfRelevantProfessions = null): void
  159. {
  160. $this->numberOfRelevantProfessions = $numberOfRelevantProfessions;
  161. }
  163. public function getNumberOfRelevantProfessions(): ?int
  164. {
  165. return $this->numberOfRelevantProfessions;
  166. }
  168. /**
  169. * @ORM\Column(name="number_of_hits_in_search", type="integer", nullable=true)
  170. */
  171. private ?int $numberOfHitsInSearch = null;
  173. public function setNumberOfHitsInSearch(?int $numberOfHitsInSearch = null): void
  174. {
  175. $this->numberOfHitsInSearch = $numberOfHitsInSearch;
  176. }
  178. public function getNumberOfHitsInSearch(): ?int
  179. {
  180. return $this->numberOfHitsInSearch;
  181. }
  183. /**
  184. * @ORM\Column(name="number_of_hits_per_block", type="text", length=4096, nullable=true)
  185. */
  186. private ?string $numberOfHitsPerBlock = null;
  188. public function getNumberOfHitsPerBlock(): ?string
  189. {
  190. return $this->numberOfHitsPerBlock;
  191. }
  193. /** @throws Exception */
  194. public function setNumberOfHitsPerBlock(?string $numberOfHitsPerBlock): void
  195. {
  196. if (!is_null($numberOfHitsPerBlock)) {
  197. if (is_null(json_decode($numberOfHitsPerBlock))) {
  198. throw new Exception('additionalData must be valid JSON');
  199. }
  200. }
  201. $this->numberOfHitsPerBlock = $numberOfHitsPerBlock;
  202. }
  204. /**
  205. * @ORM\Column(name="affected_user_id", type="guid", nullable=true)
  206. *
  207. * We don't make this a foreign key on purpose, we don't need the integrity and don't want to delete event data
  208. * if a user is deleted.
  209. */
  210. private ?string $affectedUserId = null;
  212. public function setAffectedUserId(?string $userId = null): void
  213. {
  214. GuidUtility::validOrThrow($userId, true);
  215. $this->affectedUserId = $userId;
  216. }
  218. public function getAffectedUserId(): ?string
  219. {
  220. return $this->affectedUserId;
  221. }
  223. /**
  224. * @ORM\Column(name="affected_user_is_jobofferer", type="boolean", nullable=false)
  225. */
  226. private bool $affectedUserIsJobofferer = false;
  228. public function setAffectedUserIsJobofferer(bool $affectedUserIsJobofferer): void
  229. {
  230. $this->affectedUserIsJobofferer = $affectedUserIsJobofferer;
  231. }
  233. public function getAffectedUserIsJobofferer(): bool
  234. {
  235. return $this->affectedUserIsJobofferer;
  236. }
  238. /**
  239. * @ORM\Column(name="affected_user_is_jobseeker", type="boolean", nullable=false)
  240. */
  241. private bool $affectedUserIsJobseeker = false;
  243. public function setAffectedUserIsJobseeker(bool $affectedUserIsJobseeker): void
  244. {
  245. $this->affectedUserIsJobseeker = $affectedUserIsJobseeker;
  246. }
  248. public function getAffectedUserIsJobseeker(): bool
  249. {
  250. return $this->affectedUserIsJobseeker;
  251. }
  253. /**
  254. * @ORM\Column(name="affected_user_registered_at", type="datetime", nullable=true)
  255. *
  256. * In order to show statistics related to the cohorte of all users registered on day X, we need this field
  257. *
  258. * E.g. "from all user registered on 2018-04-07, how many ran into error X?"
  259. */
  260. private ?DateTime $affectedUserRegisteredAt = null;
  262. public function setAffectedUserRegisteredAt(?DateTime $affectedUserRegisteredAt = null): void
  263. {
  264. $this->affectedUserRegisteredAt = $affectedUserRegisteredAt;
  265. }
  267. public function getAffectedUserRegisteredAt(): ?DateTime
  268. {
  269. return $this->affectedUserRegisteredAt;
  270. }
  272. /**
  273. * @ORM\Column(name="admin_user_id", type="guid", nullable=true)
  274. *
  275. * We don't make this a foreign key on purpose, we don't need the integrity and don't want to delete event data
  276. * if a user is deleted.
  277. */
  278. private ?string $adminUserId = null;
  280. public function setAdminUserId(?string $adminUserId = null): void
  281. {
  282. GuidUtility::validOrThrow($adminUserId, true);
  283. $this->adminUserId = $adminUserId;
  284. }
  286. public function getAdminUserId(): ?string
  287. {
  288. return $this->adminUserId;
  289. }
  291. /**
  292. * @ORM\Column(name="request_id", type="text", length=256, nullable=true)
  293. */
  294. private ?string $requestId = null;
  296. public function setRequestId(?string $requestId = null): void
  297. {
  298. $this->requestId = $requestId;
  299. }
  301. public function getRequestId(): ?string
  302. {
  303. return $this->requestId;
  304. }
  306. /**
  307. * @ORM\Column(name="session_id", type="text", length=256, nullable=true)
  308. */
  309. private ?string $sessionId = null;
  311. public function setSessionId(?string $sessionId = null): void
  312. {
  313. $this->sessionId = $sessionId;
  314. }
  316. public function getSessionId(): ?string
  317. {
  318. return $this->sessionId;
  319. }
  321. /**
  322. * @ORM\Column(name="client_id", type="text", length=64, nullable=true)
  323. */
  324. private ?string $clientId = null;
  326. public function setClientId(?string $clientId = null): void
  327. {
  328. $this->clientId = $clientId;
  329. }
  331. public function getClientId(): ?string
  332. {
  333. return $this->clientId;
  334. }
  336. /**
  337. * @ORM\Column(name="is_probably_bot_request", type="boolean", nullable=true)
  338. */
  339. private ?bool $isProbablyBotRequest = null;
  341. public function setIsProbablyBotRequest(?bool $isProbablyBotRequest): void
  342. {
  343. $this->isProbablyBotRequest = $isProbablyBotRequest;
  344. }
  345. }