src/App/Entity/ExternalPartner/IntegratedExternalPartnerCustomerQuota.php line 19

Open in your IDE?
  1. <?php
  3. namespace App\Entity\ExternalPartner;
  5. use App\Entity\RecurrentJob;
  6. use App\Utility\DateTimeUtility;
  7. use DateTime;
  8. use Doctrine\Common\Collections\Collection;
  9. use Doctrine\ORM\Mapping as ORM;
  10. use Exception;
  12. /**
  13. * @ORM\Entity
  14. *
  15. * @ORM\Table(
  16. * name="integrated_external_partner_customer_quotas"
  17. * )
  18. */
  19. class IntegratedExternalPartnerCustomerQuota
  20. {
  21. public function __construct(IntegratedExternalPartnerCustomer $integratedExternalPartnerCustomer, DateTime $startDate, DateTime $endDate, int $totalQuota = 0, bool $isActive = false)
  22. {
  23. $this->integratedExternalPartnerCustomer = $integratedExternalPartnerCustomer;
  24. $this->totalQuota = $totalQuota;
  25. $this->endDate = $endDate;
  26. $this->startDate = $startDate;
  27. $this->usedQuota = 0;
  28. $this->isActive = $isActive;
  29. }
  31. /**
  32. * @var string
  33. *
  34. * @ORM\GeneratedValue(strategy="CUSTOM")
  35. *
  36. * @ORM\CustomIdGenerator(class="App\Utility\DatabaseIdGenerator")
  37. *
  38. * @ORM\Column(name="id", type="guid")
  39. *
  40. * @ORM\Id
  41. */
  42. protected $id;
  44. public function getId(): string
  45. {
  46. return $this->id;
  47. }
  49. /**
  50. * @var int
  51. *
  52. * @ORM\Column(name="total_quota", type="integer")
  53. */
  54. private $totalQuota;
  56. public function getTotalQuota(): int
  57. {
  58. return $this->totalQuota;
  59. }
  61. public function setTotalQuota(int $totalQuota): void
  62. {
  63. $this->totalQuota = $totalQuota;
  64. }
  66. /**
  67. * @var int
  68. *
  69. * @ORM\Column(name="used_quota", type="integer")
  70. */
  71. private $usedQuota;
  73. public function getUsedQuota(): int
  74. {
  75. return $this->usedQuota;
  76. }
  78. public function setUsedQuota(int $usedQuota): void
  79. {
  80. $this->usedQuota = $usedQuota;
  81. throw new Exception('Use IntegratedExternalPartnerCustomerService::increaseQuotaIfPossible/decreaseQuotaIfPossible or catch this exception if you really know what you are doing.');
  82. }
  84. /**
  85. * @var bool
  86. *
  87. * @ORM\Column(name="is_active", type="boolean")
  88. */
  89. private $isActive;
  91. public function getIsActive(): bool
  92. {
  93. return $this->isActive;
  94. }
  96. public function setIsActive(bool $isActive): void
  97. {
  98. $this->isActive = $isActive;
  99. }
  101. /**
  102. * @var DateTime
  103. *
  104. * @ORM\Column(name="end_date", type="datetime", nullable=false)
  105. */
  106. protected $endDate;
  108. public function setEndDate(DateTime $endDate): void
  109. {
  110. $this->endDate = $endDate;
  111. }
  113. public function getEndDate(): DateTime
  114. {
  115. return $this->endDate;
  116. }
  118. /**
  119. * @var DateTime
  120. *
  121. * @ORM\Column(name="start_date", type="datetime", nullable=false)
  122. */
  123. protected $startDate;
  125. public function setStartDate(DateTime $startDate): void
  126. {
  127. $this->startDate = $startDate;
  128. }
  130. public function getStartDate(): DateTime
  131. {
  132. return $this->startDate;
  133. }
  135. /**
  136. * @var IntegratedExternalPartnerCustomer
  137. *
  138. * @ORM\ManyToOne(targetEntity="App\Entity\ExternalPartner\IntegratedExternalPartnerCustomer", inversedBy="externalPartnerQuotas", cascade={"persist"})
  139. *
  140. * @ORM\JoinColumn(name="integrated_external_partner_customers_id", referencedColumnName="id", nullable=false, onDelete="CASCADE")
  141. */
  142. protected $integratedExternalPartnerCustomer;
  144. public function getIntegratedExternalPartnerCustomer(): IntegratedExternalPartnerCustomer
  145. {
  146. return $this->integratedExternalPartnerCustomer;
  147. }
  149. public function setIntegratedExternalPartnerCustomer(IntegratedExternalPartnerCustomer $integratedExternalPartnerCustomer): void
  150. {
  151. $this->integratedExternalPartnerCustomer = $integratedExternalPartnerCustomer;
  152. }
  154. public function getIsCurrent(): bool
  155. {
  156. if ($this->getIsInThePast()) {
  157. return false;
  158. } elseif ($this->getIsInTheFuture()) {
  159. return false;
  160. }
  162. return true;
  163. }
  165. public function getIsInThePast(): bool
  166. {
  167. if ($this->endDate < DateTimeUtility::createDateTimeUtc()) {
  168. return true;
  169. }
  171. return false;
  172. }
  174. public function getIsInTheFuture(): bool
  175. {
  176. if ($this->startDate > DateTimeUtility::createDateTimeUtc()) {
  177. return true;
  178. }
  180. return false;
  181. }
  183. /**
  184. * @var RecurrentJob|Collection
  185. *
  186. * @ORM\OneToMany(targetEntity="App\Entity\RecurrentJob", mappedBy="quota", cascade={"persist", "remove"})
  187. */
  188. protected $recurrentJobs;
  190. public function getRecurrentJobs(): ?Collection
  191. {
  192. return $this->recurrentJobs;
  193. }
  195. /**
  196. * @var DateTime
  197. *
  198. * @ORM\Column(name="last_warned_about_at", type="datetime", nullable=true)
  199. */
  200. protected $lastWarnedAboutAt;
  202. public function setLastWarnedAboutAt(?DateTime $lastWarnedAboutAt): void
  203. {
  204. $this->lastWarnedAboutAt = $lastWarnedAboutAt;
  205. }
  207. public function getLastWarnedAboutAt(): ?DateTime
  208. {
  209. return $this->lastWarnedAboutAt;
  210. }
  212. public function getRemainingQuota(): int
  213. {
  214. return $this->getTotalQuota() - $this->getUsedQuota();
  215. }
  216. }