src/Entity/Voucher.php line 26

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Constants\ActiveConstants;
  6. use App\Constants\VoucherConstants;
  7. use App\Repository\VoucherRepository;
  8. use App\Traits\TimeTrackTrait;
  9. use Doctrine\Common\Collections\ArrayCollection;
  10. use Doctrine\Common\Collections\Collection;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  13. use Symfony\Component\Validator\Constraints as Assert;
  14. use Symfony\Component\Validator\Context\ExecutionContextInterface;
  15. use Symfony\Contracts\Translation\TranslatorInterface;
  16. use App\Validator\Constraints as AppAssert;
  18. #[ORM\Entity(repositoryClass: VoucherRepository::class)]
  19. #[ORM\Table(name: 'voucher')]
  20. #[ORM\HasLifecycleCallbacks]
  21. #[ORM\EntityListeners(["App\EventListener\VoucherCodeGeneratorListener"])]
  22. #[UniqueEntity(
  23.     fields: ['code'],
  24.     message: 'Такий код вже використовується.'
  25. )]
  26. class Voucher
  27. {
  28.     use TimeTrackTrait;
  30.     #[ORM\Id]
  31.     #[ORM\GeneratedValue]
  32.     #[ORM\Column]
  33.     private ?int $id = null;
  35.     #[ORM\Column(length: 255)]
  36.     #[Assert\NotBlank(message: 'Поле "Назва" є обов’язковим.')]
  37.     private string $name;
  39.     #[ORM\Column(length: 50, nullable: true, unique: true, options: ['collation' => 'utf8mb4_bin'])]
  40.     #[AppAssert\UniqueVoucherCode]
  41.     private ?string $code = null;
  43.     #[ORM\Column(length: 50)]
  44.     #[Assert\NotBlank(message: 'Оберіть тип знижки.')]
  45.     private string $type;
  47.     #[ORM\Column(length: 50, name: "voucher_type")]
  48.     private string $voucherType = VoucherConstants::VOUCHER_SINGLE;
  50.     #[ORM\Column(type: "decimal", precision: 10, scale: 2)]
  51.     #[Assert\NotBlank(message: 'Вкажіть суму знижки.')]
  52.     #[Assert\Positive(message: 'Сума знижки повинна бути більшою за 0.')]
  53.     private float $value;
  55.     #[ORM\Column(type: "datetime", nullable: true, name: "start_at")]
  56.     private ?\DateTimeInterface $startAt = null;
  58.     #[ORM\Column(type: "datetime", nullable: true, name: "expires_at")]
  59.     #[Assert\Expression(
  60.         "this.getExpiresAt() === null or this.getStartAt() === null or this.getExpiresAt() > this.getStartAt()",
  61.         message: "Дата закінчення повинна бути пізнішою за дату початку."
  62.     )]
  63.     private ?\DateTimeInterface $expiresAt = null;
  65.     #[ORM\Column(type: "boolean")]
  66.     private bool $active = true;
  68.     #[ORM\Column(type: "integer", nullable: true, name: "usage_per_user")]
  69.     private ?int $usagePerUser = null;
  71.     #[ORM\Column(type: "text", nullable: true)]
  72.     private ?string $description = null;
  74.     #[ORM\OneToMany(mappedBy: "voucher", targetEntity: VoucherCode::class, cascade: ["persist", "remove"], orphanRemoval: true)]
  75.     private Collection $codes;
  76.     #[ORM\OneToMany(mappedBy: 'voucher', targetEntity: Order::class)]
  77.     private Collection $orders;
  79.     #[ORM\ManyToMany(targetEntity: Company::class)]
  80.     #[ORM\JoinTable(
  81.         name: 'voucher_company',
  82.         joinColumns: [new ORM\JoinColumn(name: 'voucher_id', referencedColumnName: 'id', onDelete: 'CASCADE')],
  83.         inverseJoinColumns: [new ORM\JoinColumn(name: 'company_id', referencedColumnName: 'id', onDelete: 'CASCADE')]
  84.     )]
  85.     private Collection $companies;
  87.     #[ORM\ManyToMany(targetEntity: Tariff::class)]
  88.     #[ORM\JoinTable(
  89.         name: 'voucher_tariff',
  90.         joinColumns: [new ORM\JoinColumn(name: 'voucher_id', referencedColumnName: 'id', onDelete: 'CASCADE')],
  91.         inverseJoinColumns: [new ORM\JoinColumn(name: 'tariff_id', referencedColumnName: 'id', onDelete: 'CASCADE')]
  92.     )]
  93.     private Collection $tariffs;
  95.     private ?int $generatedCount = null;
  96.     private ?int $generatedLength = null;
  98.     public function __construct()
  99.     {
  100.         $this->companies = new ArrayCollection();
  101.         $this->tariffs = new ArrayCollection();
  102.         $this->orders = new ArrayCollection();
  103.         $this->codes = new ArrayCollection();
  104.     }
  106.     /**
  107.      * @return Collection<int, Order>
  108.      */
  109.     public function getOrders(): Collection
  110.     {
  111.         return $this->orders;
  112.     }
  114.     public function addOrder(Order $order): static
  115.     {
  116.         if (!$this->orders->contains($order)) {
  117.             $this->orders->add($order);
  118.             $order->setVoucher($this);
  119.         }
  121.         return $this;
  122.     }
  124.     public function removeOrder(Order $order): static
  125.     {
  126.         if ($this->orders->removeElement($order)) {
  127.             if ($order->getVoucher() === $this) {
  128.                 $order->setVoucher(null);
  129.             }
  130.         }
  132.         return $this;
  133.     }
  135.     public function getId(): ?int
  136.     {
  137.         return $this->id;
  138.     }
  140.     public function getName(): string
  141.     {
  142.         return $this->name;
  143.     }
  145.     public function setName(string $name): self
  146.     {
  147.         $this->name = $name;
  148.         return $this;
  149.     }
  151.     public function getCode(): ?string
  152.     {
  153.         return $this->code;
  154.     }
  156.     public function setCode(?string $code): self
  157.     {
  158.         if ($this->voucherType !== VoucherConstants::VOUCHER_GENERATED) {
  159.             $this->code = $code;
  160.         }
  162.         return $this;
  163.     }
  165.     public function getType(): string
  166.     {
  167.         return $this->type;
  168.     }
  170.     public function setType(string $type): self
  171.     {
  172.         $this->type = $type;
  173.         return $this;
  174.     }
  176.     public function getVoucherType(): string
  177.     {
  178.         return $this->voucherType;
  179.     }
  181.     public function setVoucherType(string $voucherType): self
  182.     {
  183.         $this->voucherType = $voucherType;
  184.         return $this;
  185.     }
  187.     public function getValue(): float
  188.     {
  189.         return $this->value;
  190.     }
  192.     public function setValue(float $value): self
  193.     {
  194.         $this->value = $value;
  195.         return $this;
  196.     }
  198.     public function getStartAt(): ?\DateTimeInterface
  199.     {
  200.         return $this->startAt;
  201.     }
  203.     public function setStartAt(?\DateTimeInterface $startAt): self
  204.     {
  205.         $this->startAt = $startAt;
  206.         return $this;
  207.     }
  209.     public function getExpiresAt(): ?\DateTimeInterface
  210.     {
  211.         return $this->expiresAt;
  212.     }
  214.     public function setExpiresAt(?\DateTimeInterface $expiresAt): self
  215.     {
  216.         $this->expiresAt = $expiresAt;
  217.         return $this;
  218.     }
  220.     public function isActive(): bool
  221.     {
  222.         return $this->active;
  223.     }
  225.     public function setActive(bool $active): self
  226.     {
  227.         $this->active = $active;
  228.         return $this;
  229.     }
  231.     public function getActiveLabel(): string
  232.     {
  233.         return $this->active ? ActiveConstants::LABEL_YES : ActiveConstants::LABEL_NO;
  234.     }
  236.     public function getTypeLabel(): string
  237.     {
  238.         $types = VoucherConstants::loadTypes();
  239.         return $types[$this->type] ?? $this->type;
  240.     }
  242.     public function getVoucherTypeLabel(): string
  243.     {
  244.         $types = VoucherConstants::loadVoucherTypes();
  245.         return $types[$this->voucherType] ?? $this->voucherType;
  246.     }
  248.     public function getUsagePerUser(): ?int
  249.     {
  250.         return $this->usagePerUser;
  251.     }
  253.     public function setUsagePerUser(?int $usagePerUser): self
  254.     {
  255.         $this->usagePerUser = $usagePerUser;
  256.         return $this;
  257.     }
  259.     public function getDescription(): ?string
  260.     {
  261.         return $this->description;
  262.     }
  264.     public function setDescription(?string $description): self
  265.     {
  266.         $this->description = $description;
  267.         return $this;
  268.     }
  270.     /**
  271.      * @return Collection<int, VoucherCode>
  272.      */
  273.     public function getCodes(): Collection
  274.     {
  275.         return $this->codes;
  276.     }
  278.     public function addCode(VoucherCode $code): self
  279.     {
  280.         if (!$this->codes->contains($code)) {
  281.             $this->codes[] = $code;
  282.             $code->setVoucher($this);
  283.         }
  284.         return $this;
  285.     }
  287.     public function removeCode(VoucherCode $code): self
  288.     {
  289.         if ($this->codes->removeElement($code)) {
  290.             if ($code->getVoucher() === $this) {
  291.                 $code->setVoucher(null);
  292.             }
  293.         }
  294.         return $this;
  295.     }
  298.     /**
  299.      * Set createdAt.
  300.      *
  301.      * @param \DateTime|null $createdAt
  302.      *
  303.      * @return Voucher
  304.      */
  305.     public function setCreatedAt($createdAt = null)
  306.     {
  307.         $this->createdAt = $createdAt;
  309.         return $this;
  310.     }
  312.     /**
  313.      * Get createdAt.
  314.      *
  315.      * @return \DateTime|null
  316.      */
  317.     public function getCreatedAt()
  318.     {
  319.         return $this->createdAt;
  320.     }
  322.     /**
  323.      * Set updatedAt.
  324.      *
  325.      * @param \DateTime|null $updatedAt
  326.      *
  327.      * @return Voucher
  328.      */
  329.     public function setUpdatedAt($updatedAt = null)
  330.     {
  331.         $this->updatedAt = $updatedAt;
  333.         return $this;
  334.     }
  336.     /**
  337.      * Get updatedAt.
  338.      *
  339.      * @return \DateTime|null
  340.      */
  341.     public function getUpdatedAt()
  342.     {
  343.         return $this->updatedAt;
  344.     }
  346.     public function getCompanies(): Collection
  347.     {
  348.         return $this->companies;
  349.     }
  351.     public function addCompany(Company $company): self
  352.     {
  353.         if (!$this->companies->contains($company)) {
  354.             $this->companies->add($company);
  355.         }
  356.         return $this;
  357.     }
  359.     public function removeCompany(Company $company): self
  360.     {
  361.         $this->companies->removeElement($company);
  362.         return $this;
  363.     }
  365.     public function getTariffs(): Collection
  366.     {
  367.         return $this->tariffs;
  368.     }
  370.     public function addTariff(Tariff $tariff): self
  371.     {
  372.         if (!$this->tariffs->contains($tariff)) {
  373.             $this->tariffs->add($tariff);
  374.         }
  375.         return $this;
  376.     }
  378.     public function removeTariff(Tariff $tariff): self
  379.     {
  380.         $this->tariffs->removeElement($tariff);
  381.         return $this;
  382.     }
  385.     public function getGeneratedCount(): ?int
  386.     {
  387.         return $this->generatedCount;
  388.     }
  390.     public function setGeneratedCount(?int $generatedCount): self
  391.     {
  392.         $this->generatedCount = $generatedCount;
  393.         return $this;
  394.     }
  396.     public function getGeneratedLength(): ?int
  397.     {
  398.         return $this->generatedLength;
  399.     }
  401.     public function setGeneratedLength(?int $generatedLength): self
  402.     {
  403.         $this->generatedLength = $generatedLength;
  404.         return $this;
  405.     }
  407.     #[Assert\Callback]
  408.     public function validateSingleVoucherFields(ExecutionContextInterface $context): void
  409.     {
  410.         if ($this->voucherType === VoucherConstants::VOUCHER_SINGLE) {
  411.             if (empty($this->code)) {
  412.                 $context->buildViolation('Поле "Код" є обов’язковим для Єдиного промокоду.')
  413.                     ->atPath('code')
  414.                     ->addViolation();
  415.             }
  417.             if (empty($this->usagePerUser) || $this->usagePerUser <= 0) {
  418.                 $context->buildViolation('Поле "Кількість використань на користувача" має бути більше 0 для Єдиного промокоду.')
  419.                     ->atPath('usagePerUser')
  420.                     ->addViolation();
  421.             }
  422.         }
  424.         if ($this->voucherType === VoucherConstants::VOUCHER_GENERATED) {
  425.             if (empty($this->generatedCount) || $this->generatedCount <= 0) {
  426.                 $context->buildViolation('Вкажіть кількість кодів для генерації.')
  427.                     ->atPath('generatedCount')
  428.                     ->addViolation();
  429.             }
  431.             if (empty($this->generatedLength) || $this->generatedLength <= 0) {
  432.                 $context->buildViolation('Вкажіть довжину промокоду для генерації.')
  433.                     ->atPath('generatedLength')
  434.                     ->addViolation();
  435.             }
  436.         }
  437.     }
  439.     public function applyTo(float $amount, TranslatorInterface $translator): array
  440.     {
  441.         $original = round($amount, 2, PHP_ROUND_HALF_DOWN);
  442.         $discount = 0;
  444.         if (!$this->isUsable()) {
  445.             return [
  446.                 'status' => 'error',
  447.                 'errors' => ['voucher' => $translator->trans('voucher_not_found', [], 'validators')],
  448.             ];
  449.         }
  451.         if ($this->getType() === VoucherConstants::TYPE_PERCENT) {
  452.             $discount = round($original * ($this->getValue() / 100.0), 2, PHP_ROUND_HALF_DOWN);
  453.         } elseif ($this->getType() === VoucherConstants::TYPE_FIXED) {
  454.             $discount = round($this->getValue(), 2, PHP_ROUND_HALF_DOWN);
  455.         }
  457.         $final = round($original - $discount, 2,PHP_ROUND_HALF_DOWN);
  459.         if ($discount >= $original || $final < 1) {
  460.             return [
  461.                 'status' => 'error',
  462.                 'errors' => ['voucher' => $translator->trans('voucher_not_found', [], 'validators')],
  463.             ];
  464.         }
  466.         return [
  467.             'status'        => 'ok',
  468.             'discount'      => $discount,
  469.             'name'          => $this->getName(),
  470.             'discount_type' => $this->getType(),
  471.             'price'         => $final,
  472.         ];
  473.     }
  475.     public function isExpired(): bool
  476.     {
  477.         return $this->expiresAt !== null && $this->expiresAt < new \DateTimeImmutable('now');
  478.     }
  480.     public function isNotStarted(): bool
  481.     {
  482.         return $this->startAt !== null && $this->startAt > new \DateTimeImmutable('now');
  483.     }
  485.     public function isUsable(): bool
  486.     {
  487.         return $this->isActive() && !$this->isExpired() && !$this->isNotStarted();
  488.     }
  491. }