src/Entity/Cargo.php line 123

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\Serializer\Filter\PropertyFilter;
13. use App\Trait\TimestampableEntity;
14. use Doctrine\Common\Collections\ArrayCollection;
15. use Doctrine\Common\Collections\Collection;
16. use Doctrine\ORM\Mapping as ORM;
17. use Symfony\Component\Serializer\Annotation\Groups;
18. use Symfony\Component\Validator\Constraints as Assert;
19. use Ramsey\Uuid\Uuid;
20. use Ramsey\Uuid\UuidInterface;
22. #[ORM\Entity]
23. #[ApiResource(
24.     iri: 'Cargo',
25.     itemOperations: [
26.         'get' => [
27.             'security' => "
28.                 is_granted('ROLE_ADMIN') or 
29.                 is_granted('ROLE_OPERATOR') or
30.                 is_granted('ROLE_OPERATIONS_COORDINATOR') or 
31.                 is_granted('ROLE_RESEARCH_ANALYST') or
32.                 is_granted('ROLE_BROKER') or 
33.                 is_granted('ROLE_INTERN')
34.             ",
35.             'normalization_context' => [
36.                 'groups' => 'cargo:item:get', 
37.                 'enable_max_depth' => true
38.             ]
39.         ],
40.         'put' => [
41.             'security' => "
42.                 is_granted('ROLE_ADMIN') or 
43.                 is_granted('ROLE_OPERATOR') or
44.                 is_granted('ROLE_OPERATIONS_COORDINATOR') or 
45.                 is_granted('ROLE_RESEARCH_ANALYST') or 
46.                 is_granted('ROLE_BROKER')
47.             ",
48.             'normalization_context' => [
49.                 'groups' => 'cargo:item:put', 
50.                 'enable_max_depth' => true
51.             ],
52.             'denormalization_context' => [
53.                 'groups' => 'cargo:item:put', 
54.                 'enable_max_depth' => true
55.             ],
56.         ],
57.         'delete' => [
58.             'security' => "
59.                 is_granted('ROLE_ADMIN') or 
60.                 is_granted('ROLE_OPERATOR') or
61.                 is_granted('ROLE_OPERATIONS_COORDINATOR') or 
62.                 is_granted('ROLE_RESEARCH_ANALYST') or 
63.                 is_granted('ROLE_BROKER')
64.             ",
65.         ],
66.     ],
67.     collectionOperations: [
68.         'get' => [
69.             'security' => "
70.                 is_granted('ROLE_ADMIN') or 
71.                 is_granted('ROLE_OPERATOR') or
72.                 is_granted('ROLE_OPERATIONS_COORDINATOR') or 
73.                 is_granted('ROLE_RESEARCH_ANALYST') or
74.                 is_granted('ROLE_BROKER') or 
75.                 is_granted('ROLE_INTERN')
76.             ",
77.             'normalization_context' => [
78.                 'groups' => [
79.                     'cargo:collection:get', 
80.                     'createdAt'
81.                 ], 
82.                 'enable_max_depth' => true
83.             ],
84.         ],
85.         'post' => [
86.             'security' => "
87.                 is_granted('ROLE_ADMIN') or 
88.                 is_granted('ROLE_OPERATOR') or
89.                 is_granted('ROLE_OPERATIONS_COORDINATOR') or 
90.                 is_granted('ROLE_RESEARCH_ANALYST') or 
91.                 is_granted('ROLE_BROKER')
92.             ",
93.             'normalization_context' => [
94.                 'groups' => 'cargo:collection:post', 
95.                 'enable_max_depth' => true
96.             ],
97.             'denormalization_context' => [
98.                 'groups' => 'cargo:collection:post', 
99.                 'enable_max_depth' => true
100.             ],
101.         ],
102.     ],
103. )]
104. #[ApiFilter(
105.     SearchFilter::class,
106.     properties: [
107.         'name' => 'partial', 
108.         'cargoType' => 'exact', 
109.         'subtype' => 'exact', 
110.         'createdAt' => 'start'
111.     ],
112. )]
113. #[ApiFilter(
114.     OrderFilter::class,
115.     properties: [
116.         'name', 
117.         'cargoType', 
118.         'subtype', 
119.         'createdAt'
120.     ],
121. )]
122. #[ApiFilter(PropertyFilter::class)]
123. class Cargo
124. {
125.     use TimestampableEntity;
127.     public const CARGO_TYPE_LIQUID = 'Liquid';
128.     public const CARGO_TYPE_DRY = 'Dry';
129.     
130.     public const CARGO_TYPES = [
131.         self::CARGO_TYPE_LIQUID,
132.         self::CARGO_TYPE_DRY,
133.     ];
135.     public const CARGO_SUBTYPE_LIQUID = 'Bulk Cargo';
136.     public const CARGO_SUBTYPE_DRY = 'Bagged Cargo';
137.     public const CARGO_SUBTYPE_GENERAL = 'General Cargo';
138.     public const CARGO_SUBTYPE_LIQUID_CPP = 'Liquid Cargo / CPP - Clean Petroleum Products';
139.     public const CARGO_SUBTYPE_LIQUID_CHEMICAL = 'Liquid Cargo / Chemical';
140.     public const CARGO_SUBTYPE_LIQUID_DPP = 'Liquid Cargo / DPP - Dirty Petroleum Products';
142.     public const CARGO_SUBTYPES = [
143.         self::CARGO_SUBTYPE_LIQUID,
144.         self::CARGO_SUBTYPE_DRY,
145.         self::CARGO_SUBTYPE_GENERAL,
146.         self::CARGO_SUBTYPE_LIQUID_CPP,
147.         self::CARGO_SUBTYPE_LIQUID_CHEMICAL,
148.         self::CARGO_SUBTYPE_LIQUID_DPP,
149.     ];
150.     
151.     #[ORM\Id]
152.     #[ORM\GeneratedValue(strategy: 'NONE')]
153.     #[ORM\Column(type: 'uuid', unique: true)]
154.     private ?UuidInterface $id = null;
156.     #[ORM\Column(type: 'string', nullable: false)]
157.     #[ApiProperty()]
158.     #[Assert\NotBlank]
159.     #[Assert\Type('string')]
160.     #[Groups([
161.         'cargo:collection:get', 
162.         'cargo:collection:post', 
163.         'cargo:item:get', 
164.         'cargo:item:put', 
165.         'contract:item:get', 
166.         'contract:item:put', 
167.         'contract:collection:get', 
168.         'contract:collection:post',
169.         'market_rumor:item:get', 
170.         'market_rumor:item:put', 
171.         'market_rumor:collection:get', 
172.         'market_rumor:collection:post'
173.     ])]
174.     private ?string $name = null;
176.     #[ORM\Column(type: 'string', nullable: false)]
177.     #[Assert\NotNull]
178.     #[Assert\Type('string')]
179.     #[Assert\Choice(
180.         choices: self::CARGO_TYPES, 
181.         message: 'The type is not valid.'
182.     )]
183.     #[ApiProperty()]
184.     #[Groups([
185.         'cargo:collection:get', 
186.         'cargo:collection:post', 
187.         'cargo:item:get', 
188.         'cargo:item:put'
189.     ])]
190.     private ?string $cargoType = null;
192.     #[ORM\Column(type: 'string', nullable: true)]
193.     ##[Assert\NotNull]
194.     ##[Assert\Type('string')]
195.     #[Assert\Choice(
196.         choices: self::CARGO_SUBTYPES, 
197.         message: 'The subtype is not valid.'
198.     )]
199.     #[ApiProperty()]
200.     #[Groups([
201.         'cargo:collection:get', 
202.         'cargo:collection:post', 
203.         'cargo:item:get', 
204.         'cargo:item:put'
205.     ])]
206.     private ?string $subtype = null;
208.     #[ORM\Column(type: 'text', nullable: true)]
209.     #[ApiProperty()]
210.     #[Groups([
211.         // 'cargo:collection:get', 
212.         'cargo:collection:post', 
213.         'cargo:item:get', 
214.         'cargo:item:put'
215.     ])]
216.     private ?string $observations = null;
218.     #[ORM\OneToMany(
219.         targetEntity: ContractCargo::class, 
220.         mappedBy: 'cargo'
221.     )]
222.     // #[ApiProperty()]
223.     // #[Groups([
224.     //     'cargo:collection:get', 
225.     //     'cargo:collection:post', 
226.     //     'cargo:item:get', 
227.     //     'cargo:item:put'
228.     // ])]
229.     // #[MaxDepth(1)]
230.     private ?Collection $contractCargos = null;
232.     #[ORM\OneToMany(
233.         targetEntity: MarketRumorCargo::class, 
234.         mappedBy: 'cargo'
235.     )]
236.     // #[ApiProperty()]
237.     // #[Groups([
238.     //     'cargo:collection:get', 
239.     //     'cargo:collection:post', 
240.     //     'cargo:item:get', 
241.     //     'cargo:item:put'
242.     // ])]
243.     // #[MaxDepth(1)]
244.     private ?Collection $marketRumorCargos = null;
246.     public function __construct()
247.     {
248.         $this->id = Uuid::uuid4();
249.         $this->contractCargos = new ArrayCollection();
250.         $this->marketRumorCargos = new ArrayCollection();
251.     }
253.     public function getId(): ?UuidInterface
254.     {
255.         return $this->id;
256.     }
258.     public function setName(?string $name): void
259.     {
260.         $this->name = $name;
261.     }
263.     public function getName(): ?string
264.     {
265.         return $this->name;
266.     }
268.     public function setSubtype(?string $subtype): void
269.     {
270.         $this->subtype = $subtype;
271.     }
273.     public function getSubtype(): ?string
274.     {
275.         return $this->subtype;
276.     }
278.     public function setCargoType(?string $cargoType): void
279.     {
280.         $this->cargoType = $cargoType;
281.     }
283.     public function getCargoType(): ?string
284.     {
285.         return $this->cargoType;
286.     }
288.     public function setObservations(?string $observations): void
289.     {
290.         $this->observations = $observations;
291.     }
293.     public function getObservations(): ?string
294.     {
295.         return $this->observations;
296.     }
297.     
298.     public function addContractCargo(ContractCargo $contractCargo): void
299.     {
300.         $this->contractCargos[] = $contractCargo;
301.     }
303.     public function removeContractCargo(ContractCargo $contractCargo): void
304.     {
305.         $this->contractCargos->removeElement($contractCargo);
306.     }
308.     public function getContractCargos(): Collection
309.     {
310.         return $this->contractCargos;
311.     }
313.     public function addMarketRumorCargo(MarketRumorCargo $marketRumorCargo): void
314.     {
315.         $this->marketRumorCargos[] = $marketRumorCargo;
316.     }
318.     public function removeMarketRumorCargo(MarketRumorCargo $marketRumorCargo): void
319.     {
320.         $this->marketRumorCargos->removeElement($marketRumorCargo);
321.     }
323.     public function getMarketRumorCargos(): Collection
324.     {
325.         return $this->marketRumorCargos;
326.     }
327. }