src/Entity/Vessel.php line 89

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace App\Entity;
  7. use ApiPlatform\Core\Annotation\ApiFilter;
  8. use ApiPlatform\Core\Annotation\ApiProperty;
  9. use ApiPlatform\Core\Annotation\ApiResource;
  10. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\OrderFilter;
  11. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
  12. use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\BooleanFilter;
  13. use ApiPlatform\Core\Serializer\Filter\PropertyFilter;
  14. use App\Trait\TimestampableEntity;
  15. use Doctrine\Common\Collections\ArrayCollection;
  16. use Doctrine\Common\Collections\Collection;
  17. use Doctrine\ORM\Mapping as ORM;
  18. use EasyRdf\Literal\Boolean;
  19. use Symfony\Component\Serializer\Annotation\Groups;
  20. use Symfony\Component\Validator\Constraints as Assert;
  21. use Symfony\Component\Serializer\Annotation\MaxDepth;
  22. use Ramsey\Uuid\Uuid;
  23. use Ramsey\Uuid\UuidInterface;
  25. /**
  26.  * @see https://schema.org/Thing
  27.  *
  28.  * @author Jordi Fernandes Alves <jfadev@gmail.com>
  29.  */
  30. #[ORM\Entity]
  31. #[ApiResource(
  32.     iri: 'Vessel',
  33.     itemOperations: [
  34.         'get' => ['normalization_context' => ['groups' => 'vessel:item:get', 'enable_max_depth' => true]],
  35.         'put' => [
  36.             'normalization_context' => ['groups' => 'vessel:item:put', 'enable_max_depth' => true],
  37.             'denormalization_context' => ['groups' => 'vessel:item:put', 'enable_max_depth' => true],
  38.         ],
  39.         'delete' => [],
  40.     ],
  41.     collectionOperations: [
  42.         'get' => [
  43.             'normalization_context' => ['groups' => ['vessel:collection:get', 'createdAt'], 'enable_max_depth' => true],
  44.         ],
  45.         'post' => [
  46.             'normalization_context' => ['groups' => 'vessel:collection:post', 'enable_max_depth' => true],
  47.             'denormalization_context' => ['groups' => 'vessel:collection:post', 'enable_max_depth' => true],
  48.         ],
  49.     ],
  50. )]
  51. #[ApiFilter(
  52.     SearchFilter::class,
  53.     properties: [
  54.         'vesselName' => 'partial', 
  55.         'imoNumber' => 'partial', 
  56.         'vesselType' => 'exact',
  57.         'dwt' => 'partial',
  58.         'yearBuilt' => 'exact',
  59.         'imoClass' => 'partial',
  60.         'tankCoating' => 'exact',
  61.         'createdAt' => 'start'
  62.     ],
  63. )]
  64. #[ApiFilter(
  65.     OrderFilter::class,
  66.     properties: [
  67.         'vesselName', 
  68.         'imoNumber', 
  69.         'vesselType',
  70.         'dwt',
  71.         'yearBuilt',
  72.         'imoClass',
  73.         'nitrogenGenerator',
  74.         'boxShape',
  75.         'openHatch',
  76.         'tankCoating',
  77.         'createdAt'
  78.     ],
  79. )]
  80. #[ApiFilter(
  81.     BooleanFilter::class,
  82.     properties: [
  83.         'nitrogenGenerator',
  84.         'boxShape',
  85.         'openHatch',
  86.     ],
  87. )]
  88. #[ApiFilter(PropertyFilter::class)]
  89. class Vessel
  90. {
  91.     use TimestampableEntity;
  93.     public const VESSEL_TYPES = [
  94.         'Tanker',
  95.         'Bulker'
  96.     ];
  98.     public const TANKER_TYPES = [
  99.         'Chemical & Oil Carrier',
  100.         'Product Carrier',
  101.         'Chemical Bulk Tanker',
  102.         'Chemical Parcell Tanker',
  103.         'Asphalt & Bitumen Carrier',
  104.         'Methanol Carrier',
  105.         'Chemical Unknown Carrier',
  106.         'Tanker',
  107.         'Shuttle Tanker',
  108.         'Oil Bunkering Tanker',
  109.         'Products/Multi-Purpose',
  110.         'Cargo'
  111.     ];
  113.     public const BULKER_TYPES = [
  114.         'Aggregates Carrier',
  115.         'Bulk Carrier',
  116.         'Cement Carrier',
  117.         'Deck Cargo Carrier',
  118.         'General Cargo',
  119.         'Gypsum Carrier',
  120.         'Heavy Lift Cargo Vessel',
  121.         'Limestone Carrier',
  122.         'Livestock Carrier',
  123.         'Open Hatch Carrier',
  124.         'Ore & Sulphuric Acid Carrier',
  125.         'Ore Carrier',
  126.         'Ore/Oil Carrier',
  127.         'Salt Carrier',
  128.         'Urea Carrier',
  129.     ];
  131.     public const TANK_COATING = [
  132.         "Epoxy",
  133.         "Zinc",
  134.         "Stainless",
  135.         "Adv. Polymer"
  136.     ];
  137.     
  138.     #[ORM\Id]
  139.     #[ORM\GeneratedValue(strategy: 'NONE')]
  140.     #[ORM\Column(type: 'uuid', unique: true)]
  141.     #[ApiProperty(iri: 'https://schema.org/identifier')]
  142.     #[Groups(['vessel:collection:get', 'vessel:item:get'])]
  143.     private ?UuidInterface $id = null;
  145.     #[ORM\Column(type: 'string', nullable: false)]
  146.     #[Assert\NotNull]
  147.     #[Assert\Type('string')]
  148.     #[ApiProperty(iri: 'https://schema.org/vesselName')]
  149.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put', 'contract:item:get', 'contract:item:put', 'contract:collection:get', 'contract:collection:post'])]
  150.     private ?string $vesselName = null;
  152.     #[ORM\Column(type: 'string', nullable: false)]
  153.     #[Assert\NotNull]
  154.     #[Assert\Type('string')]
  155.     #[ApiProperty(iri: 'https://schema.org/imoNumber')]
  156.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  157.     private ?string $imoNumber = null;
  159.     #[ORM\Column(type: 'string', nullable: false)]
  160.     #[Assert\NotNull]
  161.     #[Assert\Type('string')]
  162.     #[Assert\Choice(choices: self::VESSEL_TYPES, message: 'The type is not valid.')]
  163.     #[ApiProperty(iri: 'https://schema.org/vesselType')]
  164.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  165.     private ?string $vesselType = null;
  167.     #[ORM\Column(type: 'string', nullable: true)]
  168.     #[Assert\Type('string')]
  169.     #[Assert\Choice(choices: self::TANKER_TYPES, message: 'The type is not valid.')]
  170.     #[ApiProperty(iri: 'https://schema.org/tankerType')]
  171.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  172.     private ?string $tankerType = null;
  174.     #[ORM\Column(type: 'string', nullable: true)]
  175.     #[Assert\Type('string')]
  176.     #[Assert\Choice(choices: self::BULKER_TYPES, message: 'The type is not valid.')]
  177.     #[ApiProperty(iri: 'https://schema.org/bulkerType')]
  178.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  179.     private ?string $bulkerType = null;
  181.     #[ORM\Column(type: 'string', nullable: true)]
  182.     #[ApiProperty(iri: 'https://schema.org/tankCoating')]
  183.     #[Assert\Type('string')]
  184.     #[Assert\Choice(choices: self::TANK_COATING, message: 'The option is not valid.')]
  185.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  186.     private ?string $tankCoating = null;
  188.     #[ORM\Column(type: 'string', nullable: false)]
  189.     #[Assert\NotNull]
  190.     #[Assert\Type('string')]
  191.     #[ApiProperty(iri: 'https://schema.org/dwt')]
  192.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  193.     private ?string $dwt = null;
  195.     #[ORM\Column(type: 'integer', nullable: false)]
  196.     #[Assert\NotNull]
  197.     #[Assert\Type('integer')]
  198.     #[ApiProperty(iri: 'https://schema.org/yearBuilt')]
  199.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  200.     private ?int $yearBuilt = null;
  202.     // #[ORM\ManyToMany(targetEntity: 'App\Entity\Document')]
  203.     // #[ORM\InverseJoinColumn(unique: true)]
  204.     // #[ApiProperty(iri: 'https://schema.org/Document')]
  205.     // #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  206.     // private Collection $documents;
  208.     #[ORM\ManyToOne(targetEntity: 'App\Entity\Owner', inversedBy: 'vessels')]
  209.     #[ORM\JoinColumn(nullable: true)]
  210.     #[ApiProperty(iri: 'https://schema.org/Owner')]
  211.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  212.     #[MaxDepth(1)]
  213.     private ?Owner $owner = null;
  215.     #[ORM\Column(type: 'text', nullable: true)]
  216.     #[ApiProperty(iri: 'https://schema.org/observations')]
  217.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  218.     private ?string $observations = null;
  220.     #[ORM\Column(type: 'boolean', nullable: true)]
  221.     #[ApiProperty(iri: 'https://schema.org/BoxShape')]
  222.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  223.     private ?bool $boxShape = null;
  225.     #[ORM\Column(type: 'boolean', nullable: true)]
  226.     #[ApiProperty(iri: 'https://schema.org/OpenHatch')]
  227.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  228.     private ?bool $openHatch = null;
  230.     #[ORM\Column(type: 'boolean', nullable: true)]
  231.     #[ApiProperty(iri: 'https://schema.org/NitrogenGenerator')]
  232.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  233.     private ?bool $nitrogenGenerator = null;
  235.     #[ORM\Column(type: 'integer', nullable: true)]
  236.     #[ApiProperty(iri: 'https://schema.org/imoClass')]
  237.     #[Assert\Type('integer')]
  238.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  239.     private ?int $imoClass = null;
  241.     #[ORM\OneToMany(targetEntity: 'App\Entity\Contract', mappedBy: 'vessel')]
  242.     #[ApiProperty(iri: 'https://schema.org/Contract')]
  243.     #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  244.     #[MaxDepth(1)]
  245.     private ?Collection $contracts = null;
  247.     // #[ORM\OneToMany(targetEntity: 'App\Entity\Lifting', mappedBy: 'vessel')]
  248.     // #[ApiProperty(iri: 'https://schema.org/Lifting')]
  249.     // #[Groups(['vessel:collection:get', 'vessel:collection:post', 'vessel:item:get', 'vessel:item:put'])]
  250.     // #[MaxDepth(1)]
  251.     // private ?Collection $liftings = null;
  253.     public function __construct()
  254.     {
  255.         $this->id = Uuid::uuid4();
  256.         // $this->documents = new ArrayCollection();
  257.         $this->contracts = new ArrayCollection();
  258.         // $this->liftings = new ArrayCollection();
  259.     }
  261.     public function getId(): ?UuidInterface
  262.     {
  263.         return $this->id;
  264.     }
  266.     public function setVesselName(?string $vesselName): void
  267.     {
  268.         $this->vesselName = $vesselName;
  269.     }
  271.     public function getVesselName(): ?string
  272.     {
  273.         return $this->vesselName;
  274.     }
  276.     public function setImoNumber(?string $imoNumber): void
  277.     {
  278.         $this->imoNumber = $imoNumber;
  279.     }
  281.     public function getImoNumber(): ?string
  282.     {
  283.         return $this->imoNumber;
  284.     }
  286.     public function setVesselType(?string $vesselType): void
  287.     {
  288.         $this->vesselType = $vesselType;
  289.     }
  291.     public function getVesselType(): ?string
  292.     {
  293.         return $this->vesselType;
  294.     }
  296.     public function setDwt(?string $dwt): void
  297.     {
  298.         $this->dwt = $dwt;
  299.     }
  301.     public function getDwt(): ?string
  302.     {
  303.         return $this->dwt;
  304.     }
  306.     public function setYearBuilt(?int $yearBuilt): void
  307.     {
  308.         $this->yearBuilt = $yearBuilt;
  309.     }
  311.     public function getYearBuilt(): ?int
  312.     {
  313.         return $this->yearBuilt;
  314.     }
  316.     public function setTankerType(?string $tankerType): void
  317.     {
  318.         $this->tankerType = $tankerType;
  319.     }
  321.     public function getTankerType(): ?string
  322.     {
  323.         return $this->tankerType;
  324.     }
  326.     public function setBulkerType(?string $bulkerType): void
  327.     {
  328.         $this->bulkerType = $bulkerType;
  329.     }
  331.     public function getBulkerType(): ?string
  332.     {
  333.         return $this->bulkerType;
  334.     }
  336.     // public function addDocument(Document $document): void
  337.     // {
  338.     //     $this->documents[] = $document;
  339.     // }
  341.     // public function removeDocument(Document $document): void
  342.     // {
  343.     //     $this->documents->removeElement($document);
  344.     // }
  346.     // public function getDocuments(): Collection
  347.     // {
  348.     //     return $this->documents;
  349.     // }
  351.     public function setOwner(?Owner $owner): void
  352.     {
  353.         $this->owner = $owner;
  354.     }
  356.     public function getOwner(): ?Owner
  357.     {
  358.         return $this->owner;
  359.     }
  361.     public function setObservations(?string $observations): void
  362.     {
  363.         $this->observations = $observations;
  364.     }
  366.     public function getObservations(): ?string
  367.     {
  368.         return $this->observations;
  369.     }
  371.     public function setBoxShape(?bool $boxShape): void
  372.     {
  373.         $this->boxShape = $boxShape;
  374.     }
  376.     public function getBoxShape(): ?bool
  377.     {
  378.         return $this->boxShape;
  379.     }
  381.     public function setOpenHatch(?bool $openHatch): void
  382.     {
  383.         $this->openHatch = $openHatch;
  384.     }
  386.     public function getOpenHatch(): ?bool
  387.     {
  388.         return $this->openHatch;
  389.     }
  391.     public function setNitrogenGenerator(?bool $nitrogenGenerator): void
  392.     {
  393.         $this->nitrogenGenerator = $nitrogenGenerator;
  394.     }
  396.     public function getNitrogenGenerator(): ?bool
  397.     {
  398.         return $this->nitrogenGenerator;
  399.     }
  401.     public function setImoClass(?int $imoClass): void
  402.     {
  403.         $this->imoClass = $imoClass;
  404.     }
  406.     public function getImoClass(): ?int
  407.     {
  408.         return $this->imoClass;
  409.     }
  411.     public function setTankCoating(?string $tankCoating): void
  412.     {
  413.         $this->tankCoating = $tankCoating;
  414.     }
  416.     public function getTankCoating(): ?string
  417.     {
  418.         return $this->tankCoating;
  419.     }
  421.     public function getContracts(): Collection
  422.     {
  423.         return $this->contracts;
  424.     }
  426.     public function addContract(Contract $contract): self
  427.     {
  428.         if (!$this->contracts->contains($contract)) {
  429.             $this->contracts[] = $contract;
  430.             $contract->setVessel($this);
  431.         }
  433.         return $this;
  434.     }
  436.     public function removeContract(Contract $contract): self
  437.     {
  438.         if ($this->contracts->removeElement($contract)) {
  439.             if ($contract->getVessel() === $this) {
  440.                 $contract->setVessel(null);
  441.             }
  442.         }
  443.         
  444.         return $this;
  445.     }
  447.     // public function getLiftings(): Collection
  448.     // {
  449.     //     return $this->liftings;
  450.     // }
  452.     // public function addLifting(Lifting $lifting): self
  453.     // {
  454.     //     if (!$this->liftings->contains($lifting)) {
  455.     //         $this->liftings[] = $lifting;
  456.     //         $lifting->setVessel($this);
  457.     //     }
  459.     //     return $this;
  460.     // }
  462.     // public function removeLifting(Lifting $lifting): self
  463.     // {
  464.     //     if ($this->liftings->removeElement($lifting)) {
  465.     //         if ($lifting->getVessel() === $this) {
  466.     //             $lifting->setVessel(null);
  467.     //         }
  468.     //     }
  469.         
  470.     //     return $this;
  471.     // }
  472. }