src/Entity/Finance/Proforma.php line 37

  1. <?php
  3. namespace App\Entity\Finance;
  5. use ApiPlatform\Metadata\ApiProperty;
  6. use ApiPlatform\Metadata\ApiResource;
  7. use App\Entity\Common;
  8. use App\Entity\Expediting\ShippingPlan;
  9. use App\Entity\Identity\User;
  10. use Doctrine\Common\Collections\ArrayCollection;
  11. use Doctrine\Common\Collections\Collection;
  12. use Doctrine\DBAL\Types\Types;
  13. use Doctrine\ORM\Mapping as ORM;
  14. use Gedmo\Mapping\Annotation as Gedmo;
  15. use Symfony\Component\Uid\Ulid;
  16. use Symfony\Component\Validator\Constraints as Assert;
  17. use Symfony\Component\Validator\Context\ExecutionContextInterface;
  19. #[ORM\Table(name: 'finance_invoice')]
  20. #[ORM\Index(columns: ['shipping_plan_id'], name: 'finance_invoice_shipping_plan_id_idx')]
  21. #[ORM\Index(columns: ['payable_by'], name: 'finance_invoice_payable_by_idx')]
  22. #[ORM\Index(columns: ['payable_to'], name: 'finance_invoice_payable_to_idx')]
  23. #[ORM\Index(columns: ['created_by'], name: 'finance_invoice_created_by_idx')]
  24. #[ORM\Index(columns: ['updated_by'], name: 'finance_invoice_updated_by_idx')]
  25. #[ORM\UniqueConstraint(name: 'finance_invoice_number_key', columns: ['number'])]
  26. #[ORM\UniqueConstraint(name: 'finance_invoice_external_reference_key', columns: ['external_reference'])]
  27. #[ORM\UniqueConstraint(name: 'finance_invoice_original_quote_id_key', columns: ['original_quote_id'])]
  28. #[ORM\UniqueConstraint(name: 'finance_invoice_identifier_key', columns: ['identifier'])]
  29. #[ORM\InheritanceType('SINGLE_TABLE')]
  30. #[ORM\DiscriminatorColumn(name: 'type')]
  31. #[ORM\DiscriminatorMap([
  32.     'INVOICE' => Invoice::class,
  33.     'PROFORMA' => Proforma::class,
  34. ])]
  35. #[ORM\Entity]
  36. #[ApiResource(routePrefix: '/finance')]
  37. class Proforma
  38. {
  39.     use Quoteable;
  40.     use Common\Blameable;
  41.     use Common\Trackable;
  43.     #[ORM\Id]
  44.     #[ORM\GeneratedValue(strategy: 'IDENTITY')]
  45.     #[ORM\SequenceGenerator(sequenceName: 'finance_invoice_id_seq')]
  46.     #[ORM\Column(type: Types::INTEGER)]
  47.     #[ApiProperty(identifier: false)]
  48.     protected ?int $id = null;
  50.     #[Assert\Ulid]
  51.     #[Assert\NotNull]
  52.     #[ORM\Column(type: 'ulid', unique: true)]
  53.     #[ApiProperty(identifier: true)]
  54.     protected ?Ulid $identifier = null;
  56.     #[Assert\Type(type: ShippingPlan::class)]
  57.     #[ORM\ManyToOne(targetEntity: ShippingPlan::class, inversedBy: 'proformas')]
  58.     #[ORM\JoinColumn(name: 'shipping_plan_id', nullable: false)]
  59.     protected ?ShippingPlan $shippingPlan = null;
  61.     #[Assert\Type(type: Proforma::class)]
  62.     #[ORM\ManyToOne(targetEntity: Proforma::class, inversedBy: 'editions')]
  63.     #[ORM\JoinColumn(name: 'original_quote_id')]
  64.     protected ?Proforma $originalForm = null;
  66.     #[ORM\OneToMany(mappedBy: 'originalForm', targetEntity: Proforma::class)]
  67.     protected Collection $editions;
  69.     /** @var Collection<int, Collectable> */
  70.     #[ORM\OneToMany(mappedBy: 'form', targetEntity: Collectable::class, cascade: ['persist', 'remove'])]
  71.     protected Collection $collectables;
  73.     /** @var Collection<int, Tax> */
  74.     #[ORM\OneToMany(mappedBy: 'invoice', targetEntity: Tax::class, cascade: ['persist', 'remove'])]
  75.     protected Collection $taxes;
  77.     #[Gedmo\Blameable(on: 'create')]
  78.     #[ORM\ManyToOne(targetEntity: User::class)]
  79.     #[ORM\JoinColumn(name: 'created_by')]
  80.     protected ?User $createdBy = null;
  82.     public function __construct()
  83.     {
  84.         $this->identifier = new Ulid();
  85.         $this->collectables = new ArrayCollection();
  86.         $this->taxes = new ArrayCollection();
  87.         $this->editions = new ArrayCollection();
  88.     }
  90.     #[Assert\Callback]
  91.     public function validate(ExecutionContextInterface $context, $payload): void
  92.     {
  93.         if (empty($this->workOrder) && empty($this->shipment)) {
  94.             $context->buildViolation('Invoice must be associated only with either, a work order, or a shipment')
  95.                 ->atPath('workOrder')
  96.                 ->addViolation();
  98.             $context->buildViolation('Invoice must be associated only with either, a work order, or a shipment')
  99.                 ->atPath('shipment')
  100.                 ->addViolation();
  101.         }
  102.     }
  104.     public function getId(): ?int
  105.     {
  106.         return $this->id;
  107.     }
  109.     public function getIdentifier(): ?Ulid
  110.     {
  111.         return $this->identifier;
  112.     }
  114.     public function setIdentifier($identifier): self
  115.     {
  116.         $this->identifier = $identifier;
  118.         return $this;
  119.     }
  121.     public function getShippingPlan(): ?ShippingPlan
  122.     {
  123.         return $this->shippingPlan;
  124.     }
  126.     public function setShippingPlan(?ShippingPlan $shippingPlan): self
  127.     {
  128.         $this->shippingPlan = $shippingPlan;
  130.         return $this;
  131.     }
  133.     public function getOriginalForm(): ?self
  134.     {
  135.         return $this->originalForm;
  136.     }
  138.     public function setOriginalForm(?self $originalForm): self
  139.     {
  140.         $form = $originalForm;
  141.         while ($form?->getOriginalForm() instanceof Proforma) {
  142.             $form = $form->getOriginalForm();
  143.         }
  144.         $this->originalForm = $form;
  146.         return $this;
  147.     }
  149.     /**
  150.      * @return Collection<int, Proforma>
  151.      */
  152.     public function getEditions(): Collection
  153.     {
  154.         return $this->editions;
  155.     }
  157.     public function addEdition(Proforma $edition): self
  158.     {
  159.         if (!$this->editions->contains($edition)) {
  160.             $this->editions->add($edition);
  161.             $edition->setOriginalForm($this);
  162.         }
  164.         return $this;
  165.     }
  167.     public function removeEdition(Proforma $edition): self
  168.     {
  169.         if ($this->editions->removeElement($edition)) {
  170.             // set the owning side to null (unless already changed)
  171.             if ($edition->getOriginalForm() === $this) {
  172.                 $edition->setOriginalForm(null);
  173.             }
  174.         }
  176.         return $this;
  177.     }
  179.     /**
  180.      * @return Collection<int, Collectable>
  181.      */
  182.     public function getCollectables(): Collection
  183.     {
  184.         return $this->collectables;
  185.     }
  187.     public function addCollectable(Collectable $collectable): self
  188.     {
  189.         if (!$this->collectables->contains($collectable)) {
  190.             $this->collectables->add($collectable);
  191.             $collectable->setForm($this);
  192.         }
  194.         return $this;
  195.     }
  197.     public function removeCollectable(Collectable $collectable): self
  198.     {
  199.         if ($this->collectables->removeElement($collectable)) {
  200.             // set the owning side to null (unless already changed)
  201.             if ($collectable->getForm() === $this) {
  202.                 $collectable->setForm(null);
  203.             }
  204.         }
  206.         return $this;
  207.     }
  209.     /**
  210.      * @return Collection<int, Tax>
  211.      */
  212.     public function getTaxes(): Collection
  213.     {
  214.         return $this->taxes;
  215.     }
  217.     public function addTax(Tax $tax): self
  218.     {
  219.         if (!$this->taxes->contains($tax)) {
  220.             $this->taxes->add($tax);
  221.             $tax->setInvoice($this);
  222.         }
  224.         return $this;
  225.     }
  227.     public function removeTax(Tax $tax): self
  228.     {
  229.         if ($this->taxes->removeElement($tax)) {
  230.             // set the owning side to null (unless already changed)
  231.             if ($tax->getInvoice() === $this) {
  232.                 $tax->setInvoice(null);
  233.             }
  234.         }
  236.         return $this;
  237.     }
  238. }