src/Entity/Finance/BaseQuotation.php line 34

  1. <?php
  3. namespace App\Entity\Finance;
  5. use ApiPlatform\Metadata\ApiProperty;
  6. use App\Entity\Common;
  7. use App\Entity\Common\Observation;
  8. use App\Entity\Expediting\ShippingPlan;
  9. use Doctrine\Common\Collections\ArrayCollection;
  10. use Doctrine\Common\Collections\Collection;
  11. use Doctrine\DBAL\Types\Types;
  12. use Doctrine\ORM\Mapping as ORM;
  13. use Symfony\Component\Uid\Ulid;
  14. use Symfony\Component\Validator\Constraints as Assert;
  15. use Symfony\Component\Validator\Context\ExecutionContextInterface;
  17. #[ORM\Table(name: 'finance_bill')]
  18. #[ORM\Index(columns: ['original_bill_id'], name: 'finance_bill_original_bill_id_idx')]
  19. #[ORM\Index(columns: ['shipping_plan_id'], name: 'finance_bill_shipping_plan_id_idx')]
  20. #[ORM\Index(columns: ['payable_by'], name: 'finance_bill_payable_by_idx')]
  21. #[ORM\Index(columns: ['payable_to'], name: 'finance_bill_payable_to_idx')]
  22. #[ORM\Index(columns: ['created_by'], name: 'finance_bill_created_by_idx')]
  23. #[ORM\Index(columns: ['updated_by'], name: 'finance_bill_updated_by_idx')]
  24. #[ORM\UniqueConstraint(name: 'finance_bill_number_key', columns: ['number'])]
  25. #[ORM\UniqueConstraint(name: 'finance_bill_external_reference_key', columns: ['external_reference'])]
  26. #[ORM\UniqueConstraint(name: 'finance_bill_identifier_key', columns: ['identifier'])]
  27. #[ORM\InheritanceType('SINGLE_TABLE')]
  28. #[ORM\DiscriminatorColumn(name: 'type')]
  29. #[ORM\DiscriminatorMap([
  30.     'BILL' => Bill::class,
  31.     'QUOTATION' => Quotation::class,
  32. ])]
  33. #[ORM\Entity]
  34. Abstract class BaseQuotation
  35. {
  36.     use Quoteable;
  37.     use Common\Blameable;
  38.     use Common\Trackable;
  40.     #[ORM\Id]
  41.     #[ORM\GeneratedValue(strategy: 'IDENTITY')]
  42.     #[ORM\SequenceGenerator(sequenceName: 'finance_bill_id_seq')]
  43.     #[ORM\Column(type: Types::INTEGER)]
  44.     #[ApiProperty(identifier: false)]
  45.     protected ?int $id = null;
  47.     #[Assert\Ulid]
  48.     #[Assert\NotNull]
  49.     #[ORM\Column(type: 'ulid', unique: true)]
  50.     #[ApiProperty(identifier: true)]
  51.     protected ?Ulid $identifier = null;
  53.     #[Assert\Type(type: ShippingPlan::class)]
  54.     #[ORM\ManyToOne(targetEntity: ShippingPlan::class, inversedBy: 'quotations')]
  55.     #[ORM\JoinColumn(name: 'shipping_plan_id', nullable: false)]
  56.     #[ApiProperty(readableLink: true)]
  57.     protected ?ShippingPlan $shippingPlan = null;
  59.     #[Assert\Type(type: BaseQuotation::class)]
  60.     #[ORM\ManyToOne(targetEntity: BaseQuotation::class, inversedBy: 'editions')]
  61.     #[ORM\JoinColumn(name: 'original_bill_id')]
  62.     protected ?BaseQuotation $originalForm = null;
  64.     #[ORM\OneToMany(mappedBy: 'originalForm', targetEntity: BaseQuotation::class)]
  65.     protected Collection $editions;
  67.     /** @var Collection<int, Expense> */
  68.     #[ORM\OneToMany(mappedBy: 'form', targetEntity: Expense::class, cascade: ['persist', 'remove'], orphanRemoval: true)]
  69.     protected Collection $expenses;
  71.     /** @var Collection<int, Tax> */
  72.     #[ORM\OneToMany(mappedBy: 'quotation', targetEntity: Tax::class, cascade: ['persist', 'remove'], orphanRemoval: true)]
  73.     protected Collection $taxes;
  75.     /** @var Collection<int, Observation> */
  76.     #[ORM\OneToMany(mappedBy: 'quotation', targetEntity: Observation::class, cascade: ['persist', 'remove'])]
  77.     protected Collection $observations;
  79.     public function __construct()
  80.     {
  81.         $this->identifier = new Ulid();
  82.         $this->expenses = new ArrayCollection();
  83.         $this->taxes = new ArrayCollection();
  84.         $this->observations = new ArrayCollection();
  85.         $this->editions = new ArrayCollection();
  86.     }
  88.     #[Assert\Callback]
  89.     public function validate(ExecutionContextInterface $context, $payload): void
  90.     {
  91.         if (empty($this->workOrder) && empty($this->shipment)) {
  92.             $context->buildViolation('Quotation must be associated only with either, a work order, or a shipment')
  93.                 ->atPath('workOrder')
  94.                 ->addViolation();
  96.             $context->buildViolation('Quotation must be associated only with either, a work order, or a shipment')
  97.                 ->atPath('shipment')
  98.                 ->addViolation();
  99.         }
  100.     }
  102.     public function getId(): ?int
  103.     {
  104.         return $this->id;
  105.     }
  107.     public function getIdentifier(): ?Ulid
  108.     {
  109.         return $this->identifier;
  110.     }
  112.     public function setIdentifier($identifier): self
  113.     {
  114.         $this->identifier = $identifier;
  116.         return $this;
  117.     }
  119.     public function getShippingPlan(): ?ShippingPlan
  120.     {
  121.         return $this->shippingPlan;
  122.     }
  124.     public function setShippingPlan(?ShippingPlan $shippingPlan): self
  125.     {
  126.         $this->shippingPlan = $shippingPlan;
  128.         return $this;
  129.     }
  131.     public function getOriginalForm(): ?self
  132.     {
  133.         return $this->originalForm;
  134.     }
  136.     public function setOriginalForm(?self $originalForm): self
  137.     {
  138.         $form = $originalForm;
  139.         while ($form?->getOriginalForm() instanceof BaseQuotation) {
  140.             $form = $form->getOriginalForm();
  141.         }
  142.         $this->originalForm = $form;
  144.         return $this;
  145.     }
  147.     /**
  148.      * @return Collection<int, BaseQuotation>
  149.      */
  150.     public function getEditions(): Collection
  151.     {
  152.         return $this->editions;
  153.     }
  155.     public function addEdition(BaseQuotation $edition): self
  156.     {
  157.         if (!$this->editions->contains($edition)) {
  158.             $this->editions->add($edition);
  159.             $edition->setOriginalForm($this);
  160.         }
  162.         return $this;
  163.     }
  165.     public function removeEdition(BaseQuotation $edition): self
  166.     {
  167.         if ($this->editions->removeElement($edition)) {
  168.             // set the owning side to null (unless already changed)
  169.             if ($edition->getOriginalForm() === $this) {
  170.                 $edition->setOriginalForm(null);
  171.             }
  172.         }
  174.         return $this;
  175.     }
  177.     /**
  178.      * @return Collection<int, Expense>
  179.      */
  180.     public function getExpenses(): Collection
  181.     {
  182.         return $this->expenses;
  183.     }
  185.     public function addExpense(Expense $expense): self
  186.     {
  187.         if (!$this->expenses->contains($expense)) {
  188.             $this->expenses->add($expense);
  189.             $expense->setForm($this);
  190.         }
  192.         return $this;
  193.     }
  195.     public function removeExpense(Expense $expense): self
  196.     {
  197.         if ($this->expenses->removeElement($expense)) {
  198.             // set the owning side to null (unless already changed)
  199.             if ($expense->getForm() === $this) {
  200.                 $expense->setForm(null);
  201.             }
  202.         }
  204.         return $this;
  205.     }
  207.     /**
  208.      * @return Collection<int, Tax>
  209.      */
  210.     public function getTaxes(): Collection
  211.     {
  212.         return $this->taxes;
  213.     }
  215.     public function addTax(Tax $tax): self
  216.     {
  217.         if (!$this->taxes->contains($tax)) {
  218.             $this->taxes->add($tax);
  219.             $tax->setQuotation($this);
  220.         }
  222.         return $this;
  223.     }
  225.     public function removeTax(Tax $tax): self
  226.     {
  227.         if ($this->taxes->removeElement($tax)) {
  228.             // set the owning side to null (unless already changed)
  229.             if ($tax->getQuotation() === $this) {
  230.                 $tax->setQuotation(null);
  231.             }
  232.         }
  234.         return $this;
  235.     }
  237.     public function isFilled(): bool
  238.     {
  239.         return ($this->expenses->count() > 0);
  240.     }
  242.     /**
  243.      * @return Collection<int, Observation>
  244.      */
  245.     public function getObservations(): Collection
  246.     {
  247.         return $this->observations;
  248.     }
  250.     public function addObservation(Observation $observation): self
  251.     {
  252.         if (!$this->observations->contains($observation)) {
  253.             $this->observations->add($observation);
  254.             $observation->setQuotation($this);
  255.         }
  257.         return $this;
  258.     }
  260.     public function removeObservation(Observation $observation): self
  261.     {
  262.         if ($this->observations->removeElement($observation)) {
  263.             // set the owning side to null (unless already changed)
  264.             if ($observation->getQuotation() === $this) {
  265.                 $observation->setQuotation(null);
  266.             }
  267.         }
  269.         return $this;
  270.     }
  271. }