Add groups

Author: dunglas

api/src/Entity/Book.php

@@ -9,6 +9,7 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
@@ -17,7 +18,10 @@
  * @see http://schema.org/Book Documentation on Schema.org
  *
  * @ORM\Entity
- * @ApiResource(iri="http://schema.org/Book")
+ * @ApiResource(
+ *     iri="http://schema.org/Book",
+ *     normalizationContext={"groups": {"book:read"}}
+ * )
  * @ApiFilter(PropertyFilter::class)
  */
 class Book
@@ -36,6 +40,7 @@ class Book
      *
      * @Assert\Isbn
      * @ORM\Column(nullable=true)
+     * @Groups("book:read")
      * @ApiProperty(iri="http://schema.org/isbn")
      */
     public $isbn;
@@ -45,6 +50,7 @@ class Book
      *
      * @Assert\NotBlank
      * @ORM\Column
+     * @Groups({"book:read", "review:read"})
      * @ApiProperty(iri="http://schema.org/name")
      */
     public $title;
@@ -54,6 +60,7 @@ class Book
      *
      * @Assert\NotBlank
      * @ORM\Column(type="text")
+     * @Groups("book:read")
      * @ApiProperty(iri="http://schema.org/description")
      */
     public $description;
@@ -63,6 +70,7 @@ class Book
      *
      * @Assert\NotBlank
      * @ORM\Column
+     * @Groups("book:read")
      * @ApiProperty(iri="http://schema.org/author")
      */
     public $author;
@@ -73,14 +81,16 @@ class Book
      * @Assert\Date
      * @Assert\NotNull
      * @ORM\Column(type="date")
+     * @Groups("book:read")
      * @ApiProperty(iri="http://schema.org/dateCreated")
      */
     public $publicationDate;
 
     /**
      * @var Review[] The book's reviews
      *
-     * @ORM\OneToMany(targetEntity=Review::class, mappedBy="book", orphanRemoval=true, cascade={"all"})
+     * @ORM\OneToMany(targetEntity=Review::class, mappedBy="book", orphanRemoval=true, cascade={"persist", "remove"})
+     * @Groups("book:read")
      * @ApiProperty(iri="http://schema.org/reviews")
      */
     private $reviews;
@@ -95,27 +105,31 @@ public function getId(): ?int
         return $this->id;
     }
 
-    /**
-     * @return Collection|Review[]
-     */
-    public function getReviews(): iterable
+    public function addReview(Review $review, bool $updateRelation = true): void
     {
-        return $this->reviews;
+        if ($this->reviews->contains($review)) {
+            return;
+        }
+
+        $this->reviews->add($review);
+        if ($updateRelation) {
+            $review->setBook($this, false);
+        }
     }
 
-    public function addReview(Review $review): void
+    public function removeReview(Review $review, bool $updateRelation = true): void
     {
-        if (!$this->reviews->contains($review)) {
-            $this->reviews->add($review);
-            $review->book = $this;
+        $this->reviews->removeElement($review);
+        if ($updateRelation) {
+            $review->setBook(null, false);
         }
     }
 
-    public function removeReview(Review $review): void
+    /**
+     * @return Collection|Review[]
+     */
+    public function getReviews(): iterable
     {
-        if ($this->reviews->contains($review)) {
-            $review->book = $this;
-            $this->reviews->removeElement($review);
-        }
+        return $this->reviews;
     }
 }

api/src/Entity/Review.php

@@ -7,6 +7,7 @@
 use ApiPlatform\Core\Annotation\ApiResource;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
 use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
@@ -15,7 +16,10 @@
  * @see http://schema.org/Review Documentation on Schema.org
  *
  * @ORM\Entity
- * @ApiResource(iri="http://schema.org/Review")
+ * @ApiResource(
+ *     iri="http://schema.org/Review",
+ *     normalizationContext={"groups": {"review:read"}}
+ * )
  * @ApiFilter(SearchFilter::class, properties={"book": "exact"})
  */
 class Review
@@ -33,6 +37,7 @@ class Review
      * @var string The actual body of the review
      *
      * @ORM\Column(type="text", nullable=true)
+     * @Groups({"book:read", "review:read"})
      * @ApiProperty(iri="http://schema.org/reviewBody")
      */
     public $body;
@@ -42,6 +47,7 @@ class Review
      *
      * @Assert\Range(min=0, max=5)
      * @ORM\Column(type="smallint")
+     * @Groups("review:read")
      */
     public $rating;
 
@@ -50,6 +56,7 @@ class Review
      *
      * @Assert\Choice({"a", "b", "c", "d"})
      * @ORM\Column(type="string", nullable=true)
+     * @Groups("review:read")
      * @ApiProperty(deprecationReason="Use the rating property instead")
      */
     public $letter;
@@ -59,22 +66,24 @@ class Review
      *
      * @Assert\NotNull
      * @ORM\ManyToOne(targetEntity=Book::class, inversedBy="reviews")
-     * @ORM\JoinColumn(nullable=false)
+     * @Groups("review:read")
      * @ApiProperty(iri="http://schema.org/itemReviewed")
      */
-    public $book;
+    private $book;
 
     /**
      * @var string Author the author of the review
      *
      * @ORM\Column(type="text", nullable=true)
+     * @Groups("review:read")
      * @ApiProperty(iri="http://schema.org/author")
      */
     public $author;
 
     /**
      * @var \DateTimeInterface Author the author of the review
      *
+     * @Groups("review:read")
      * @ORM\Column(nullable=true, type="datetime")
      */
     public $publicationDate;
@@ -83,4 +92,17 @@ public function getId(): ?int
     {
         return $this->id;
     }
+
+    public function setBook(?Book $book, bool $updateRelation = true): void
+    {
+        $this->book = $book;
+        if ($updateRelation) {
+            $book->addReview($this, false);
+        }
+    }
+
+    public function getBook(): ?Book
+    {
+        return $this->book;
+    }
 }