src/Entity/Expediting/ShippingPlan.php line 68

  1. <?php
  3. namespace App\Entity\Expediting;
  5. use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
  6. use ApiPlatform\Metadata\ApiFilter;
  7. use ApiPlatform\Metadata\ApiProperty;
  8. use ApiPlatform\Metadata\ApiResource;
  9. use ApiPlatform\Metadata\Get;
  10. use ApiPlatform\Metadata\GetCollection;
  11. use ApiPlatform\Metadata\Link;
  12. use App\Doctrine\Type\Expediting\ShippingPlanStatus;
  13. use App\Doctrine\Type\Expediting\ShippingSegmentStatus;
  14. use App\Entity\Common as Common;
  15. use App\Entity\Finance\Bill;
  16. use App\Entity\Finance\Invoice;
  17. use App\Entity\Finance\Proforma;
  18. use App\Entity\Finance\BaseQuotation;
  19. use App\Entity\Sales\WorkOrder;
  20. use App\Entity\Scheduler\Task;
  21. use App\Provider\Expediting\ShippingPlansProvider;
  22. use App\Provider\Finance\ShippingPlanQuotationsProvider;
  23. use App\Validator\IsValidEnum\IsValidEnum;
  24. use Doctrine\Common\Collections\ArrayCollection;
  25. use Doctrine\Common\Collections\Collection;
  26. use Doctrine\DBAL\Types\Types;
  27. use Doctrine\ORM\Mapping as ORM;
  28. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  29. use Symfony\Component\Uid\Ulid;
  30. use Symfony\Component\Validator\Constraints as Assert;
  31. use Symfony\Component\Validator\Context\ExecutionContextInterface;
  33. #[ORM\Table(name: 'expediting_shipping_plan')]
  34. #[ORM\Index(columns: ['original_plan_id'], name: 'expediting_shipping_plan_original_plan_id_idx')]
  35. #[ORM\Index(columns: ['work_order_id'], name: 'expediting_shipping_plan_work_order_idx')]
  36. #[ORM\Index(columns: ['shipment_id'], name: 'expediting_shipping_plan_shipment_idx')]
  37. #[ORM\Index(columns: ['created_by'], name: 'expediting_shipping_plan_created_by_idx')]
  38. #[ORM\Index(columns: ['updated_by'], name: 'expediting_shipping_plan_updated_by_idx')]
  39. #[ORM\UniqueConstraint(name: 'expediting_shipping_plan_original_plan_id_key', columns: ['original_plan_id'])]
  40. #[ORM\UniqueConstraint(name: 'expediting_shipping_plan_identifier_key', columns: ['identifier'])]
  41. #[ORM\Entity]
  42. #[UniqueEntity(fields: ['identifier'])]
  43. #[ApiResource(
  44.     uriTemplate: '/work_orders/{slug}/shipping_plans',
  45.     operations: [
  46.         new GetCollection(provider: ShippingPlansProvider::class),
  47.     ],
  48.     uriVariables: [
  49.         'slug' => new Link(fromProperty: 'shippingPlans', fromClass: WorkOrder::class),
  50.     ],
  51. )]
  52. #[ApiResource(
  53.     operations: [
  54.         new Get(),
  55.         new GetCollection(order: ['id' => 'DESC'], provider: ShippingPlanQuotationsProvider::class),
  56.     ],
  57.     routePrefix: '/expediting',
  58. )]
  59. #[ApiFilter(SearchFilter::class, properties: [
  60.     'workOrder.reference' => 'ipartial',
  61.     'quotations.payableTo' => 'exact',
  62.     'quotations.status' => 'exact',
  63.     'quotations.type' => 'exact',
  64.     'tasks.status' => 'exact',
  65.     'tasks.type' => 'exact',
  66.     'status' => 'exact',
  67. ])]
  68. class ShippingPlan
  69. {
  70.     use Common\Blameable;
  71.     use Common\Trackable;
  73.     #[ORM\Id]
  74.     #[ORM\GeneratedValue(strategy: 'IDENTITY')]
  75.     #[ORM\SequenceGenerator(sequenceName: 'expediting_shipping_plan_id_seq')]
  76.     #[ORM\Column(type: Types::INTEGER)]
  77.     #[ApiProperty(identifier: false)]
  78.     private ?int $id = null;
  80.     #[Assert\Ulid]
  81.     #[Assert\NotNull]
  82.     #[ORM\Column(type: 'ulid', unique: true)]
  83.     #[ApiProperty(identifier: true)]
  84.     private ?Ulid $identifier = null;
  86.     #[Assert\NotNull]
  87.     #[IsValidEnum(enum: ShippingPlanStatus::class)]
  88.     #[ORM\Column(type: Types::STRING, enumType: ShippingPlanStatus::class, options: ['default' => 'DRAFTED'])]
  89.     private ?ShippingPlanStatus $status = ShippingPlanStatus::DRAFTED;
  91.     #[ORM\ManyToOne(targetEntity: WorkOrder::class, inversedBy: 'shippingPlans')]
  92.     #[ORM\JoinColumn(name: 'work_order_id')]
  93.     private ?WorkOrder $workOrder = null;
  95.     #[ORM\ManyToOne(targetEntity: Shipment::class, inversedBy: 'shippingPlans')]
  96.     #[ORM\JoinColumn(name: 'shipment_id')]
  97.     private ?Shipment $shipment = null;
  99.     /** @var Collection<int, BaseQuotation> */
  100.     #[ORM\OneToMany(mappedBy: 'shippingPlan', targetEntity: BaseQuotation::class)]
  101.     private Collection $quotations;
  103.     /** @var Collection<int, Proforma> */
  104.     #[ORM\OneToMany(mappedBy: 'shippingPlan', targetEntity: Proforma::class)]
  105.     private Collection $proformas;
  107.     #[Assert\Type(type: ShippingPlan::class)]
  108.     #[ORM\OneToOne(targetEntity: ShippingPlan::class)]
  109.     #[ORM\JoinColumn(name: 'original_plan_id')]
  110.     private ?ShippingPlan $originalPlan = null;
  112.     /** @var Collection<int, ShippingSegment> */
  113.     #[ORM\OneToMany(mappedBy: 'shippingPlan', targetEntity: ShippingSegment::class, cascade: ['persist', 'remove'], orphanRemoval: true)]
  114.     #[ORM\OrderBy(['id' => 'ASC'])]
  115.     #[ApiProperty(readableLink: true)]
  116.     private Collection $shippingSegments;
  118.     /** @var Collection<int, Task> */
  119.     #[ORM\ManyToMany(targetEntity: Task::class, mappedBy: 'shippingPlans')]
  120.     private Collection $tasks;
  122.     #[Assert\Callback]
  123.     public function validate(ExecutionContextInterface $context, $payload): void
  124.     {
  125.         if (empty($this->workOrder) && empty($this->shipment)) {
  126.             $context->buildViolation('Shipping plan must be associated only with either, a work order, or a shipment')
  127.                 ->atPath('workOrder')
  128.                 ->addViolation();
  130.             $context->buildViolation('Shipping plan must be associated only with either, a work order, or a shipment')
  131.                 ->atPath('shipment')
  132.                 ->addViolation();
  133.         }
  134.     }
  136.     public function __construct()
  137.     {
  138.         $this->identifier = new Ulid();
  139.         $this->proformas = new ArrayCollection();
  140.         $this->quotations = new ArrayCollection();
  141.         $this->shippingSegments = new ArrayCollection();
  142.         $this->tasks = new ArrayCollection();
  143.     }
  145.     public function getId(): ?int
  146.     {
  147.         return $this->id;
  148.     }
  150.     public function getIdentifier(): ?Ulid
  151.     {
  152.         return $this->identifier;
  153.     }
  155.     public function setIdentifier(Ulid $identifier): self
  156.     {
  157.         $this->identifier = $identifier;
  159.         return $this;
  160.     }
  162.     public function getStatus(): ?ShippingPlanStatus
  163.     {
  164.         return $this->status;
  165.     }
  167.     public function setStatus(?ShippingPlanStatus $status): self
  168.     {
  169.         $this->status = $status;
  171.         return $this;
  172.     }
  174.     public function getWorkOrder(): ?WorkOrder
  175.     {
  176.         return $this->workOrder;
  177.     }
  179.     public function setWorkOrder(?WorkOrder $workOrder): static
  180.     {
  181.         $this->workOrder = $workOrder;
  183.         return $this;
  184.     }
  186.     public function getShipment(): ?Shipment
  187.     {
  188.         return $this->shipment;
  189.     }
  191.     public function setShipment(?Shipment $shipment): static
  192.     {
  193.         $this->shipment = $shipment;
  195.         return $this;
  196.     }
  198.     /**
  199.      * @return Collection<int, Package>
  200.      */
  201.     public function getPackages(): Collection
  202.     {
  203.         return (null !== $this->workOrder)
  204.             ? $this->workOrder->getPackages()
  205.             : $this->shipment->getPackages();
  206.     }
  208.     public function getOriginalPlan(): ?self
  209.     {
  210.         return $this->originalPlan;
  211.     }
  213.     public function setOriginalPlan(?self $originalPlan): self
  214.     {
  215.         $this->originalPlan = $originalPlan;
  217.         return $this;
  218.     }
  220.     /**
  221.      * @return Collection<int, ShippingSegment>
  222.      */
  223.     public function getShippingSegments(): Collection
  224.     {
  225.         return $this->shippingSegments;
  226.     }
  228.     public function getCurrentSegment(): ?ShippingSegment
  229.     {
  230.         if (!in_array($this->status, [ShippingPlanStatus::DRAFTED, ShippingPlanStatus::QUOTED, ShippingPlanStatus::APPROVED])) {
  231.             return null;
  232.         }
  234.         foreach ($this->shippingSegments as $segment) {
  235.             if (in_array($segment->getStatus(), [ShippingSegmentStatus::COMPLETED, ShippingPlanStatus::CANCELED])) {
  236.                 continue;
  237.             }
  239.             return $segment;
  240.         }
  242.         return null;
  243.     }
  245.     public function addShippingSegment(ShippingSegment $shippingSegment): self
  246.     {
  247.         if (!$this->shippingSegments->contains($shippingSegment)) {
  248.             $this->shippingSegments->add($shippingSegment);
  249.             $shippingSegment->setShippingPlan($this);
  250.         }
  252.         return $this;
  253.     }
  255.     public function removeShippingSegment(ShippingSegment $shippingSegment): self
  256.     {
  257.         if ($this->shippingSegments->removeElement($shippingSegment)) {
  258.             // set the owning side to null (unless already changed)
  259.             if ($shippingSegment->getShippingPlan() === $this) {
  260.                 $shippingSegment->setShippingPlan(null);
  261.             }
  262.         }
  264.         return $this;
  265.     }
  267.     /**
  268.      * @return Collection<int, BaseQuotation>
  269.      */
  270.     public function getQuotations(): Collection
  271.     {
  272.         $quotations = new ArrayCollection();
  273.         foreach ($this->quotations as $entity) {
  274.             if (!$entity instanceof Bill) {
  275.                 $quotations->add($entity);
  276.             }
  277.         }
  279.         return $quotations;
  280.     }
  282.     public function addQuotation(BaseQuotation $quotation): self
  283.     {
  284.         if (!$this->quotations->contains($quotation)) {
  285.             $this->quotations->add($quotation);
  286.             $quotation->setShippingPlan($this);
  287.         }
  289.         return $this;
  290.     }
  292.     public function removeQuotation(BaseQuotation $quotation): self
  293.     {
  294.         if ($this->quotations->removeElement($quotation)) {
  295.             // set the owning side to null (unless already changed)
  296.             if ($quotation->getShippingPlan() === $this) {
  297.                 $quotation->setShippingPlan(null);
  298.             }
  299.         }
  301.         return $this;
  302.     }
  304.     /**
  305.      * @return Collection<int, Bill>
  306.      */
  307.     public function getBills(): Collection
  308.     {
  309.         $bills = new ArrayCollection();
  310.         foreach ($this->quotations as $entity) {
  311.             if ($entity instanceof Bill) {
  312.                 $bills->add($entity);
  313.             }
  314.         }
  316.         return $bills;
  317.     }
  319.     public function addBill(Bill $bill): self
  320.     {
  321.         if (!$this->quotations->contains($bill)) {
  322.             $this->quotations->add($bill);
  323.             $bill->setShippingPlan($this);
  324.         }
  326.         return $this;
  327.     }
  329.     public function removeBill(Bill $bill): self
  330.     {
  331.         if ($this->quotations->removeElement($bill)) {
  332.             // set the owning side to null (unless already changed)
  333.             if ($bill->getShippingPlan() === $this) {
  334.                 $bill->setShippingPlan(null);
  335.             }
  336.         }
  338.         return $this;
  339.     }
  341.     /**
  342.      * @return Collection<int, Proforma>
  343.      */
  344.     public function getProformas(): Collection
  345.     {
  346.         $proformas = new ArrayCollection();
  347.         foreach ($this->proformas as $entity) {
  348.             if (!$entity instanceof Invoice) {
  349.                 $proformas->add($entity);
  350.             }
  351.         }
  353.         return $proformas;
  354.     }
  356.     public function addProforma(Proforma $proforma): self
  357.     {
  358.         if (!$this->proformas->contains($proforma)) {
  359.             $this->proformas->add($proforma);
  360.             $proforma->setShippingPlan($this);
  361.         }
  363.         return $this;
  364.     }
  366.     public function removeProforma(Proforma $proforma): self
  367.     {
  368.         if ($this->proformas->removeElement($proforma)) {
  369.             // set the owning side to null (unless already changed)
  370.             if ($proforma->getShippingPlan() === $this) {
  371.                 $proforma->setShippingPlan(null);
  372.             }
  373.         }
  375.         return $this;
  376.     }
  378.     /**
  379.      * @return Collection<int, Bill>
  380.      */
  381.     public function getInvoices(): Collection
  382.     {
  383.         $invoices = new ArrayCollection();
  384.         foreach ($this->proformas as $entity) {
  385.             if ($entity instanceof Bill) {
  386.                 $invoices->add($entity);
  387.             }
  388.         }
  390.         return $invoices;
  391.     }
  393.     public function addInvoice(Invoice $invoice): self
  394.     {
  395.         if (!$this->proformas->contains($invoice)) {
  396.             $this->proformas->add($invoice);
  397.             $invoice->setShippingPlan($this);
  398.         }
  400.         return $this;
  401.     }
  403.     public function removeInvoice(Invoice $invoice): self
  404.     {
  405.         if ($this->proformas->removeElement($invoice)) {
  406.             // set the owning side to null (unless already changed)
  407.             if ($invoice->getShippingPlan() === $this) {
  408.                 $invoice->setShippingPlan(null);
  409.             }
  410.         }
  412.         return $this;
  413.     }
  415.     /**
  416.      * @return Collection<int, Task>
  417.      */
  418.     public function getTasks(): Collection
  419.     {
  420.         return $this->tasks;
  421.     }
  423.     public function addTask(Task $task): self
  424.     {
  425.         if (!$this->tasks->contains($task)) {
  426.             $this->tasks[] = $task;
  427.             $task->addShippingPlan($this);
  428.         }
  430.         return $this;
  431.     }
  433.     public function removeTask(Task $task): self
  434.     {
  435.         if ($this->tasks->removeElement($task)) {
  436.             $task->removeShippingPlan($this);
  437.         }
  439.         return $this;
  440.     }
  441. }