Feature/embedded entities

api/src/Entity/BaseEntity.php

@@ -7,6 +7,7 @@
 use DateTime;
 use Doctrine\ORM\Mapping as ORM;
 use Gedmo\Mapping\Annotation as Gedmo;
+use Symfony\Component\Serializer\Annotation\Groups;
 
 /**
  * @ORM\MappedSuperclass
@@ -25,6 +26,7 @@ abstract class BaseEntity {
      * @ORM\CustomIdGenerator(class=IdGenerator::class)
      */
     #[ApiProperty(writable: false, example: '1a2b3c4d')]
+    #[Groups(['read'])]
     protected string $id;
 
     /**

api/src/Entity/Camp.php

@@ -25,20 +25,38 @@
         'post' => [
             'security' => 'is_fully_authenticated()',
             'input_formats' => ['jsonld', 'jsonapi', 'json'],
-            'validation_groups' => ['Default', 'camp:create'],
+            'validation_groups' => ['Default', 'Camp:create'],
+            'denormalization_context' => [
+                'groups' => ['write', 'create', 'Camp:Periods'],
+                'allow_extra_attributes' => false,
+            ],
         ],
     ],
     itemOperations: [
-        'get' => ['security' => 'object.owner == user or is_granted("ROLE_ADMIN")'],
+        'get' => [
+            'security' => 'object.owner == user or is_granted("ROLE_ADMIN")',
+            'normalization_context' => [
+                'groups' => ['read', 'Camp:Periods', 'Period:Days'],
+                'allow_extra_attributes' => false,
+            ],
+        ],
         'patch' => [
             'security' => 'object.owner == user or is_granted("ROLE_ADMIN")',
             'denormalization_context' => [
-                'groups' => ['camp:update'],
+                'groups' => ['write', 'update'],
                 'allow_extra_attributes' => false,
             ],
         ],
         'delete' => ['security' => 'object.owner == user or is_granted("ROLE_ADMIN")'],
-    ]
+    ],
+    normalizationContext: [
+        'groups' => ['read'],
+        'allow_extra_attributes' => false,
+    ],
+    denormalizationContext: [
+        'groups' => ['write'],
+        'allow_extra_attributes' => false,
+    ],
 )]
 class Camp extends BaseEntity implements BelongsToCampInterface {
     /**
@@ -56,9 +74,13 @@ class Camp extends BaseEntity implements BelongsToCampInterface {
      * @ORM\OrderBy({"start": "ASC"})
      */
     #[Assert\Valid]
-    #[Assert\Count(min: 1, groups: ['camp:create'])]
-    #[ApiProperty(writableLink: true, example: '[{ "description": "Hauptlager", "start": "2022-01-01", "end": "2022-01-08" }]')]
-    #[Groups(['Default'])]
+    #[Assert\Count(min: 1, groups: ['Camp:create'])]
+    #[ApiProperty(
+        readableLink: false,
+        writableLink: true,
+        example: '/periods?camp=/camps/1a2b3c4d',
+    )]
+    #[Groups(['read', 'create'])]
     public Collection $periods;
 
     /**
@@ -116,7 +138,7 @@ class Camp extends BaseEntity implements BelongsToCampInterface {
     #[InputFilter\CleanHTML]
     #[Assert\NotBlank]
     #[ApiProperty(example: 'SoLa 2022')]
-    #[Groups(['Default', 'camp:update'])]
+    #[Groups(['read', 'create'])]
     public string $name;
 
     /**
@@ -128,8 +150,8 @@ class Camp extends BaseEntity implements BelongsToCampInterface {
     #[InputFilter\CleanHTML]
     #[Assert\NotBlank]
     #[Assert\Length(max: 32)]
-    #[ApiProperty(example: 'Abteilungs-Sommerlager 2022')]
-    #[Groups(['Default', 'camp:update'])]
+    #[ApiProperty(writable: true, example: 'Abteilungs-Sommerlager 2022')]
+    #[Groups(['read', 'write'])]
     public string $title;
 
     /**
@@ -141,7 +163,7 @@ class Camp extends BaseEntity implements BelongsToCampInterface {
     #[InputFilter\CleanHTML]
     #[Assert\Length(max: 128)]
     #[ApiProperty(example: 'Piraten')]
-    #[Groups(['Default', 'camp:update'])]
+    #[Groups(['read', 'write'])]
     public ?string $motto = null;
 
     /**
@@ -153,7 +175,7 @@ class Camp extends BaseEntity implements BelongsToCampInterface {
     #[InputFilter\CleanHTML]
     #[Assert\Length(max: 128)]
     #[ApiProperty(example: 'Wiese hinter der alten Mühle')]
-    #[Groups(['Default', 'camp:update'])]
+    #[Groups(['read', 'write'])]
     public ?string $addressName = null;
 
     /**
@@ -165,7 +187,7 @@ class Camp extends BaseEntity implements BelongsToCampInterface {
     #[InputFilter\CleanHTML]
     #[Assert\Length(max: 128)]
     #[ApiProperty(example: 'Schönriedweg 23')]
-    #[Groups(['Default', 'camp:update'])]
+    #[Groups(['read', 'write'])]
     public ?string $addressStreet = null;
 
     /**
@@ -177,7 +199,7 @@ class Camp extends BaseEntity implements BelongsToCampInterface {
     #[InputFilter\CleanHTML]
     #[Assert\Length(max: 128)]
     #[ApiProperty(example: '1234')]
-    #[Groups(['Default', 'camp:update'])]
+    #[Groups(['read', 'write'])]
     public ?string $addressZipcode = null;
 
     /**
@@ -189,7 +211,7 @@ class Camp extends BaseEntity implements BelongsToCampInterface {
     #[InputFilter\CleanHTML]
     #[Assert\Length(max: 128)]
     #[ApiProperty(example: 'Hintertüpfingen')]
-    #[Groups(['Default', 'camp:update'])]
+    #[Groups(['read', 'write'])]
     public ?string $addressCity = null;
 
     /**
@@ -222,6 +244,16 @@ public function __construct() {
         $this->materialLists = new ArrayCollection();
     }
 
+    #[ApiProperty(
+        readableLink: true,
+        example: '[{ "description": "Hauptlager", "start": "2022-01-01", "end": "2022-01-08" }]'
+    )]
+    #[SerializedName('periods')]
+    #[Groups(['Camp:Periods'])]
+    public function getEmbeddedPeriods(): Collection {
+        return $this->periods;
+    }
+
     #[ApiProperty(readable: false)]
     public function getCamp(): ?Camp {
         return $this;

api/src/Entity/Day.php

@@ -10,6 +10,7 @@
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
+use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Serializer\Annotation\SerializedName;
 
 /**
@@ -26,6 +27,14 @@
 #[ApiResource(
     collectionOperations: ['get'],
     itemOperations: ['get'],
+    normalizationContext: [
+        'groups' => ['read'],
+        'allow_extra_attributes' => false,
+    ],
+    denormalizationContext: [
+        'groups' => ['write'],
+        'allow_extra_attributes' => false,
+    ],
 )]
 #[ApiFilter(SearchFilter::class, properties: ['period'])]
 #[UniqueEntity(fields: ['period', 'dayOffset'])]
@@ -44,7 +53,8 @@ class Day extends BaseEntity implements BelongsToCampInterface {
      * @ORM\ManyToOne(targetEntity="Period", inversedBy="days")
      * @ORM\JoinColumn(nullable=false, onDelete="cascade")
      */
-    #[ApiProperty(writable: false, example: '/periods/1a2b3c4d')]
+    #[ApiProperty(readableLink: false, writable: false, example: '/periods/1a2b3c4d')]
+    #[Groups(['read'])]
     public ?Period $period = null;
 
     /**
@@ -53,13 +63,15 @@ class Day extends BaseEntity implements BelongsToCampInterface {
      * @ORM\Column(type="integer")
      */
     #[ApiProperty(writable: false, example: '1')]
+    #[Groups(['read'])]
     public int $dayOffset = 0;
 
     public function __construct() {
         $this->dayResponsibles = new ArrayCollection();
     }
 
-    #[ApiProperty(readable: false)]
+    #[ApiProperty(readableLink: false, writable: false, example: '/camps/1a2b3c4d')]
+    #[Groups(['read'])]
     public function getCamp(): ?Camp {
         return $this->period?->camp;
     }
@@ -69,6 +81,7 @@ public function getCamp(): ?Camp {
      */
     #[ApiProperty(example: '2')]
     #[SerializedName('number')]
+    #[Groups(['read'])]
     public function getDayNumber(): int {
         return $this->dayOffset + 1;
     }

api/src/Entity/Period.php

@@ -11,6 +11,7 @@
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Serializer\Annotation\Groups;
+use Symfony\Component\Serializer\Annotation\SerializedName;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
@@ -20,15 +21,28 @@
  * @ORM\Entity
  */
 #[ApiResource(
-    collectionOperations: ['get', 'post'],
-    itemOperations: [
+    collectionOperations: [
         'get',
-        'patch' => ['denormalization_context' => [
-            'groups' => ['period:update'],
-            'allow_extra_attributes' => false,
-        ]],
+        'post',
+    ],
+    itemOperations: [
+        'get' => [
+            'normalization_context' => [
+                'groups' => ['read', 'Period:Camp', 'Period:Days'],
+                'allow_extra_attributes' => false,
+            ],
+        ],
+        'patch',
         'delete',
-    ]
+    ],
+    normalizationContext: [
+        'groups' => ['read'],
+        'allow_extra_attributes' => false,
+    ],
+    denormalizationContext: [
+        'groups' => ['write'],
+        'allow_extra_attributes' => false,
+    ],
 )]
 #[ApiFilter(SearchFilter::class, properties: ['camp'])]
 class Period extends BaseEntity implements BelongsToCampInterface {
@@ -38,7 +52,12 @@ class Period extends BaseEntity implements BelongsToCampInterface {
      * @ORM\OneToMany(targetEntity="Day", mappedBy="period", orphanRemoval=true)
      * @ORM\OrderBy({"dayOffset": "ASC"})
      */
-    #[ApiProperty(writable: false, example: '["/days/1a2b3c4d"]')]
+    #[ApiProperty(
+        readableLink: false,
+        writable: false,
+        example: '/days?period=/periods/1a2b3c4d'
+    )]
+    #[Groups(['read'])]
     public Collection $days;
 
     /**
@@ -66,8 +85,8 @@ class Period extends BaseEntity implements BelongsToCampInterface {
      * @ORM\ManyToOne(targetEntity="Camp", inversedBy="periods")
      * @ORM\JoinColumn(nullable=false)
      */
-    #[ApiProperty(example: '/camps/1a2b3c4d')]
-    #[Groups(['Default'])]
+    #[ApiProperty(readableLink: false, example: '/camps/1a2b3c4d')]
+    #[Groups(['read'])]
     public ?Camp $camp = null;
 
     /**
@@ -79,7 +98,7 @@ class Period extends BaseEntity implements BelongsToCampInterface {
      */
     #[Assert\NotBlank]
     #[ApiProperty(example: 'Hauptlager')]
-    #[Groups(['Default', 'period:update'])]
+    #[Groups(['Properties:read', 'Properties:write'])]
     public ?string $description = null;
 
     /**
@@ -95,7 +114,7 @@ class Period extends BaseEntity implements BelongsToCampInterface {
      */
     #[Assert\LessThanOrEqual(propertyPath: 'end')]
     #[ApiProperty(example: '2022-01-01', openapiContext: ['format' => 'date'])]
-    #[Groups(['Default', 'period:update'])]
+    #[Groups(['Properties:read', 'Properties:write'])]
     public ?DateTimeInterface $start = null;
 
     /**
@@ -106,7 +125,7 @@ class Period extends BaseEntity implements BelongsToCampInterface {
      */
     #[Assert\GreaterThanOrEqual(propertyPath: 'start')]
     #[ApiProperty(example: '2022-01-08', openapiContext: ['format' => 'date'])]
-    #[Groups(['Default', 'period:update'])]
+    #[Groups(['Properties:read', 'Properties:write'])]
     public ?DateTimeInterface $end = null;
 
     public function __construct() {
@@ -115,6 +134,23 @@ public function __construct() {
         $this->materialItems = new ArrayCollection();
     }
 
+    #[ApiProperty(
+        readableLink: true,
+        example: '[{ "dayOffset": 0, "number": 1 }]'
+    )]
+    #[SerializedName('days')]
+    #[Groups('Period:Days')]
+    public function getEmbeddedDays(): Collection {
+        return $this->days;
+    }
+
+    #[ApiProperty(readableLink: true)]
+    #[SerializedName('camp')]
+    #[Groups(['Period:Camp'])]
+    public function getEmbeddedCamp(): ?Camp {
+        return $this->camp;
+    }
+
     public function getCamp(): ?Camp {
         return $this->camp;
     }