src/App/Entity/Membership/BillwerkContract.php line 28

Open in your IDE?
  1. <?php
  3. namespace App\Entity\Membership;
  5. use App\Entity\User;
  6. use App\Utility\DateTimeUtility;
  7. use DateTime;
  8. use Doctrine\ORM\Mapping as ORM;
  9. use InvalidArgumentException;
  10. use Symfony\Component\Validator\Constraints as Assert;
  12. /**
  13. * Please keep direct usage of this class as low as possible. Instead,
  14. * use BillwerkSynchronizationService and MembershipService as facades.
  15. *
  16. * @ORM\Entity(repositoryClass="App\Repository\BillwerkContractRepository")
  17. *
  18. * @ORM\Table(
  19. * name="billwerk_contracts",
  20. * indexes={
  21. *
  22. * @ORM\Index(name="users_id_updated_at_idx", columns={"customer_id", "updated_at"})
  23. * }
  24. * )
  25. *
  26. * @ORM\HasLifecycleCallbacks()
  27. */
  28. class BillwerkContract
  29. {
  30. public const ACTIVE_LIFECYCLE_STATUS = [
  31. self::STATUS_ACTIVE,
  32. self::STATUS_TRIAL,
  33. self::STATUS_IN_ORDER_PROCESS,
  34. ];
  35. public const STATUS_ACTIVE = 'Active';
  36. public const STATUS_TRIAL = 'InTrial';
  37. public const STATUS_IN_ORDER_PROCESS = 'InOrderProcess';
  38. public const STATUS_CANCELLED = 'Cancelled';
  39. public const STATUS_PAUSED = 'Paused';
  41. /**
  42. * @var string
  43. *
  44. * @ORM\Column(name="id", type="string")
  45. *
  46. * @ORM\Id
  47. */
  48. private $id;
  50. public function setId(string $id)
  51. {
  52. $this->id = $id;
  53. }
  55. public function getId()
  56. {
  57. return $this->id;
  58. }
  60. /**
  61. * @var string
  62. *
  63. * @ORM\Column(name="customer_id", type="string", length=255, nullable=false)
  64. *
  65. * @Assert\NotBlank()
  66. *
  67. * @Assert\Length(
  68. * min = 24,
  69. * max = 255,
  70. * )
  71. */
  72. private $customerId;
  74. public function setCustomerId(string $customerId)
  75. {
  76. $this->customerId = $customerId;
  77. }
  79. public function getCustomerId()
  80. {
  81. return $this->customerId;
  82. }
  84. /**
  85. * @var string
  86. *
  87. * @ORM\Column(name="lifecycle_status", type="string", length=255, nullable=false)
  88. *
  89. * @Assert\NotBlank()
  90. */
  91. private $lifecycleStatus;
  93. public function setLifecycleStatus(string $lifecycleStatus): BillwerkContract
  94. {
  95. $this->lifecycleStatus = $lifecycleStatus;
  97. return $this;
  98. }
  100. public function getLifecycleStatus()
  101. {
  102. return $this->lifecycleStatus;
  103. }
  105. /**
  106. * @ORM\Column(name="plan_variant_id", type="string", length=255, nullable=true)
  107. */
  108. private ?string $planVariantId;
  110. public function setPlanVariantId(?string $planVariantId = null): void
  111. {
  112. $this->planVariantId = $planVariantId;
  113. }
  115. public function getPlanVariantId(): ?string
  116. {
  117. return $this->planVariantId;
  118. }
  120. /**
  121. * @var string
  122. *
  123. * @ORM\Column(name="recurring_fee", type="float", nullable=true)
  124. */
  125. private $recurringFee;
  127. public function setRecurringFee(?float $recurringFee = null)
  128. {
  129. $this->recurringFee = $recurringFee;
  130. }
  132. public function getRecurringFee()
  133. {
  134. return $this->recurringFee;
  135. }
  137. /**
  138. * @var string
  139. *
  140. * @ORM\Column(name="currency", type="string", nullable=false)
  141. */
  142. private $currency;
  144. public function setCurrency(string $currency)
  145. {
  146. $this->currency = $currency;
  147. }
  149. public function getCurrency()
  150. {
  151. return $this->currency;
  152. }
  154. /**
  155. * @var string
  156. *
  157. * @ORM\Column(name="payload", type="text", nullable=false)
  158. *
  159. * @Assert\NotBlank()
  160. */
  161. private $payload;
  163. public function setPayload(string $payload)
  164. {
  165. $this->payload = $payload;
  166. }
  168. public function getPayload()
  169. {
  170. return $this->payload;
  171. }
  173. /**
  174. * @ORM\Column(name="next_billing_at", type="datetime_microsecond", nullable=true)
  175. */
  176. private ?DateTime $nextBillingAt = null;
  178. public function getNextBillingAt(): ?DateTime
  179. {
  180. return $this->nextBillingAt;
  181. }
  183. public function setNextBillingAt(?DateTime $nextBillingAt = null): void
  184. {
  185. $this->nextBillingAt = $nextBillingAt;
  186. }
  188. /**
  189. * @ORM\Column(name="is_payment_escalated", type="boolean", nullable=false)
  190. */
  191. private $isPaymentEscalated = false;
  193. public function isPaymentEscalated(): bool
  194. {
  195. return $this->isPaymentEscalated;
  196. }
  198. public function setIsPaymentEscalated(bool $isPaymentEscalated)
  199. {
  200. $this->isPaymentEscalated = $isPaymentEscalated;
  201. }
  203. /**
  204. * @var DateTime
  205. *
  206. * @ORM\Column(name="created_at", type="datetime")
  207. */
  208. private $createdAt;
  210. /**
  211. * @ORM\PrePersist()
  212. */
  213. public function onCreate()
  214. {
  215. $this->setCreatedAt(DateTimeUtility::createDateTimeUtc());
  216. $this->setUpdatedAt(DateTimeUtility::createDateTimeUtc());
  217. }
  219. public function getCreatedAt(): DateTime
  220. {
  221. return $this->createdAt;
  222. }
  224. public function setCreatedAt(DateTime $createdAt): void
  225. {
  226. $this->createdAt = $createdAt;
  227. }
  229. /**
  230. * @var DateTime
  231. *
  232. * @ORM\Column(name="updated_at", type="datetime", nullable=false)
  233. */
  234. private $updatedAt;
  236. /**
  237. * @return DateTime
  238. */
  239. public function getUpdatedAt()
  240. {
  241. return $this->updatedAt;
  242. }
  244. public function setUpdatedAt(DateTime $updatedAt)
  245. {
  246. $this->updatedAt = $updatedAt;
  247. }
  249. /**
  250. * @ORM\PreUpdate()
  251. */
  252. public function onUpdate()
  253. {
  254. $this->setUpdatedAt(DateTimeUtility::createDateTimeUtc());
  255. }
  257. /**
  258. * @ORM\Column(name="last_synchronized_at", type="datetime", nullable=true)
  259. */
  260. private ?DateTime $lastSynchronizedAt;
  262. public function getLastSynchronizedAt(): ?DateTime
  263. {
  264. return $this->lastSynchronizedAt;
  265. }
  267. public function setLastSynchronizedAt(DateTime $lastSynchronizedAt): void
  268. {
  269. $this->lastSynchronizedAt = $lastSynchronizedAt;
  270. }
  272. /**
  273. * @ORM\Column(name="ongoing_proactive_sync_initiated_at", type="datetime", nullable=true)
  274. */
  275. private ?DateTime $ongoingProactiveSyncInitiatedAt;
  277. public function getOngoingProactiveSyncInitiatedAt(): ?DateTime
  278. {
  279. return $this->ongoingProactiveSyncInitiatedAt;
  280. }
  282. public function setOngoingProactiveSyncInitiatedAt(?DateTime $at): void
  283. {
  284. $this->ongoingProactiveSyncInitiatedAt = $at;
  285. }
  287. /**
  288. * @ORM\Column(name="number_of_consecutive_proactive_syncs_with_timeout", type="integer", nullable=false)
  289. */
  290. private int $numberOfProactiveSyncsWithTimeout = 0;
  292. public function getNumberOfConsecutiveProactiveSyncsWithTimeout(): int
  293. {
  294. return $this->numberOfProactiveSyncsWithTimeout;
  295. }
  297. public function incrementNumberOfConsecutiveProactiveSyncsWithTimeout(): void
  298. {
  299. ++$this->numberOfProactiveSyncsWithTimeout;
  300. }
  302. public function resetNumberOfConsecutiveProactiveSyncsWithTimeout(): void
  303. {
  304. $this->numberOfProactiveSyncsWithTimeout = 0;
  305. }
  307. /**
  308. * @var User
  309. *
  310. * @ORM\ManyToOne(targetEntity="App\Entity\User", inversedBy="billwerkContracts")
  311. *
  312. * @ORM\JoinColumn(name="users_id", onDelete="CASCADE")
  313. */
  314. private $user;
  316. public function getUser(): User
  317. {
  318. return $this->user;
  319. }
  321. public function setUser(User $user): void
  322. {
  323. $this->user = $user;
  324. }
  326. /**
  327. * @var bool
  328. *
  329. * @ORM\Column(type="boolean")
  330. */
  331. private $cancelled = false;
  333. public function isCancelled(): bool
  334. {
  335. return $this->cancelled;
  336. }
  338. public function setCancelled(bool $cancelled)
  339. {
  340. $this->cancelled = $cancelled;
  341. }
  343. public function isActive(): bool
  344. {
  345. return in_array($this->lifecycleStatus, self::ACTIVE_LIFECYCLE_STATUS);
  346. }
  348. public function isPaused(): bool
  349. {
  350. return $this->lifecycleStatus === self::STATUS_PAUSED;
  351. }
  353. public function __toString()
  354. {
  355. return (string)$this->getId();
  356. }
  358. /**
  359. * The follow up billwerk contract is the specific billwerk contract which is booked when the user enters into another
  360. * contract while having another currently active billwerk contract.
  361. * For example if the user upgrades its basic membership to a premium membership the premium membership billwerk contract
  362. * is considered to be the follow up billwerk contract for the previous active basic membership billwerk contract.
  363. * On the other hand, if a user ends its current billwerk contract with a membership cancellation and then, a few weeks or
  364. * even a minute later signs up for a new membership, the new billwerk contract is not considered a follow up billwerk contract.
  365. *
  366. * @ORM\ManyToOne(targetEntity="App\Entity\Membership\BillwerkContract", cascade={"persist"})
  367. *
  368. * @ORM\JoinColumn(name="follow_up_billwerk_contracts_id", referencedColumnName="id", onDelete="SET NULL")
  369. */
  370. private ?BillwerkContract $followUpBillwerkContract = null;
  372. public function getFollowUpBillwerkContract(): ?BillwerkContract
  373. {
  374. return $this->followUpBillwerkContract;
  375. }
  377. public function setFollowUpBillwerkContract(?BillwerkContract $followUpBillwerkContract)
  378. {
  379. if (!is_null($followUpBillwerkContract)) {
  380. if ($followUpBillwerkContract->getId() === $this->id) {
  381. throw new InvalidArgumentException("Cannot set follow up billwerk contract for billwerk contract {$this->id}, because the follow up billwerk contract and this billwerk contract are identical.");
  382. }
  383. }
  384. $this->followUpBillwerkContract = $followUpBillwerkContract;
  385. }
  386. }