src/Entity/Inventory/PackageMovement.php line 41

  1. <?php
  3. namespace App\Entity\Inventory;
  5. use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
  6. use ApiPlatform\Metadata\ApiFilter;
  7. use ApiPlatform\Metadata\ApiProperty;
  8. use App\Entity\Common as Common;
  9. use App\Entity\Expediting\Package;
  10. use App\Entity\Expediting\Repacking;
  11. use App\Entity\Expediting\ShippingSegment;
  12. use DateTimeInterface;
  13. use Doctrine\Common\Collections\ArrayCollection;
  14. use Doctrine\Common\Collections\Collection;
  15. use Doctrine\DBAL\Types\Types;
  16. use Doctrine\ORM\Mapping as ORM;
  17. use Symfony\Component\Uid\Ulid;
  18. use Symfony\Component\Validator\Constraints as Assert;
  19. use Symfony\Component\Validator\Context\ExecutionContextInterface;
  21. #[ORM\Table(name: 'inventory_package_movement')]
  22. #[ORM\Index(columns: ['warehouse_id'], name: 'inventory_package_movement_warehouse_id_idx')]
  23. #[ORM\Index(columns: ['package_id'], name: 'inventory_package_movement_package_id_idx')]
  24. #[ORM\Index(columns: ['shipping_segment_id'], name: 'inventory_package_movement_shipping_segment_id_idx')]
  25. #[ORM\Index(columns: ['repacking_id'], name: 'inventory_package_movement_repacking_id_idx')]
  26. #[ORM\Index(columns: ['exit_id'], name: 'inventory_package_movement_exit_id_idx')]
  27. #[ORM\Index(columns: ['created_by'], name: 'inventory_package_movement_created_by_idx')]
  28. #[ORM\Index(columns: ['updated_by'], name: 'inventory_package_movement_updated_by_idx')]
  29. #[ORM\UniqueConstraint(name: 'inventory_package_movement_identifier_key', columns: ['identifier'])]
  30. #[ORM\InheritanceType('SINGLE_TABLE')]
  31. #[ORM\DiscriminatorColumn(name: 'type')]
  32. #[ORM\DiscriminatorMap([
  33.     'ENTRY' => PackageStockEntry::class,
  34.     'EXIT' => PackageStockExit::class,
  35. ])]
  36. #[ORM\Entity]
  37. #[ApiFilter(SearchFilter::class, properties: [
  38.     'package.reference' => 'ipartial',
  39.     'package.items.order.number' => 'ipartial',
  40. ])]
  41. Abstract class PackageMovement
  42. {
  43.     use Common\Blameable;
  44.     use Common\Trackable;
  46.     #[ORM\Id]
  47.     #[ORM\GeneratedValue(strategy: 'IDENTITY')]
  48.     #[ORM\SequenceGenerator(sequenceName: 'inventory_package_movement_id_seq')]
  49.     #[ORM\Column(type: Types::INTEGER)]
  50.     private ?int $id = null;
  52.     #[Assert\Ulid]
  53.     #[Assert\NotNull]
  54.     #[ORM\Column(type: 'ulid', unique: true)]
  55.     protected ?Ulid $identifier = null;
  57.     #[ApiFilter(SearchFilter::class, strategy: 'exact')]
  58.     #[ORM\ManyToOne(targetEntity: Warehouse::class, inversedBy: 'movements')]
  59.     #[ORM\JoinColumn(name: 'warehouse_id', referencedColumnName: 'id', nullable: false)]
  60.     protected ?Warehouse $warehouse = null;
  62.     #[ApiProperty(readableLink: true)]
  63.     #[ORM\ManyToOne(targetEntity: Package::class, inversedBy: 'movements')]
  64.     #[ORM\JoinColumn(name: 'package_id', referencedColumnName: 'id', nullable: false)]
  65.     protected ?Package $package = null;
  67.     #[ORM\ManyToOne(targetEntity: ShippingSegment::class, inversedBy: 'movements')]
  68.     #[ORM\JoinColumn(name: 'shipping_segment_id', referencedColumnName: 'id')]
  69.     protected ?ShippingSegment $shippingSegment = null;
  71.     #[ORM\ManyToOne(targetEntity: Repacking::class, inversedBy: 'movements')]
  72.     #[ORM\JoinColumn(name: 'repacking_id', referencedColumnName: 'id')]
  73.     protected ?Repacking $repacking = null;
  75.     #[Assert\Type(type: DateTimeInterface::class)]
  76.     #[ORM\Column(type: Types::DATETIMETZ_MUTABLE, nullable: false)]
  77.     protected ?DateTimeInterface $completedAt = null;
  79.     /** @var Collection<int, ItemMovement> */
  80.     #[ORM\OneToMany(mappedBy: 'packageMovement', targetEntity: ItemMovement::class)]
  81.     private Collection $itemsMovements;
  83.     public function __construct()
  84.     {
  85.         $this->identifier = new Ulid();
  86.         $this->itemsMovements = new ArrayCollection();
  87.     }
  89.     #[Assert\Callback]
  90.     public function validate(ExecutionContextInterface $context, $payload): void
  91.     {
  92.         if (empty($this->shipment) && empty($this->repacking)) {
  93.             $context->buildViolation('Package movement must be associated only with either, a shipment, or a repacking')
  94.                 ->atPath('shipment')
  95.                 ->addViolation();
  97.             $context->buildViolation('Package movement must be associated only with either, a shipment, or a repacking')
  98.                 ->atPath('repacking')
  99.                 ->addViolation();
  100.         }
  101.     }
  103.     public function getId(): ?int
  104.     {
  105.         return $this->id;
  106.     }
  108.     public function getIdentifier(): ?Ulid
  109.     {
  110.         return $this->identifier;
  111.     }
  113.     public function setIdentifier(Ulid $identifier): static
  114.     {
  115.         $this->identifier = $identifier;
  117.         return $this;
  118.     }
  120.     public function getCompletedAt(): ?DateTimeInterface
  121.     {
  122.         return $this->completedAt;
  123.     }
  125.     public function setCompletedAt(DateTimeInterface $completedAt): static
  126.     {
  127.         $this->completedAt = $completedAt;
  129.         return $this;
  130.     }
  132.     public function getWarehouse(): ?Warehouse
  133.     {
  134.         return $this->warehouse;
  135.     }
  137.     public function setWarehouse(?Warehouse $warehouse): static
  138.     {
  139.         $this->warehouse = $warehouse;
  141.         return $this;
  142.     }
  144.     public function getPackage(): ?Package
  145.     {
  146.         return $this->package;
  147.     }
  149.     public function setPackage(?Package $package): static
  150.     {
  151.         $this->package = $package;
  153.         return $this;
  154.     }
  156.     public function getShippingSegment(): ?ShippingSegment
  157.     {
  158.         return $this->shippingSegment;
  159.     }
  161.     public function setShippingSegment(?ShippingSegment $shippingSegment): static
  162.     {
  163.         $this->shippingSegment = $shippingSegment;
  165.         return $this;
  166.     }
  168.     public function getRepacking(): ?Repacking
  169.     {
  170.         return $this->repacking;
  171.     }
  173.     public function setRepacking(?Repacking $repacking): static
  174.     {
  175.         $this->repacking = $repacking;
  177.         return $this;
  178.     }
  180.     /**
  181.      * @return Collection<int, ItemMovement>
  182.      */
  183.     public function getItemsMovements(): Collection
  184.     {
  185.         return $this->itemsMovements;
  186.     }
  188.     public function addItemsMovement(ItemMovement $itemsMovement): static
  189.     {
  190.         if (!$this->itemsMovements->contains($itemsMovement)) {
  191.             $this->itemsMovements->add($itemsMovement);
  192.             $itemsMovement->setPackageMovement($this);
  193.         }
  195.         return $this;
  196.     }
  198.     public function removeItemsMovement(ItemMovement $itemsMovement): static
  199.     {
  200.         if ($this->itemsMovements->removeElement($itemsMovement)) {
  201.             // set the owning side to null (unless already changed)
  202.             if ($itemsMovement->getPackageMovement() === $this) {
  203.                 $itemsMovement->setPackageMovement(null);
  204.             }
  205.         }
  207.         return $this;
  208.     }
  209. }