src/App/Entity/ConversionEvent.php line 26

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Service\ConversionEventService;
  6. use App\Utility\GuidUtility;
  7. use App\Utility\ReflectionHelper;
  8. use DateTime;
  9. use Doctrine\ORM\Mapping as ORM;
  10. use Exception;
  11. use InvalidArgumentException;
  12. use ValueError;
  14. /**
  15. * @ORM\Entity()
  16. *
  17. * @ORM\Table(
  18. * name="conversion_events",
  19. * indexes={
  20. *
  21. * @ORM\Index(name="occured_at_idx", columns={"occured_at"}),
  22. * @ORM\Index(name="affected_user_id_occured_at_idx", columns={"affected_user_id", "occured_at"}, options={"lengths": {8, null}})
  23. * }
  24. * )
  25. */
  26. class ConversionEvent
  27. {
  28. public const STEP_LINK_CREATED = 0;
  29. public const STEP_LINK_CLICKED = 1;
  30. public const STEP_GOAL_REACHED = 2;
  32. public function __construct()
  33. {
  34. $this->affectedUserIsJobofferer = false;
  35. $this->affectedUserIsJobseeker = false;
  36. $this->referencedConversionEventId = null;
  37. $this->affectedUserId = null;
  38. $this->affectedUserRegisteredAt = null;
  39. $this->relatedRecurrentJobId = null;
  40. $this->numberOfCampaignStarts = null;
  41. $this->requestId = null;
  42. $this->sessionId = null;
  43. $this->clientId = null;
  44. $this->additionalData = null;
  45. $this->isProbablyBotRequest = null;
  46. }
  48. /**
  49. * @ORM\GeneratedValue(strategy="CUSTOM")
  50. *
  51. * @ORM\CustomIdGenerator(class="App\Utility\DatabaseIdGenerator")
  52. *
  53. * @ORM\Column(name="id", type="guid")
  54. *
  55. * @ORM\Id
  56. */
  57. private string $id;
  59. public function setId(string $id)
  60. {
  61. GuidUtility::validOrThrow($id);
  62. $this->id = $id;
  63. }
  65. public function getId(): string
  66. {
  67. return $this->id;
  68. }
  70. /**
  71. * @ORM\Column(name="affected_user_id", type="guid", nullable=true)
  72. *
  73. * We don't make this a foreign key on purpose, we don't need the integrity and don't want to delete event data
  74. * if a user is deleted.
  75. */
  76. protected ?string $affectedUserId;
  78. public function setAffectedUserId(?string $userId)
  79. {
  80. GuidUtility::validOrThrow($userId, true);
  81. $this->affectedUserId = $userId;
  82. }
  84. public function getAffectedUserId(): ?string
  85. {
  86. return $this->affectedUserId;
  87. }
  89. /**
  90. * @ORM\Column(name="affected_user_is_jobofferer", type="boolean", nullable=false)
  91. */
  92. protected bool $affectedUserIsJobofferer;
  94. public function setAffectedUserIsJobofferer(bool $affectedUserIsJobofferer)
  95. {
  96. $this->affectedUserIsJobofferer = $affectedUserIsJobofferer;
  97. }
  99. public function getAffectedUserIsJobofferer(): bool
  100. {
  101. return $this->affectedUserIsJobofferer;
  102. }
  104. /**
  105. * @ORM\Column(name="affected_user_is_jobseeker", type="boolean", nullable=false)
  106. */
  107. protected bool $affectedUserIsJobseeker;
  109. public function setAffectedUserIsJobseeker(bool $affectedUserIsJobseeker)
  110. {
  111. $this->affectedUserIsJobseeker = $affectedUserIsJobseeker;
  112. }
  114. public function getAffectedUserIsJobseeker(): bool
  115. {
  116. return $this->affectedUserIsJobseeker;
  117. }
  119. /**
  120. * @ORM\Column(name="affected_user_registered_at", type="datetime", nullable=true)
  121. */
  122. protected ?DateTime $affectedUserRegisteredAt;
  124. public function setAffectedUserRegisteredAt(?DateTime $affectedUserRegisteredAt): void
  125. {
  126. $this->affectedUserRegisteredAt = $affectedUserRegisteredAt;
  127. }
  129. public function getAffectedUserRegisteredAt(): ?DateTime
  130. {
  131. return $this->affectedUserRegisteredAt;
  132. }
  134. /**
  135. * @ORM\Column(name="referenced_conversion_events_id", type="guid", nullable=true)
  136. */
  137. protected ?string $referencedConversionEventId;
  139. public function setReferencedConversionEventId(?string $referencedConversionEventId): void
  140. {
  141. GuidUtility::validOrThrow($referencedConversionEventId, true);
  142. $this->referencedConversionEventId = $referencedConversionEventId;
  143. }
  145. public function getReferencedConversionEventId(): ?string
  146. {
  147. return $this->referencedConversionEventId;
  148. }
  150. /**
  151. * @ORM\Column(name="campaign_id", type="integer", nullable=false)
  152. */
  153. protected int $campaignId;
  155. public function setCampaignId(int $campaignId): void
  156. {
  157. if (!ReflectionHelper::hasConstWithValue(
  158. ConversionEventService::class,
  159. 'CAMPAIGN_ID_',
  160. $campaignId)
  161. ) {
  162. throw new ValueError("Invalid campaign id '$campaignId'.");
  163. }
  164. $this->campaignId = $campaignId;
  165. }
  167. public function getCampaignId(): int
  168. {
  169. return $this->campaignId;
  170. }
  172. /**
  173. * @ORM\Column(name="subcampaign_id", type="integer", nullable=false)
  174. */
  175. protected int $subcampaignId;
  177. public function setSubcampaignId(int $subcampaignId): void
  178. {
  179. if ($subcampaignId < 0) {
  180. throw new ValueError("Invalid subcampaign id '$subcampaignId'.");
  181. }
  182. $this->subcampaignId = $subcampaignId;
  183. }
  185. public function getSubcampaignId(): int
  186. {
  187. return $this->subcampaignId;
  188. }
  190. /**
  191. * @ORM\Column(name="step", type="smallint", nullable=false)
  192. */
  193. protected int $step;
  195. /** @throws Exception */
  196. public function setStep(int $step): void
  197. {
  198. if (!in_array($step, [self::STEP_LINK_CREATED, self::STEP_LINK_CLICKED, self::STEP_GOAL_REACHED])) {
  199. throw new Exception("Invalid step value '$step'.");
  200. }
  201. $this->step = $step;
  202. }
  204. public function getStep(): int
  205. {
  206. return $this->step;
  207. }
  209. /**
  210. * @ORM\Column(name="occured_at", type="datetime", nullable=false)
  211. */
  212. protected DateTime $occuredAt;
  214. public function getOccuredAt(): DateTime
  215. {
  216. return $this->occuredAt;
  217. }
  219. public function setOccuredAt(DateTime $occuredAt)
  220. {
  221. $this->occuredAt = $occuredAt;
  222. }
  224. /**
  225. * @ORM\Column(name="related_recurrent_job_id", type="guid", nullable=true)
  226. *
  227. * We don't make this a foreign key on purpose, we don't need the integrity and don't want to delete event data
  228. * if a user is deleted.
  229. */
  230. protected ?string $relatedRecurrentJobId;
  232. /** @throws InvalidArgumentException */
  233. public function setRelatedRecurrentJobId(?string $relatedRecurrentJobId = null): void
  234. {
  235. GuidUtility::validOrThrow($relatedRecurrentJobId, true);
  236. $this->relatedRecurrentJobId = $relatedRecurrentJobId;
  237. }
  239. public function getRelatedRecurrentJobId(): ?string
  240. {
  241. return $this->relatedRecurrentJobId;
  242. }
  244. /**
  245. * @ORM\Column(name="number_of_campaign_starts", type="integer", nullable=true)
  246. */
  247. protected ?int $numberOfCampaignStarts;
  249. /** @throws Exception */
  250. public function setNumberOfCampaignStarts(?int $numberOfCampaignStarts): void
  251. {
  252. $this->numberOfCampaignStarts = $numberOfCampaignStarts;
  253. }
  255. public function getNumberOfCampaignStarts(): ?int
  256. {
  257. return $this->numberOfCampaignStarts;
  258. }
  260. /**
  261. * @ORM\Column(name="request_id", type="text", length=256, nullable=true)
  262. */
  263. protected ?string $requestId;
  265. public function setRequestId(?string $requestId = null): void
  266. {
  267. $this->requestId = $requestId;
  268. }
  270. public function getRequestId(): ?string
  271. {
  272. return $this->requestId;
  273. }
  275. /**
  276. * @ORM\Column(name="session_id", type="text", length=256, nullable=true)
  277. */
  278. protected ?string $sessionId;
  280. public function setSessionId(?string $sessionId = null): void
  281. {
  282. $this->sessionId = $sessionId;
  283. }
  285. public function getSessionId(): ?string
  286. {
  287. return $this->sessionId;
  288. }
  290. /**
  291. * @ORM\Column(name="client_id", type="text", length=64, nullable=true)
  292. */
  293. protected ?string $clientId;
  295. public function setClientId(?string $clientId = null): void
  296. {
  297. $this->clientId = $clientId;
  298. }
  300. public function getClientId(): ?string
  301. {
  302. return $this->clientId;
  303. }
  305. /**
  306. * @ORM\Column(name="additional_data", type="text", length=4096, nullable=true)
  307. */
  308. protected ?string $additionalData;
  310. /** @throws Exception */
  311. public function setAdditionalData($additionalData): void
  312. {
  313. if (!is_null($additionalData)) {
  314. if (is_null(json_decode($additionalData))) {
  315. throw new Exception('additionalData must be valid JSON');
  316. }
  317. }
  318. $this->additionalData = $additionalData;
  319. }
  321. public function getAdditionalData(): ?string
  322. {
  323. return $this->additionalData;
  324. }
  326. /**
  327. * @ORM\Column(name="is_probably_bot_request", type="boolean", nullable=true)
  328. */
  329. private ?bool $isProbablyBotRequest;
  331. public function getIsProbablyBotRequest(): ?bool
  332. {
  333. return $this->isProbablyBotRequest;
  334. }
  336. public function setIsProbablyBotRequest(?bool $isProbablyBotRequest): void
  337. {
  338. $this->isProbablyBotRequest = $isProbablyBotRequest;
  339. }
  340. }