src/Entity/Vessel.php line 144

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 Symfony\Component\Serializer\Annotation\Groups;
  19. use Symfony\Component\Validator\Constraints as Assert;
  20. use Symfony\Component\Serializer\Annotation\MaxDepth;
  21. use Ramsey\Uuid\Uuid;
  22. use Ramsey\Uuid\UuidInterface;
  24. #[ORM\Entity]
  25. #[ApiResource(
  26.     iri: 'Vessel',
  27.     itemOperations: [
  28.         'get' => [
  29.             'security' => "
  30.                 is_granted('ROLE_ADMIN') or 
  31.                 is_granted('ROLE_OPERATOR') or
  32.                 is_granted('ROLE_OPERATIONS_COORDINATOR') or 
  33.                 is_granted('ROLE_RESEARCH_ANALYST') or
  34.                 is_granted('ROLE_BROKER') or 
  35.                 is_granted('ROLE_INTERN')
  36.             ",
  37.             'normalization_context' => [
  38.                 'groups' => 'vessel:item:get', 
  39.                 'enable_max_depth' => true
  40.             ]
  41.         ],
  42.         'put' => [
  43.             'security' => "
  44.                 is_granted('ROLE_ADMIN') or 
  45.                 is_granted('ROLE_OPERATOR') or
  46.                 is_granted('ROLE_OPERATIONS_COORDINATOR') or 
  47.                 is_granted('ROLE_RESEARCH_ANALYST') or 
  48.                 is_granted('ROLE_BROKER')
  49.             ",
  50.             'normalization_context' => [
  51.                 'groups' => 'vessel:item:put', 
  52.                 'enable_max_depth' => true
  53.             ],
  54.             'denormalization_context' => [
  55.                 'groups' => 'vessel:item:put', 
  56.                 'enable_max_depth' => true
  57.             ],
  58.         ],
  59.         'delete' => [
  60.             'security' => "
  61.                 is_granted('ROLE_ADMIN') or 
  62.                 is_granted('ROLE_OPERATOR') or
  63.                 is_granted('ROLE_OPERATIONS_COORDINATOR') or 
  64.                 is_granted('ROLE_RESEARCH_ANALYST') or 
  65.                 is_granted('ROLE_BROKER')
  66.             ",
  67.         ],
  68.     ],
  69.     collectionOperations: [
  70.         'get' => [
  71.             'security' => "
  72.                 is_granted('ROLE_ADMIN') or 
  73.                 is_granted('ROLE_OPERATOR') or
  74.                 is_granted('ROLE_OPERATIONS_COORDINATOR') or 
  75.                 is_granted('ROLE_RESEARCH_ANALYST') or
  76.                 is_granted('ROLE_BROKER') or 
  77.                 is_granted('ROLE_INTERN')
  78.             ",
  79.             'normalization_context' => [
  80.                 'groups' => [
  81.                     'vessel:collection:get', 
  82.                     'createdAt'
  83.                 ], 
  84.                 'enable_max_depth' => true
  85.             ],
  86.         ],
  87.         'post' => [
  88.             'security' => "
  89.                 is_granted('ROLE_ADMIN') or 
  90.                 is_granted('ROLE_OPERATOR') or
  91.                 is_granted('ROLE_OPERATIONS_COORDINATOR') or 
  92.                 is_granted('ROLE_RESEARCH_ANALYST') or 
  93.                 is_granted('ROLE_BROKER')
  94.             ",
  95.             'normalization_context' => [
  96.                 'groups' => 'vessel:collection:post', 
  97.                 'enable_max_depth' => true
  98.             ],
  99.             'denormalization_context' => [
  100.                 'groups' => 'vessel:collection:post', 
  101.                 'enable_max_depth' => true
  102.             ],
  103.         ],
  104.     ],
  105. )]
  106. #[ApiFilter(
  107.     SearchFilter::class,
  108.     properties: [
  109.         'vesselName' => 'partial', 
  110.         'imoNumber' => 'partial', 
  111.         'vesselType' => 'exact',
  112.         'dwt' => 'partial',
  113.         'yearBuilt' => 'exact',
  114.         'imoClass' => 'partial',
  115.         'tankCoating' => 'exact',
  116.         'createdAt' => 'start'
  117.     ],
  118. )]
  119. #[ApiFilter(
  120.     OrderFilter::class,
  121.     properties: [
  122.         'vesselName', 
  123.         'imoNumber', 
  124.         'vesselType',
  125.         'dwt',
  126.         'yearBuilt',
  127.         'imoClass',
  128.         'nitrogenGenerator',
  129.         'boxShape',
  130.         'openHatch',
  131.         'tankCoating',
  132.         'createdAt'
  133.     ],
  134. )]
  135. #[ApiFilter(
  136.     BooleanFilter::class,
  137.     properties: [
  138.         'nitrogenGenerator',
  139.         'boxShape',
  140.         'openHatch',
  141.     ],
  142. )]
  143. #[ApiFilter(PropertyFilter::class)]
  144. class Vessel
  145. {
  146.     use TimestampableEntity;
  148.     public const VESSEL_TYPE_TANKER = 'Tanker';
  149.     public const VESSEL_TYPE_BULKER = 'Bulker';
  151.     public const VESSEL_TYPES = [
  152.         self::VESSEL_TYPE_TANKER,
  153.         self::VESSEL_TYPE_BULKER,
  154.     ];
  156.     public const TANKER_TYPE_CHEMICAL = 'Chemical & Oil Carrier';
  157.     public const TANKER_TYPE_PRODUCT = 'Product Carrier';
  158.     public const TANKER_TYPE_CHEMICAL_BULK = 'Chemical Bulk Tanker';
  159.     public const TANKER_TYPE_CHEMICAL_PARCEL = 'Chemical Parcell Tanker';
  160.     public const TANKER_TYPE_ASPHALT_BITUMEN = 'Asphalt & Bitumen Carrier';
  161.     public const TANKER_TYPE_METHANOL = 'Methanol Carrier';
  162.     public const TANKER_TYPE_CHEMICAL_UNKNOWN = 'Chemical Unknown Carrier';
  163.     public const TANKER_TYPE_TANKER = 'Tanker';
  164.     public const TANKER_TYPE_SHUTTLE = 'Shuttle Tanker';
  165.     public const TANKER_TYPE_OIL_BUNKERING = 'Oil Bunkering Tanker';
  166.     public const TANKER_TYPE_PRODUCTS_MULTI_PURPOSE = 'Products/Multi-Purpose';
  167.     public const TANKER_TYPE_CARGO = 'Cargo';
  169.     public const TANKER_TYPES = [
  170.         self::TANKER_TYPE_CHEMICAL,
  171.         self::TANKER_TYPE_PRODUCT,
  172.         self::TANKER_TYPE_CHEMICAL_BULK,
  173.         self::TANKER_TYPE_CHEMICAL_PARCEL,
  174.         self::TANKER_TYPE_ASPHALT_BITUMEN,
  175.         self::TANKER_TYPE_METHANOL,
  176.         self::TANKER_TYPE_CHEMICAL_UNKNOWN,
  177.         self::TANKER_TYPE_TANKER,
  178.         self::TANKER_TYPE_SHUTTLE,
  179.         self::TANKER_TYPE_OIL_BUNKERING,
  180.         self::TANKER_TYPE_PRODUCTS_MULTI_PURPOSE,
  181.         self::TANKER_TYPE_CARGO,
  182.     ];
  184.     public const BULKER_TYPE_AGGREGATES = 'Aggregates Carrier';
  185.     public const BULKER_TYPE_BULK = 'Bulk Carrier';
  186.     public const BULKER_TYPE_CEMENT = 'Cement Carrier';
  187.     public const BULKER_TYPE_DECK = 'Deck Cargo Carrier';
  188.     public const BULKER_TYPE_GENERAL = 'General Cargo';
  189.     public const BULKER_TYPE_GYPSUM = 'Gypsum Carrier';
  190.     public const BULKER_TYPE_HEAVY_LIFT = 'Heavy Lift Cargo Vessel';
  191.     public const BULKER_TYPE_LIMESTONE = 'Limestone Carrier';
  192.     public const BULKER_TYPE_LIVESTOCK = 'Livestock Carrier';
  193.     public const BULKER_TYPE_OPEN_HATCH = 'Open Hatch Carrier';
  194.     public const BULKER_TYPE_ORE_SULPHURIC_ACID = 'Ore & Sulphuric Acid Carrier';
  195.     public const BULKER_TYPE_ORE = 'Ore Carrier';
  196.     public const BULKER_TYPE_ORE_OIL = 'Ore/Oil Carrier';
  197.     public const BULKER_TYPE_SALT = 'Salt Carrier';
  198.     public const BULKER_TYPE_UREA = 'Urea Carrier';
  200.     public const BULKER_TYPES = [
  201.         self::BULKER_TYPE_AGGREGATES,
  202.         self::BULKER_TYPE_BULK,
  203.         self::BULKER_TYPE_CEMENT,
  204.         self::BULKER_TYPE_DECK,
  205.         self::BULKER_TYPE_GENERAL,
  206.         self::BULKER_TYPE_GYPSUM,
  207.         self::BULKER_TYPE_HEAVY_LIFT,
  208.         self::BULKER_TYPE_LIMESTONE,
  209.         self::BULKER_TYPE_LIVESTOCK,
  210.         self::BULKER_TYPE_OPEN_HATCH,
  211.         self::BULKER_TYPE_ORE_SULPHURIC_ACID,
  212.         self::BULKER_TYPE_ORE,
  213.         self::BULKER_TYPE_ORE_OIL,
  214.         self::BULKER_TYPE_SALT,
  215.         self::BULKER_TYPE_UREA,
  216.     ];
  218.     public const TANK_COATING_EPOXY = 'Epoxy';
  219.     public const TANK_COATING_ZINC = 'Zinc';
  220.     public const TANK_COATING_STAINLESS = 'Stainless';
  221.     public const TANK_COATING_ADV_POLYMER = 'Adv. Polymer';
  223.     public const TANK_COATING = [
  224.         self::TANK_COATING_EPOXY,
  225.         self::TANK_COATING_ZINC,
  226.         self::TANK_COATING_STAINLESS,
  227.         self::TANK_COATING_ADV_POLYMER,
  228.     ];
  229.     
  230.     #[ORM\Id]
  231.     #[ORM\GeneratedValue(strategy: 'NONE')]
  232.     #[ORM\Column(type: 'uuid', unique: true)]
  233.     private ?UuidInterface $id = null;
  235.     #[ORM\Column(type: 'string', nullable: false)]
  236.     #[Assert\NotNull]
  237.     #[Assert\Type('string')]
  238.     #[ApiProperty()]
  239.     #[Groups([
  240.         'vessel:collection:get', 
  241.         'vessel:collection:post', 
  242.         'vessel:item:get', 
  243.         'vessel:item:put', 
  244.         'contract:item:get', 
  245.         'contract:item:put', 
  246.         'contract:collection:get', 
  247.         'contract:collection:post',
  248.         'market_rumor:item:get', 
  249.         'market_rumor:item:put', 
  250.         'market_rumor:collection:get', 
  251.         'market_rumor:collection:post'
  252.     ])]
  253.     private ?string $vesselName = null;
  255.     #[ORM\Column(type: 'string', nullable: true)]
  256.     ##[Assert\NotNull]
  257.     ##[Assert\Type('string')]
  258.     #[ApiProperty()]
  259.     #[Groups([
  260.         'vessel:collection:get', 
  261.         'vessel:collection:post', 
  262.         'vessel:item:get', 
  263.         'vessel:item:put'
  264.     ])]
  265.     private ?string $imoNumber = null;
  267.     #[ORM\Column(type: 'string', nullable: false)]
  268.     #[Assert\NotNull]
  269.     #[Assert\Type('string')]
  270.     #[Assert\Choice(
  271.         choices: self::VESSEL_TYPES, 
  272.         message: 'The type is not valid.'
  273.     )]
  274.     #[ApiProperty()]
  275.     #[Groups([
  276.         'vessel:collection:get', 
  277.         'vessel:collection:post', 
  278.         'vessel:item:get', 
  279.         'vessel:item:put'
  280.     ])]
  281.     private ?string $vesselType = null;
  283.     #[ORM\Column(type: 'string', nullable: true)]
  284.     ##[Assert\Type('string')]
  285.     #[Assert\Choice(
  286.         choices: self::TANKER_TYPES, 
  287.         message: 'The type is not valid.'
  288.     )]
  289.     #[ApiProperty()]
  290.     #[Groups([
  291.         // 'vessel:collection:get', 
  292.         'vessel:collection:post', 
  293.         'vessel:item:get', 
  294.         'vessel:item:put'
  295.     ])]
  296.     private ?string $tankerType = null;
  298.     #[ORM\Column(type: 'string', nullable: true)]
  299.     ##[Assert\Type('string')]
  300.     #[Assert\Choice(
  301.         choices: self::BULKER_TYPES, 
  302.         message: 'The type is not valid.'
  303.     )]
  304.     #[ApiProperty()]
  305.     #[Groups([
  306.         // 'vessel:collection:get', 
  307.         'vessel:collection:post', 
  308.         'vessel:item:get', 
  309.         'vessel:item:put'
  310.     ])]
  311.     private ?string $bulkerType = null;
  313.     #[ORM\Column(type: 'string', nullable: true)]
  314.     #[ApiProperty()]
  315.     ##[Assert\Type('string')]
  316.     #[Assert\Choice(
  317.         choices: self::TANK_COATING, 
  318.         message: 'The option is not valid.'
  319.     )]
  320.     #[Groups([
  321.         'vessel:collection:get', 
  322.         'vessel:collection:post', 
  323.         'vessel:item:get', 
  324.         'vessel:item:put'
  325.     ])]
  326.     private ?string $tankCoating = null;
  328.     #[ORM\Column(type: 'string', nullable: true)]
  329.     ##[Assert\NotNull]
  330.     ##[Assert\Type('string')]
  331.     #[ApiProperty()]
  332.     #[Groups([
  333.         'vessel:collection:get', 
  334.         'vessel:collection:post', 
  335.         'vessel:item:get', 
  336.         'vessel:item:put'
  337.     ])]
  338.     private ?string $dwt = null;
  340.     #[ORM\Column(type: 'integer', nullable: true)]
  341.     ##[Assert\NotNull]
  342.     ##[Assert\Type('integer')]
  343.     #[ApiProperty()]
  344.     #[Groups([
  345.         'vessel:collection:get', 
  346.         'vessel:collection:post', 
  347.         'vessel:item:get', 
  348.         'vessel:item:put'
  349.     ])]
  350.     private ?int $yearBuilt = null;
  352.     #[ORM\ManyToOne(
  353.         targetEntity: Owner::class, 
  354.         inversedBy: 'vessels'
  355.     )]
  356.     #[ORM\JoinColumn(nullable: true)]
  357.     #[ApiProperty()]
  358.     #[Groups([
  359.         // 'vessel:collection:get', 
  360.         'vessel:collection:post', 
  361.         'vessel:item:get', 
  362.         'vessel:item:put'
  363.     ])]
  364.     #[MaxDepth(1)]
  365.     private ?Owner $owner = null;
  367.     #[ORM\Column(type: 'text', nullable: true)]
  368.     #[ApiProperty()]
  369.     #[Groups([
  370.         // 'vessel:collection:get', 
  371.         'vessel:collection:post', 
  372.         'vessel:item:get', 
  373.         'vessel:item:put'
  374.     ])]
  375.     private ?string $observations = null;
  377.     #[ORM\Column(type: 'boolean', nullable: true)]
  378.     #[ApiProperty()]
  379.     #[Groups([
  380.         'vessel:collection:get', 
  381.         'vessel:collection:post', 
  382.         'vessel:item:get', 
  383.         'vessel:item:put'
  384.     ])]
  385.     private ?bool $boxShape = false;
  387.     #[ORM\Column(type: 'boolean', nullable: true)]
  388.     #[ApiProperty()]
  389.     #[Groups([
  390.         'vessel:collection:get', 
  391.         'vessel:collection:post', 
  392.         'vessel:item:get', 
  393.         'vessel:item:put'
  394.     ])]
  395.     private ?bool $openHatch = false;
  397.     #[ORM\Column(type: 'boolean', nullable: true)]
  398.     #[ApiProperty()]
  399.     #[Groups([
  400.         'vessel:collection:get', 
  401.         'vessel:collection:post', 
  402.         'vessel:item:get', 
  403.         'vessel:item:put'
  404.     ])]
  405.     private ?bool $nitrogenGenerator = false;
  407.     #[ORM\Column(type: 'integer', nullable: true)]
  408.     #[ApiProperty()]
  409.     ##[Assert\Type('integer')]
  410.     #[Groups([
  411.         'vessel:collection:get', 
  412.         'vessel:collection:post', 
  413.         'vessel:item:get', 
  414.         'vessel:item:put'
  415.     ])]
  416.     private ?int $imoClass = null;
  418.     #[ORM\OneToMany(
  419.         targetEntity: Contract::class, 
  420.         mappedBy: 'vessel'
  421.     )]
  422.     private ?Collection $contracts = null;
  424.     #[ORM\OneToMany(
  425.         targetEntity: MarketRumor::class, 
  426.         mappedBy: 'vessel'
  427.     )]
  428.     private ?Collection $marketRumors = null;
  430.     public function __construct()
  431.     {
  432.         $this->id = Uuid::uuid4();
  433.         $this->contracts = new ArrayCollection();
  434.         $this->marketRumors = new ArrayCollection();
  435.     }
  437.     public function getId(): ?UuidInterface
  438.     {
  439.         return $this->id;
  440.     }
  442.     public function setVesselName(?string $vesselName): void
  443.     {
  444.         $this->vesselName = $vesselName;
  445.     }
  447.     public function getVesselName(): ?string
  448.     {
  449.         return $this->vesselName;
  450.     }
  452.     public function setImoNumber(?string $imoNumber): void
  453.     {
  454.         $this->imoNumber = $imoNumber;
  455.     }
  457.     public function getImoNumber(): ?string
  458.     {
  459.         return $this->imoNumber;
  460.     }
  462.     public function setVesselType(?string $vesselType): void
  463.     {
  464.         $this->vesselType = $vesselType;
  465.     }
  467.     public function getVesselType(): ?string
  468.     {
  469.         return $this->vesselType;
  470.     }
  472.     public function setDwt(?string $dwt): void
  473.     {
  474.         $this->dwt = $dwt;
  475.     }
  477.     public function getDwt(): ?string
  478.     {
  479.         return $this->dwt;
  480.     }
  482.     public function setYearBuilt(?int $yearBuilt): void
  483.     {
  484.         $this->yearBuilt = $yearBuilt;
  485.     }
  487.     public function getYearBuilt(): ?int
  488.     {
  489.         return $this->yearBuilt;
  490.     }
  492.     public function setTankerType(?string $tankerType): void
  493.     {
  494.         $this->tankerType = $tankerType;
  495.     }
  497.     public function getTankerType(): ?string
  498.     {
  499.         return $this->tankerType;
  500.     }
  502.     public function setBulkerType(?string $bulkerType): void
  503.     {
  504.         $this->bulkerType = $bulkerType;
  505.     }
  507.     public function getBulkerType(): ?string
  508.     {
  509.         return $this->bulkerType;
  510.     }
  512.     public function setOwner(?Owner $owner): void
  513.     {
  514.         $this->owner = $owner;
  515.     }
  517.     public function getOwner(): ?Owner
  518.     {
  519.         return $this->owner;
  520.     }
  522.     public function setObservations(?string $observations): void
  523.     {
  524.         $this->observations = $observations;
  525.     }
  527.     public function getObservations(): ?string
  528.     {
  529.         return $this->observations;
  530.     }
  532.     public function setBoxShape(?bool $boxShape): void
  533.     {
  534.         $this->boxShape = $boxShape;
  535.     }
  537.     public function getBoxShape(): ?bool
  538.     {
  539.         return $this->boxShape ?? false;
  540.     }
  542.     public function setOpenHatch(?bool $openHatch): void
  543.     {
  544.         $this->openHatch = $openHatch;
  545.     }
  547.     public function getOpenHatch(): ?bool
  548.     {
  549.         return $this->openHatch ?? false;
  550.     }
  552.     public function setNitrogenGenerator(?bool $nitrogenGenerator): void
  553.     {
  554.         $this->nitrogenGenerator = $nitrogenGenerator;
  555.     }
  557.     public function getNitrogenGenerator(): ?bool
  558.     {
  559.         return $this->nitrogenGenerator ?? false;
  560.     }
  562.     public function setImoClass(?int $imoClass): void
  563.     {
  564.         $this->imoClass = $imoClass;
  565.     }
  567.     public function getImoClass(): ?int
  568.     {
  569.         return $this->imoClass;
  570.     }
  572.     public function setTankCoating(?string $tankCoating): void
  573.     {
  574.         $this->tankCoating = $tankCoating;
  575.     }
  577.     public function getTankCoating(): ?string
  578.     {
  579.         return $this->tankCoating;
  580.     }
  582.     public function getContracts(): Collection
  583.     {
  584.         return $this->contracts;
  585.     }
  587.     public function addContract(Contract $contract): self
  588.     {
  589.         if (!$this->contracts->contains($contract)) {
  590.             $this->contracts[] = $contract;
  591.             $contract->setVessel($this);
  592.         }
  594.         return $this;
  595.     }
  597.     public function removeContract(Contract $contract): self
  598.     {
  599.         if ($this->contracts->removeElement($contract)) {
  600.             if ($contract->getVessel() === $this) {
  601.                 $contract->setVessel(null);
  602.             }
  603.         }
  604.         
  605.         return $this;
  606.     }
  608.     public function getMarketRumors(): Collection
  609.     {
  610.         return $this->marketRumors;
  611.     }
  613.     public function addMarketRumor(MarketRumor $marketRumor): self
  614.     {
  615.         if (!$this->marketRumors->contains($marketRumor)) {
  616.             $this->marketRumors[] = $marketRumor;
  617.             $marketRumor->setVessel($this);
  618.         }
  620.         return $this;
  621.     }
  623.     public function removeMarketRumor(MarketRumor $marketRumor): self
  624.     {
  625.         if ($this->marketRumors->removeElement($marketRumor)) {
  626.             if ($marketRumor->getVessel() === $this) {
  627.                 $marketRumor->setVessel(null);
  628.             }
  629.         }
  630.         
  631.         return $this;
  632.     }
  633. }