src/App/Entity/Membership/BillwerkComponentSubscription.php line 24

Open in your IDE?
  1. <?php
  3. namespace App\Entity\Membership;
  5. use App\Enum\Billwerk\ComponentContext;
  6. use App\Utility\ReflectionHelper;
  7. use DateTime;
  8. use Doctrine\ORM\Mapping as ORM;
  9. use InvalidArgumentException;
  10. use JanusHercules\SelfServiceTrafficCampaign\Domain\Entity\SelfServiceTrafficCampaignBooking;
  11. use LogicException;
  13. /**
  14. * @ORM\Entity()
  15. *
  16. * @ORM\Table(
  17. * name="billwerk_component_subscriptions"
  18. * )
  19. *
  20. * Note that this entity is actually used to represent two different Billwerk entities: component subscriptions and usages,
  21. * which are very similar in nature but not the same things. Component subscriptions are used to back the recurrent job bookings
  22. * while the user's contract is in trial, and upon renewal, usages are used to back the recurrent job bookings.
  23. */
  24. class BillwerkComponentSubscription
  25. {
  26. public const COMPONENT_SUBSCRIPTION_TYPE_COMPONENT_SUBSCRIPTION = 0;
  27. public const COMPONENT_SUBSCRIPTION_TYPE_USAGE_COMPONENT = 1;
  29. public function __construct(
  30. int $type,
  31. string $id,
  32. BillwerkContract $billwerkContract,
  33. string $componentId,
  34. DateTime $startDate,
  35. DateTime $endDate,
  36. ?RecurrentJobBooking $recurrentJobBooking = null,
  37. ?SelfServiceTrafficCampaignBooking $selfServiceTrafficCampaignBooking = null,
  38. bool $includedInInterimBilling = false
  39. ) {
  40. if (!ReflectionHelper::hasConstWithValue(self::class, 'COMPONENT_SUBSCRIPTION_TYPE_', $type)) {
  41. throw new InvalidArgumentException("No component subscription type for value '$type'.");
  42. }
  44. if (is_null($recurrentJobBooking) && is_null($selfServiceTrafficCampaignBooking)) {
  45. throw new InvalidArgumentException('Either recurrentJobBooking or selfServiceTrafficCampaignBooking must be provided.');
  46. }
  48. if (!is_null($recurrentJobBooking) && !is_null($selfServiceTrafficCampaignBooking)) {
  49. throw new InvalidArgumentException('Cannot provide both recurrentJobBooking and selfServiceTrafficCampaignBooking.');
  50. }
  52. $this->type = $type;
  53. $this->id = $id;
  54. $this->billwerkContract = $billwerkContract;
  55. $this->componentId = $componentId;
  56. $this->startDate = $startDate;
  57. $this->endDate = $endDate;
  58. $this->recurrentJobBooking = $recurrentJobBooking;
  59. $this->selfServiceTrafficCampaignBooking = $selfServiceTrafficCampaignBooking;
  60. $this->includedInInterimBilling = $includedInInterimBilling;
  61. }
  63. /**
  64. * @ORM\Column(name="id", type="string")
  65. *
  66. * @ORM\Id
  67. */
  68. private string $id;
  70. public function getId(): string
  71. {
  72. return $this->id;
  73. }
  75. /**
  76. * @ORM\ManyToOne(targetEntity="App\Entity\Membership\BillwerkContract")
  77. *
  78. * @ORM\JoinColumn(name="billwerk_contracts_id", onDelete="CASCADE", nullable=false)
  79. */
  80. private BillwerkContract $billwerkContract;
  82. /**
  83. * @ORM\ManyToOne(targetEntity="App\Entity\Membership\RecurrentJobBooking", inversedBy="billwerkComponentSubscriptions", cascade={"persist"})
  84. *
  85. * @ORM\JoinColumn(name="recurrent_job_bookings_id", onDelete="CASCADE", nullable=true)
  86. */
  87. private ?RecurrentJobBooking $recurrentJobBooking;
  89. public function getRecurrentJobBooking(): ?RecurrentJobBooking
  90. {
  91. return $this->recurrentJobBooking;
  92. }
  94. /**
  95. * @ORM\OneToOne(targetEntity="JanusHercules\SelfServiceTrafficCampaign\Domain\Entity\SelfServiceTrafficCampaignBooking", inversedBy="billwerkComponentSubscription")
  96. *
  97. * @ORM\JoinColumn(name="self_service_traffic_campaign_bookings_id", onDelete="CASCADE", nullable=true)
  98. */
  99. private ?SelfServiceTrafficCampaignBooking $selfServiceTrafficCampaignBooking;
  101. public function getSelfServiceTrafficCampaignBooking(): ?SelfServiceTrafficCampaignBooking
  102. {
  103. return $this->selfServiceTrafficCampaignBooking;
  104. }
  106. /**
  107. * @ORM\Column(name="component_id", type="string", length=255, nullable=false)
  108. */
  109. private string $componentId;
  111. public function getComponentId(): string
  112. {
  113. return $this->componentId;
  114. }
  116. /**
  117. * @ORM\Column(name="start_date", type="datetime")
  118. */
  119. private DateTime $startDate;
  121. public function getStartDate(): DateTime
  122. {
  123. return $this->startDate;
  124. }
  126. /**
  127. * @ORM\Column(name="end_date", type="datetime")
  128. */
  129. private DateTime $endDate;
  131. public function getEndDate(): DateTime
  132. {
  133. return $this->endDate;
  134. }
  136. public function setEndDate(DateTime $endDate): void
  137. {
  138. $this->endDate = $endDate;
  139. }
  141. /**
  142. * @ORM\Column(name="type", type="integer", nullable=false)
  143. */
  144. private int $type;
  146. public function getType(): int
  147. {
  148. return $this->type;
  149. }
  151. /**
  152. * @ORM\Column(name="included_in_interim_billing", type="boolean", nullable=false)
  153. */
  154. private bool $includedInInterimBilling;
  156. public function isIncludedInInterimBilling(): bool
  157. {
  158. return $this->includedInInterimBilling;
  159. }
  161. public function setIsIncludedInInterimBilling(bool $includedInInterimBilling): void
  162. {
  163. $this->includedInInterimBilling = $includedInInterimBilling;
  164. }
  166. public function getComponentContext(): ComponentContext
  167. {
  168. if ($this->recurrentJobBooking !== null) {
  169. return ComponentContext::PLUS_RECURRENT_JOB;
  170. }
  172. if ($this->selfServiceTrafficCampaignBooking !== null) {
  173. return ComponentContext::SELF_SERVICE_TRAFFIC_CAMPAIGN;
  174. }
  176. throw new LogicException('Could not determine component context for BillwerkComponentSubscription: Neither a RecurrentJobBooking nor a SelfServiceTrafficCampaignBooking is set.');
  177. }
  178. }