src/Entity/Expediting/ShippingSegment.php line 61

  1. <?php
  3. namespace App\Entity\Expediting;
  5. use ApiPlatform\Metadata\ApiProperty;
  6. use ApiPlatform\Metadata\ApiResource;
  7. use ApiPlatform\Metadata\Get;
  8. use ApiPlatform\Metadata\GetCollection;
  9. use ApiPlatform\Metadata\Post;
  10. use App\Doctrine\Type\Expediting\ShippingSegmentStatus;
  11. use App\Doctrine\Type\Expediting\ShipmentType;
  12. use App\Doctrine\Type\Expediting\TransportMode;
  13. use App\Doctrine\Type\Expediting\TransportSpecification;
  14. use App\Doctrine\Type\SelectableType;
  15. use App\Dto\Expediting\BookingInput;
  16. use App\Dto\Expediting\ShipmentStatusUpdateInput;
  17. use App\Entity\Common as Common;
  18. use App\Entity\Common\Company;
  19. use App\Entity\Fleet\Driver;
  20. use App\Entity\Fleet\Vehicle;
  21. use App\Entity\Inventory\PackageMovement;
  22. use App\Entity\Places\Facility;
  23. use App\Entity\Scheduler\Task;
  24. use App\Processor\Expediting\ShipmentBookingProcessor;
  25. use App\Processor\Expediting\ShipmentStatusProcessor;
  26. use App\Validator\IsValidEnum\IsValidEnum;
  27. use DateTimeInterface;
  28. use Doctrine\Common\Collections\ArrayCollection;
  29. use Doctrine\Common\Collections\Collection;
  30. use Doctrine\DBAL\Types\Types;
  31. use Doctrine\ORM\Mapping as ORM;
  32. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  33. use Symfony\Component\Serializer\Annotation\Ignore;
  34. use Symfony\Component\Uid\Ulid;
  35. use Symfony\Component\Validator\Constraints as Assert;
  37. #[ORM\Table(name: 'expediting_shipping_segment')]
  38. #[ORM\Index(columns: ['shipping_plan_id'], name: 'expediting_shipping_segment_shipping_plan_id_idx')]
  39. #[ORM\Index(columns: ['place_of_loading_id'], name: 'expediting_shipping_segment_place_of_loading_id_idx')]
  40. #[ORM\Index(columns: ['place_of_discharge_id'], name: 'expediting_shipping_segment_place_of_discharge_id_idx')]
  41. #[ORM\Index(columns: ['transport_company_id'], name: 'expediting_shipping_segment_transport_company_id_idx')]
  42. #[ORM\Index(columns: ['notify_party_id'], name: 'expediting_shipping_segment_notify_party_id_idx')]
  43. #[ORM\Index(columns: ['consignee_id'], name: 'expediting_shipping_segment_consignee_id_idx')]
  44. #[ORM\Index(columns: ['shipper_id'], name: 'expediting_shipping_segment_shipper_id_idx')]
  45. #[ORM\Index(columns: ['vehicle_id'], name: 'expediting_shipping_segment_vehicle_id_idx')]
  46. #[ORM\Index(columns: ['driver_id'], name: 'expediting_shipping_segment_driver_id_idx')]
  47. #[ORM\Index(columns: ['created_by'], name: 'expediting_shipping_segment_created_by_idx')]
  48. #[ORM\Index(columns: ['updated_by'], name: 'expediting_shipping_segment_updated_by_idx')]
  49. #[ORM\UniqueConstraint(name: 'expediting_shipping_segment_identifier_key', columns: ['identifier'])]
  50. #[ORM\Entity]
  51. #[UniqueEntity(fields: ['identifier'])]
  52. #[ApiResource(
  53.     operations: [
  54.         new Get(),
  55.         new Post(uriTemplate: '/shipments/{identifier}/book', input: BookingInput::class, processor: ShipmentBookingProcessor::class),
  56.         new Post(uriTemplate: '/shipments/{identifier}/update', input: ShipmentStatusUpdateInput::class, processor: ShipmentStatusProcessor::class),
  57.         new GetCollection(),
  58.     ],
  59.     routePrefix: '/expediting',
  60. )]
  61. class ShippingSegment
  62. {
  63.     use Shippable;
  64.     use Common\Blameable;
  65.     use Common\Trackable;
  67.     #[ORM\Id]
  68.     #[ORM\GeneratedValue(strategy: 'IDENTITY')]
  69.     #[ORM\SequenceGenerator(sequenceName: 'expediting_shipment_id_seq')]
  70.     #[ORM\Column(type: Types::INTEGER)]
  71.     #[ApiProperty(identifier: false)]
  72.     private ?int $id = null;
  74.     #[Assert\Ulid]
  75.     #[Assert\NotNull]
  76.     #[ORM\Column(type: 'ulid', unique: true)]
  77.     #[ApiProperty(identifier: true)]
  78.     private ?Ulid $identifier = null;
  80.     #[Assert\NotNull]
  81.     #[Assert\Type(type: ShippingPlan::class)]
  82.     #[ORM\ManyToOne(targetEntity: ShippingPlan::class, inversedBy: 'shippingSegments')]
  83.     #[ORM\JoinColumn(name: 'shipping_plan_id', nullable: false)]
  84.     private ?ShippingPlan $shippingPlan = null;
  86.     #[ORM\ManyToOne(targetEntity: Company::class)]
  87.     #[ORM\JoinColumn(name: 'shipper_id')]
  88.     private ?Company $shipper = null;
  90.     #[ORM\ManyToOne(targetEntity: Company::class)]
  91.     #[ORM\JoinColumn(name: 'consignee_id')]
  92.     private ?Company $consignee = null;
  94.     #[ORM\ManyToOne(targetEntity: Company::class)]
  95.     #[ORM\JoinColumn(name: 'notify_party_id')]
  96.     private ?Company $notifyParty = null;
  98.     #[ORM\ManyToOne(targetEntity: Facility::class)]
  99.     #[ORM\JoinColumn(name: 'place_of_loading_id')]
  100.     #[ApiProperty(readableLink: true)]
  101.     private ?Facility $placeOfLoading = null;
  103.     #[ORM\ManyToOne(targetEntity: Facility::class)]
  104.     #[ORM\JoinColumn(name: 'place_of_discharge_id')]
  105.     #[ApiProperty(readableLink: true)]
  106.     private ?Facility $placeOfDischarge = null;
  108.     #[Assert\Type(type: Types::DATE_MUTABLE)]
  109.     #[ORM\Column(type: Types::DATE_MUTABLE, nullable: true)]
  110.     private ?DateTimeInterface $etd = null;
  112.     #[Assert\Type(type: Types::DATE_MUTABLE)]
  113.     #[ORM\Column(type: Types::DATE_MUTABLE, nullable: true)]
  114.     private ?DateTimeInterface $eta = null;
  116.     #[Assert\Length(exactly: 3)]
  117.     #[Assert\Type(type: Types::STRING)]
  118.     #[ORM\Column(type: Types::STRING, length: 3, nullable: true)]
  119.     private ?string $currency = null;
  121.     #[Assert\Type(type: Types::FLOAT)]
  122.     #[ORM\Column(type: Types::DECIMAL, precision: 18, scale: 5, nullable: true)]
  123.     private ?float $freightValue = null;
  125.     #[Assert\Type(type: Types::STRING)]
  126.     #[ORM\Column(type: Types::STRING, nullable: true)]
  127.     private ?string $bookingNumber = null;
  129.     #[Assert\Type(type: Types::STRING)]
  130.     #[ORM\Column(type: Types::STRING, nullable: true)]
  131.     private ?string $billNumber = null;
  133.     #[Assert\Type(type: Types::STRING)]
  134.     #[ORM\Column(type: Types::STRING, nullable: true)]
  135.     private ?string $vectorReference = null;
  137.     #[Assert\NotNull]
  138.     #[IsValidEnum(enum: TransportMode::class)]
  139.     #[ORM\Column(type: Types::STRING, enumType: TransportMode::class)]
  140.     private ?TransportMode $transportMode = null;
  142.     #[Assert\Type(type: Company::class)]
  143.     #[ORM\ManyToOne(targetEntity: Company::class)]
  144.     #[ORM\JoinColumn(name: 'transport_company_id')]
  145.     private ?Company $transportCompany = null;
  147.     #[Assert\Type(type: Driver::class)]
  148.     #[ORM\ManyToOne(targetEntity: Driver::class)]
  149.     #[ORM\JoinColumn(name: 'driver_id')]
  150.     private ?Driver $driver = null;
  152.     #[Assert\Type(type: Vehicle::class)]
  153.     #[ORM\ManyToOne(targetEntity: Vehicle::class)]
  154.     #[ORM\JoinColumn(name: 'vehicle_id')]
  155.     private ?Vehicle $vehicle = null;
  157.     #[Assert\NotNull]
  158.     #[IsValidEnum(enum: TransportSpecification::class)]
  159.     #[ORM\Column(type: Types::STRING, enumType: TransportSpecification::class, options: ['default' => 'STANDARD'])]
  160.     private ?TransportSpecification $transportSpecification = TransportSpecification::STANDARD;
  162.     #[Assert\Type(type: Types::BOOLEAN)]
  163.     #[ORM\Column(type: Types::BOOLEAN, nullable: true, options: ['default' => false])]
  164.     private ?bool $delayed = false;
  166.     /**
  167.      * @var ShipmentType[]
  168.      * Note : Types are automatically on the entity subscriber level
  169.      */
  170.     #[Assert\NotNull]
  171.     #[ORM\Column(type: SelectableType::NAME, nullable: true, enumType: ShipmentType::class)]
  172.     private array $types = [];
  174.     #[Assert\NotNull]
  175.     #[IsValidEnum(enum: ShippingSegmentStatus::class)]
  176.     #[ORM\Column(type: Types::STRING, enumType: ShippingSegmentStatus::class, options: ['default' => 'PLANNED'])]
  177.     private ?ShippingSegmentStatus $status = ShippingSegmentStatus::PLANNED;
  179.     /** @var Collection<int, PackageMovement> */
  180.     #[ORM\OneToMany(mappedBy: 'shippingSegment', targetEntity: PackageMovement::class)]
  181.     #[Ignore]
  182.     private Collection $movements;
  184.     /** @var Collection<int, Task> */
  185.     #[ORM\ManyToMany(targetEntity: Task::class, mappedBy: 'shippingSegments')]
  186.     private Collection $tasks;
  188.     public function __construct()
  189.     {
  190.         $this->identifier = new Ulid();
  191.         $this->movements = new ArrayCollection();
  192.         $this->tasks = new ArrayCollection();
  193.     }
  195.     public function getId(): ?int
  196.     {
  197.         return $this->id;
  198.     }
  200.     public function getIdentifier(): ?Ulid
  201.     {
  202.         return $this->identifier;
  203.     }
  205.     public function setIdentifier(Ulid $identifier): self
  206.     {
  207.         $this->identifier = $identifier;
  209.         return $this;
  210.     }
  212.     public function getShippingPlan(): ?ShippingPlan
  213.     {
  214.         return $this->shippingPlan;
  215.     }
  217.     public function setShippingPlan(?ShippingPlan $shippingPlan): self
  218.     {
  219.         $this->shippingPlan = $shippingPlan;
  221.         return $this;
  222.     }
  224.     public function getShipper(): ?Company
  225.     {
  226.         return $this->shipper;
  227.     }
  229.     public function setShipper(?Company $shipper): self
  230.     {
  231.         $this->shipper = $shipper;
  233.         return $this;
  234.     }
  236.     public function getConsignee(): ?Company
  237.     {
  238.         return $this->consignee;
  239.     }
  241.     public function setConsignee(?Company $consignee): self
  242.     {
  243.         $this->consignee = $consignee;
  245.         return $this;
  246.     }
  248.     public function getNotifyParty(): ?Company
  249.     {
  250.         return $this->notifyParty;
  251.     }
  253.     public function setNotifyParty(?Company $notifyParty): self
  254.     {
  255.         $this->notifyParty = $notifyParty;
  257.         return $this;
  258.     }
  260.     public function getPlaceOfLoading(): ?Facility
  261.     {
  262.         return $this->placeOfLoading;
  263.     }
  265.     public function setPlaceOfLoading(?Facility $placeOfLoading): self
  266.     {
  267.         $this->placeOfLoading = $placeOfLoading;
  269.         return $this;
  270.     }
  272.     public function getPlaceOfDischarge(): ?Facility
  273.     {
  274.         return $this->placeOfDischarge;
  275.     }
  277.     public function setPlaceOfDischarge(?Facility $placeOfDischarge): self
  278.     {
  279.         $this->placeOfDischarge = $placeOfDischarge;
  281.         return $this;
  282.     }
  284.     public function getEtd(): ?DateTimeInterface
  285.     {
  286.         return $this->etd;
  287.     }
  289.     public function setEtd(?DateTimeInterface $etd): self
  290.     {
  291.         $this->etd = $etd;
  293.         return $this;
  294.     }
  296.     public function getEta(): ?DateTimeInterface
  297.     {
  298.         return $this->eta;
  299.     }
  301.     public function setEta(?DateTimeInterface $eta): self
  302.     {
  303.         $this->eta = $eta;
  305.         return $this;
  306.     }
  308.     public function getCurrency(): ?string
  309.     {
  310.         return $this->currency;
  311.     }
  313.     public function setCurrency(?string $currency): self
  314.     {
  315.         $this->currency = $currency;
  317.         return $this;
  318.     }
  320.     public function getFreightValue(): ?string
  321.     {
  322.         return $this->freightValue;
  323.     }
  325.     public function setFreightValue(?string $freightValue): self
  326.     {
  327.         $this->freightValue = $freightValue;
  329.         return $this;
  330.     }
  332.     public function getBookingNumber(): ?string
  333.     {
  334.         return $this->bookingNumber;
  335.     }
  337.     public function setBookingNumber(?string $bookingNumber): self
  338.     {
  339.         $this->bookingNumber = $bookingNumber;
  341.         return $this;
  342.     }
  344.     public function getBillNumber(): ?string
  345.     {
  346.         return $this->billNumber;
  347.     }
  349.     public function setBillNumber(?string $billNumber): self
  350.     {
  351.         $this->billNumber = $billNumber;
  353.         return $this;
  354.     }
  356.     public function getVectorReference(): ?string
  357.     {
  358.         return $this->vectorReference;
  359.     }
  361.     public function setVectorReference(?string $vectorReference): self
  362.     {
  363.         $this->vectorReference = $vectorReference;
  365.         return $this;
  366.     }
  368.     public function getTransportMode(): ?TransportMode
  369.     {
  370.         return $this->transportMode;
  371.     }
  373.     public function setTransportMode(?TransportMode $transportMode): self
  374.     {
  375.         $this->transportMode = $transportMode;
  377.         return $this;
  378.     }
  380.     public function getTransportCompany(): ?Company
  381.     {
  382.         return $this->transportCompany;
  383.     }
  385.     public function setTransportCompany(?Company $transportCompany): self
  386.     {
  387.         $this->transportCompany = $transportCompany;
  389.         return $this;
  390.     }
  392.     public function getDriver(): ?Driver
  393.     {
  394.         return $this->driver;
  395.     }
  397.     public function setDriver(?Driver $driver): self
  398.     {
  399.         $this->driver = $driver;
  401.         return $this;
  402.     }
  404.     public function getVehicle(): ?Vehicle
  405.     {
  406.         return $this->vehicle;
  407.     }
  409.     public function setVehicle(?Vehicle $vehicle): self
  410.     {
  411.         $this->vehicle = $vehicle;
  413.         return $this;
  414.     }
  416.     public function getTransportSpecification(): ?TransportSpecification
  417.     {
  418.         return $this->transportSpecification;
  419.     }
  421.     public function setTransportSpecification(?TransportSpecification $transportSpecification): self
  422.     {
  423.         $this->transportSpecification = $transportSpecification;
  425.         return $this;
  426.     }
  428.     public function isDelayed(): ?bool
  429.     {
  430.         return $this->delayed;
  431.     }
  433.     public function setDelayed(?bool $delayed): self
  434.     {
  435.         $this->delayed = $delayed;
  437.         return $this;
  438.     }
  440.     public function getTypes(): array
  441.     {
  442.         return $this->types;
  443.     }
  445.     public function addType(ShipmentType $type): self
  446.     {
  447.         if (!in_array($type, $this->types)) {
  448.             $this->types []= $type;
  449.         }
  451.         return $this;
  452.     }
  454.     public function setTypes($types): self
  455.     {
  456.         $this->types = $types;
  458.         return $this;
  459.     }
  461.     public function getStatus(): ?ShippingSegmentStatus
  462.     {
  463.         return $this->status;
  464.     }
  466.     public function setStatus(?ShippingSegmentStatus $status): self
  467.     {
  468.         $this->status = $status;
  470.         return $this;
  471.     }
  473.     /**
  474.      * @return Collection<int, PackageMovement>
  475.      */
  476.     public function getMovements(): Collection
  477.     {
  478.         return $this->movements;
  479.     }
  481.     public function addMovement(PackageMovement $movement): static
  482.     {
  483.         if (!$this->movements->contains($movement)) {
  484.             $this->movements->add($movement);
  485.             $movement->setShippingSegment($this);
  486.         }
  488.         return $this;
  489.     }
  491.     public function removeMovement(PackageMovement $movement): static
  492.     {
  493.         if ($this->movements->removeElement($movement)) {
  494.             // set the owning side to null (unless already changed)
  495.             if ($movement->getShippingSegment() === $this) {
  496.                 $movement->setShippingSegment(null);
  497.             }
  498.         }
  500.         return $this;
  501.     }
  503.     /**
  504.      * @return Collection<int, Task>
  505.      */
  506.     public function getTasks(): Collection
  507.     {
  508.         return $this->tasks;
  509.     }
  511.     public function addTask(Task $task): self
  512.     {
  513.         if (!$this->tasks->contains($task)) {
  514.             $this->tasks[] = $task;
  515.             $task->addShippingSegment($this);
  516.         }
  518.         return $this;
  519.     }
  521.     public function removeTask(Task $task): self
  522.     {
  523.         if ($this->tasks->removeElement($task)) {
  524.             $task->removeShippingSegment($this);
  525.         }
  527.         return $this;
  528.     }
  529. }