src/Entity/Expediting/Package.php line 65

  1. <?php
  3. namespace App\Entity\Expediting;
  5. use ApiPlatform\Metadata\ApiProperty;
  6. use ApiPlatform\Metadata\ApiResource;
  7. use ApiPlatform\Metadata\Delete;
  8. use ApiPlatform\Metadata\Get;
  9. use ApiPlatform\Metadata\GetCollection;
  10. use ApiPlatform\Metadata\Link;
  11. use ApiPlatform\Metadata\Patch;
  12. use ApiPlatform\Metadata\Post;
  13. use ApiPlatform\Metadata\Put;
  14. use App\Doctrine\Type\Expediting\CasingMaterial;
  15. use App\Doctrine\Type\Expediting\CasingType;
  16. use App\Doctrine\Type\Expediting\ExpeditableStatus;
  17. use App\Dto\Expediting\PackageSurveyInput;
  18. use App\Entity\Common as Common;
  19. use App\Entity\File\File;
  20. use App\Entity\Inventory\PackageMovement;
  21. use App\Processor\Expediting\PackageSurveyInputProcessor;
  22. use App\Validator\IsValidEnum\IsValidEnum;
  23. use Doctrine\Common\Collections\ArrayCollection;
  24. use Doctrine\Common\Collections\Collection;
  25. use Doctrine\DBAL\Types\Types;
  26. use Doctrine\ORM\Mapping as ORM;
  27. use Gedmo\Mapping\Annotation as Gedmo;
  28. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  29. use Symfony\Component\Serializer\Annotation\Ignore;
  30. use Symfony\Component\Uid\Ulid;
  31. use Symfony\Component\Validator\Constraints as Assert;
  33. #[ORM\Table(name: 'expediting_package')]
  34. #[ORM\Index(columns: ['destination_repacking_id'], name: 'expediting_package_destination_repacking_id_idx')]
  35. #[ORM\Index(columns: ['source_repacking_id'], name: 'expediting_package_source_repacking_id_idx')]
  36. #[ORM\Index(columns: ['created_by'], name: 'expediting_package_created_by_idx')]
  37. #[ORM\Index(columns: ['updated_by'], name: 'expediting_package_updated_by_idx')]
  38. #[ORM\UniqueConstraint(name: 'expediting_package_slug_key', columns: ['slug'])]
  39. #[ORM\UniqueConstraint(name: 'expediting_package_reference_key', columns: ['reference'])]
  40. #[ORM\UniqueConstraint(name: 'expediting_package_identifier_key', columns: ['identifier'])]
  41. #[ORM\Entity]
  42. #[UniqueEntity(fields: ['reference'])]
  43. #[ApiResource(
  44.     operations: [
  45.         new Get(),
  46.         new GetCollection(),
  47.         new Post(),
  48.         new Put(),
  49.         new Patch(),
  50.         new Delete(),
  51.         new Post(
  52.             uriTemplate: '/packages/survey',
  53.             inputFormats: ['json' => ['application/json'], 'multipart' => ['multipart/form-data']],
  54.             input: PackageSurveyInput::class,
  55.             processor: PackageSurveyInputProcessor::class
  56.         ),
  57.     ],
  58.     routePrefix: '/expediting'
  59. )]
  60. #[ApiResource(
  61.     uriTemplate: '/expediting/shipments/{slug}/packages',
  62.     operations: [new GetCollection()],
  63.     uriVariables: ['slug' => new Link(fromProperty: 'packages', fromClass: Shipment::class)],
  64. )]
  65. class Package
  66. {
  67.     use Common\Blameable;
  68.     use Common\Trackable;
  69.     use Shippable;
  71.     #[ORM\Id]
  72.     #[ORM\GeneratedValue(strategy: 'IDENTITY')]
  73.     #[ORM\SequenceGenerator(sequenceName: 'expediting_package_id_seq')]
  74.     #[ORM\Column(type: Types::INTEGER)]
  75.     #[ApiProperty(identifier: false)]
  76.     private ?int $id = null;
  78.     #[Assert\Ulid]
  79.     #[Assert\NotNull]
  80.     #[ORM\Column(type: 'ulid', unique: true)]
  81.     private ?Ulid $identifier = null;
  83.     #[Gedmo\Slug(fields: ['reference'])]
  84.     #[ORM\Column(type: Types::STRING)]
  85.     #[ApiProperty(identifier: true)]
  86.     private ?string $slug = null;
  88.     #[Assert\NotBlank]
  89.     #[Assert\Type(type: Types::STRING)]
  90.     #[ORM\Column(type: Types::STRING)]
  91.     private ?string $reference = null;
  93.     #[Assert\NotBlank]
  94.     #[Assert\Type(type: Types::STRING)]
  95.     #[ORM\Column(type: Types::STRING)]
  96.     private ?string $packageNumber = null;
  98.     #[Assert\Type(type: Types::FLOAT)]
  99.     #[ORM\Column(type: Types::DECIMAL, precision: 18, scale: 3, nullable: true)]
  100.     private ?float $length = null;
  102.     #[Assert\Type(type: Types::FLOAT)]
  103.     #[ORM\Column(type: Types::DECIMAL, precision: 18, scale: 3, nullable: true)]
  104.     private ?float $width = null;
  106.     #[Assert\Type(type: Types::FLOAT)]
  107.     #[ORM\Column(type: Types::DECIMAL, precision: 18, scale: 3, nullable: true)]
  108.     private ?float $height = null;
  110.     #[Assert\Type(type: Types::FLOAT)]
  111.     #[ORM\Column(type: Types::DECIMAL, precision: 18, scale: 3, nullable: true)]
  112.     private ?float $weight = null;
  114.     #[Assert\Type(type: Types::FLOAT)]
  115.     #[ORM\Column(type: Types::DECIMAL, precision: 18, scale: 3, nullable: true)]
  116.     private ?float $shippingWeight = null;
  118.     #[Assert\NotNull]
  119.     #[Assert\Type(type: Types::BOOLEAN)]
  120.     #[ORM\Column(type: Types::BOOLEAN, options: ['default' => false])]
  121.     private ?bool $openable = false;
  123.     #[Assert\NotNull]
  124.     #[Assert\Type(type: Types::BOOLEAN)]
  125.     #[ORM\Column(type: Types::BOOLEAN, options: ['default' => false])]
  126.     private ?bool $destroyed = false;
  128.     #[IsValidEnum(enum: CasingType::class)]
  129.     #[ORM\Column(type: Types::STRING, nullable: true, enumType: CasingType::class)]
  130.     private ?CasingType $casingType = null;
  132.     #[IsValidEnum(enum: CasingMaterial::class)]
  133.     #[ORM\Column(type: Types::STRING, nullable: true, enumType: CasingMaterial::class)]
  134.     private ?CasingMaterial $casingMaterial = null;
  136.     #[Assert\NotNull]
  137.     #[IsValidEnum(enum: ExpeditableStatus::class)]
  138.     #[ORM\Column(type: Types::STRING, enumType: ExpeditableStatus::class)]
  139.     private ?ExpeditableStatus $status = null;
  141.     #[ORM\ManyToOne(targetEntity: Repacking::class, inversedBy: 'inputs')]
  142.     #[ORM\JoinColumn(name: 'destination_repacking_id')]
  143.     private ?Repacking $destinationRepacking = null;
  145.     #[ORM\ManyToOne(targetEntity: Repacking::class, inversedBy: 'outputs')]
  146.     #[ORM\JoinColumn(name: 'source_repacking_id')]
  147.     private ?Repacking $sourceRepacking = null;
  149.     /** @var Collection<int, Shipment> */
  150.     #[ORM\ManyToMany(targetEntity: Shipment::class, mappedBy: 'packages')]
  151.     private Collection $shipments;
  153.     /** @var Collection<int, Container> */
  154.     #[ORM\ManyToMany(targetEntity: Container::class, mappedBy: 'packages')]
  155.     private Collection $containers;
  157.     /** @var Collection<int, PackageMovement> */
  158.     #[ORM\OneToMany(mappedBy: 'package', targetEntity: PackageMovement::class)]
  159.     #[ORM\OrderBy(['id' => 'DESC'])]
  160.     #[Ignore]
  161.     private Collection $movements;
  163.     /** @var Collection<int, Expeditable> */
  164.     #[ORM\ManyToMany(targetEntity: Expeditable::class, inversedBy: 'packages')]
  165.     #[ORM\JoinTable(name: 'expediting_package_item_map')]
  166.     #[ORM\JoinColumn(name: 'package_id')]
  167.     #[ORM\InverseJoinColumn(name: 'item_id')]
  168.     private Collection $items;
  170.     /** @var Collection<int, File> */
  171.     #[ORM\ManyToMany(targetEntity: File::class, cascade: ['persist', 'remove'])]
  172.     #[ORM\JoinTable(name: 'expediting_package_file_map')]
  173.     #[ORM\JoinColumn(name: 'package_id')]
  174.     #[ORM\InverseJoinColumn(name: 'file_id')]
  175.     #[ORM\OrderBy(['id' => 'ASC'])]
  176.     private Collection $attachments;
  178.     public function __construct()
  179.     {
  180.         $this->identifier = new Ulid();
  181.         $this->shipments = new ArrayCollection();
  182.         $this->containers = new ArrayCollection();
  183.         $this->movements = new ArrayCollection();
  184.         $this->items = new ArrayCollection();
  185.         $this->attachments = new ArrayCollection();
  186.     }
  188.     public function getId(): ?int
  189.     {
  190.         return $this->id;
  191.     }
  193.     public function getIdentifier(): ?Ulid
  194.     {
  195.         return $this->identifier;
  196.     }
  198.     public function setIdentifier(Ulid $identifier): self
  199.     {
  200.         $this->identifier = $identifier;
  202.         return $this;
  203.     }
  205.     public function getSlug(): ?string
  206.     {
  207.         return $this->slug;
  208.     }
  210.     public function setSlug(string $slug): self
  211.     {
  212.         $this->slug = $slug;
  214.         return $this;
  215.     }
  217.     public function getReference(): ?string
  218.     {
  219.         return $this->reference;
  220.     }
  222.     public function setReference(string $reference): self
  223.     {
  224.         $this->reference = $reference;
  226.         return $this;
  227.     }
  229.     public function getPackageNumber(): ?string
  230.     {
  231.         return $this->packageNumber;
  232.     }
  234.     public function setPackageNumber(string $packageNumber): self
  235.     {
  236.         $this->packageNumber = $packageNumber;
  238.         return $this;
  239.     }
  241.     public function getWidth(): ?string
  242.     {
  243.         return (string) $this->width;
  244.     }
  246.     public function setWidth(float|string|null $width): self
  247.     {
  248.         $this->width = null === $width ? null : (float) $width;
  249.         $this->setShippingWeight();
  251.         return $this;
  252.     }
  254.     public function getLength(): ?string
  255.     {
  256.         return (string) $this->length;
  257.     }
  259.     public function setLength(float|string|null $length): self
  260.     {
  261.         $this->length = null === $length ? null : (float) $length;
  262.         $this->setShippingWeight();
  264.         return $this;
  265.     }
  267.     public function getHeight(): ?string
  268.     {
  269.         return (string) $this->height;
  270.     }
  272.     public function setHeight(float|string|null $height): self
  273.     {
  274.         $this->height = null === $height ? null : (float) $height;
  275.         $this->setShippingWeight();
  277.         return $this;
  278.     }
  280.     public function getWeight(): ?string
  281.     {
  282.         return (string) $this->weight;
  283.     }
  285.     public function setWeight(float|string|null $weight): self
  286.     {
  287.         $this->weight = null === $weight ? null : (float) $weight;
  289.         return $this;
  290.     }
  292.     public function getShippingWeight(): ?string
  293.     {
  294.         return (string) $this->shippingWeight;
  295.     }
  297.     public function setShippingWeight(): self
  298.     {
  299.         $volume = ($this->width * $this->length * $this->height) / 6_000;
  300.         $shippingWeight = max($this->weight, $volume);
  301.         $this->shippingWeight = $shippingWeight;
  303.         return $this;
  304.     }
  306.     public function isOpenable(): ?bool
  307.     {
  308.         return $this->openable;
  309.     }
  311.     public function setOpenable(bool $openable): self
  312.     {
  313.         $this->openable = $openable;
  315.         return $this;
  316.     }
  318.     public function isDestroyed(): ?bool
  319.     {
  320.         return $this->destroyed;
  321.     }
  323.     public function setDestroyed(bool $destroyed): self
  324.     {
  325.         $this->destroyed = $destroyed;
  327.         return $this;
  328.     }
  330.     public function getCasingType(): ?CasingType
  331.     {
  332.         return $this->casingType;
  333.     }
  335.     public function setCasingType(?CasingType $casingType): self
  336.     {
  337.         $this->casingType = $casingType;
  339.         return $this;
  340.     }
  342.     public function getCasingMaterial(): ?CasingMaterial
  343.     {
  344.         return $this->casingMaterial;
  345.     }
  347.     public function setCasingMaterial(?CasingMaterial $casingMaterial): self
  348.     {
  349.         $this->casingMaterial = $casingMaterial;
  351.         return $this;
  352.     }
  354.     public function getStatus(): ?ExpeditableStatus
  355.     {
  356.         return $this->status;
  357.     }
  359.     public function setStatus(?ExpeditableStatus $status): self
  360.     {
  361.         $this->status = $status;
  363.         return $this;
  364.     }
  366.     /**
  367.      * @return Collection<int, Shipment>
  368.      */
  369.     public function getShipments(): Collection
  370.     {
  371.         return $this->shipments;
  372.     }
  374.     public function addShipment(Shipment $shipment): self
  375.     {
  376.         if (!$this->shipments->contains($shipment)) {
  377.             $this->shipments->add($shipment);
  378.             $shipment->addPackage($this);
  379.         }
  381.         return $this;
  382.     }
  384.     public function removeShipment(Shipment $shipment): self
  385.     {
  386.         if ($this->shipments->removeElement($shipment)) {
  387.             $shipment->removePackage($this);
  388.         }
  390.         return $this;
  391.     }
  393.     /**
  394.      * @return Collection<int, Container>
  395.      */
  396.     public function getContainers(): Collection
  397.     {
  398.         return $this->containers;
  399.     }
  401.     public function addContainer(Container $container): self
  402.     {
  403.         if (!$this->containers->contains($container)) {
  404.             $this->containers->add($container);
  405.             $container->addPackage($this);
  406.         }
  408.         return $this;
  409.     }
  411.     public function removeContainer(Container $container): self
  412.     {
  413.         if ($this->containers->removeElement($container)) {
  414.             $container->removePackage($this);
  415.         }
  417.         return $this;
  418.     }
  420.     /**
  421.      * @return Collection<int, Expeditable>
  422.      */
  423.     public function getItems(): Collection
  424.     {
  425.         return $this->items;
  426.     }
  428.     public function addItem(Expeditable $item): self
  429.     {
  430.         if (!$this->items->contains($item)) {
  431.             $this->items->add($item);
  432.         }
  434.         return $this;
  435.     }
  437.     public function removeItem(Expeditable $item): self
  438.     {
  439.         $this->items->removeElement($item);
  441.         return $this;
  442.     }
  444.     public function getDestinationRepacking(): ?Repacking
  445.     {
  446.         return $this->destinationRepacking;
  447.     }
  449.     public function setDestinationRepacking(?Repacking $destinationRepacking): static
  450.     {
  451.         $this->destinationRepacking = $destinationRepacking;
  453.         return $this;
  454.     }
  456.     public function getSourceRepacking(): ?Repacking
  457.     {
  458.         return $this->sourceRepacking;
  459.     }
  461.     public function setSourceRepacking(?Repacking $sourceRepacking): static
  462.     {
  463.         $this->sourceRepacking = $sourceRepacking;
  465.         return $this;
  466.     }
  468.     /**
  469.      * @return Collection<int, PackageMovement>
  470.      */
  471.     public function getMovements(): Collection
  472.     {
  473.         return $this->movements;
  474.     }
  476.     public function addMovement(PackageMovement $movement): static
  477.     {
  478.         if (!$this->movements->contains($movement)) {
  479.             $this->movements->add($movement);
  480.             $movement->setPackage($this);
  481.         }
  483.         return $this;
  484.     }
  486.     public function removeMovement(PackageMovement $movement): static
  487.     {
  488.         if ($this->movements->removeElement($movement)) {
  489.             // set the owning side to null (unless already changed)
  490.             if ($movement->getPackage() === $this) {
  491.                 $movement->setPackage(null);
  492.             }
  493.         }
  495.         return $this;
  496.     }
  498.     /**
  499.      * @return Collection<int, File>
  500.      */
  501.     public function getAttachments(): Collection
  502.     {
  503.         return $this->attachments;
  504.     }
  506.     public function addAttachment(File $attachment): self
  507.     {
  508.         if (!$this->attachments->contains($attachment)) {
  509.             $this->attachments->add($attachment);
  510.         }
  512.         return $this;
  513.     }
  515.     public function removeAttachment(File $attachment): self
  516.     {
  517.         $this->attachments->removeElement($attachment);
  519.         return $this;
  520.     }
  521. }