add route for comment + track update/creation of entities

src/Bundle/ChillMainBundle/Doctrine/Event/TrackCreateUpdateSubscriber.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Chill\MainBundle\Doctrine\Event;
+
+use Doctrine\Common\EventSubscriber;
+use Doctrine\ORM\Events;
+use Doctrine\Persistence\Event\LifecycleEventArgs;
+use Chill\MainBundle\Doctrine\Model\TrackCreationInterface;
+use Chill\MainBundle\Doctrine\Model\TrackUpdateInterface;
+use Symfony\Component\Security\Core\Security;
+
+
+class TrackCreateUpdateSubscriber implements EventSubscriber
+{
+    private Security $security;
+
+    /**
+     * @param Security $security
+     */
+    public function __construct(Security $security)
+    {
+        $this->security = $security;
+    }
+    
+    /**
+     * {@inheritDoc}
+     */
+    public function getSubscribedEvents()
+    {
+        return [
+            Events::prePersist,
+            Events::preUpdate
+        ];
+    }
+
+    public function prePersist(LifecycleEventArgs $args): void
+    {
+        $object = $args->getObject();
+
+        if ($object instanceof TrackCreationInterface) {
+            $object->setCreatedBy($this->security->getUser());
+            $object->setCreatedAt(new \DateTimeImmutable('now'));
+        }
+
+        $this->onUpdate($object);
+    }
+
+    public function preUpdate(LifecycleEventArgs $args): void
+    {
+        $object = $args->getObject();
+
+        $this->onUpdate($object);
+    }
+
+    protected function onUpdate(object $object): void
+    {
+        if ($object instanceof TrackUpdateInterface) {
+            $object->setUpdatedBy($this->security->getUser());
+            $object->setUpdatedAt(new \DateTimeImmutable('now'));
+        }
+    }
+}

src/Bundle/ChillMainBundle/Doctrine/Model/TrackCreationInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Chill\MainBundle\Doctrine\Model;
+
+use Chill\MainBundle\Entity\User;
+
+interface TrackCreationInterface
+{
+    public function setCreatedBy(User $user): self;
+
+    public function setCreatedAt(\DateTimeInterface $datetime): self;
+}

src/Bundle/ChillMainBundle/Doctrine/Model/TrackUpdateInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Chill\MainBundle\Doctrine\Model;
+
+use Chill\MainBundle\Entity\User;
+
+interface TrackUpdateInterface
+{
+    public function setUpdatedBy(User $user): self;
+
+    public function setUpdatedAt(\DateTimeInterface $datetime): self;
+}

src/Bundle/ChillMainBundle/config/services.yaml

@@ -9,6 +9,12 @@ services:
         tags:
             - { name: 'serializer.normalizer', priority: 64 }
 
+    Chill\MainBundle\Doctrine\Event\:
+        resource: '../Doctrine/Event/'
+        autowire: true
+        tags: 
+            - { name: 'doctrine.event_subscriber' }
+
     chill.main.helper.translatable_string:
         class: Chill\MainBundle\Templating\TranslatableStringHelper
         arguments:

src/Bundle/ChillPersonBundle/Controller/AccompanyingCourseApiController.php

@@ -15,6 +15,7 @@ use Chill\PersonBundle\Entity\Person;
 use Chill\ThirdPartyBundle\Entity\ThirdParty;
 use Symfony\Component\Serializer\Exception\RuntimeException;
 use Chill\PersonBundle\Entity\AccompanyingPeriod\Resource;
+use Chill\PersonBundle\Entity\AccompanyingPeriod\Comment;
 
 class AccompanyingCourseApiController extends ApiController
 {
@@ -71,6 +72,10 @@ class AccompanyingCourseApiController extends ApiController
         return $this->addRemoveSomething('resource', $id, $request, $_format, 'resource', Resource::class);
     }
 
+    public function commentApi($id, Request $request, string $_format): Response
+    {
+        return $this->addRemoveSomething('comment', $id, $request, $_format, 'comment', Comment::class);
+    }
 
     public function requestorApi($id, Request $request, string $_format): Response
     {

src/Bundle/ChillPersonBundle/DependencyInjection/ChillPersonExtension.php

@@ -354,6 +354,18 @@ class ChillPersonExtension extends Extension implements PrependExtensionInterfac
                                 Request::METHOD_DELETE=> \Chill\PersonBundle\Security\Authorization\AccompanyingPeriodVoter::SEE
                             ]
                         ],
+                        'comment' => [
+                            'methods' => [
+                                Request::METHOD_POST => true, 
+                                Request::METHOD_DELETE => true,
+                                Request::METHOD_GET => false,
+                                Request::METHOD_HEAD => false,
+                            ],
+                            'roles' => [ 
+                                Request::METHOD_POST => \Chill\PersonBundle\Security\Authorization\AccompanyingPeriodVoter::SEE,
+                                Request::METHOD_DELETE=> \Chill\PersonBundle\Security\Authorization\AccompanyingPeriodVoter::SEE
+                            ]
+                        ],
                         'requestor' => [
                             'methods' => [
                                 Request::METHOD_POST => true, 
@@ -389,7 +401,7 @@ class ChillPersonExtension extends Extension implements PrependExtensionInterfac
                             ]
                         ],
                     ]
-                ]
+                ],
             ]
         ]);
     }

src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod.php

@@ -117,7 +117,9 @@ class AccompanyingPeriod
      * @var Collection
      *
      * @ORM\OneToMany(targetEntity="Chill\PersonBundle\Entity\AccompanyingPeriod\Comment",
-     *       mappedBy="accompanyingPeriod"
+     *       mappedBy="accompanyingPeriod",
+     *       cascade={"persist", "remove"},
+     *       orphanRemoval=true
      *     )
      * @Groups({"read"})
      */
@@ -350,12 +352,14 @@ class AccompanyingPeriod
     public function addComment(Comment $comment): self
     {
         $this->comments[] = $comment;
+        $comment->setAccompanyingPeriod($this);
 
         return $this;
     }
 
     public function removeComment(Comment $comment): void
     {
+        $comment->setAccompanyingPeriod(null);
         $this->comments->removeElement($comment);
     }
 

src/Bundle/ChillPersonBundle/Entity/AccompanyingPeriod/Comment.php

@@ -26,17 +26,25 @@ use Chill\PersonBundle\Repository\AccompanyingPeriod\CommentRepository;
 use Chill\MainBundle\Entity\User;
 use Chill\PersonBundle\Entity\AccompanyingPeriod;
 use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Annotation\Groups;
+use Symfony\Component\Serializer\Annotation\DiscriminatorMap;
+use Chill\MainBundle\Doctrine\Model\TrackCreationInterface;
+use Chill\MainBundle\Doctrine\Model\TrackUpdateInterface;
 
 /**
  * @ORM\Entity(repositoryClass=CommentRepository::class)
  * @ORM\Table(name="chill_person_accompanying_period_comment")
+ * @DiscriminatorMap(typeProperty="type", mapping={
+ *    "accompanying_period_comment"=Comment::class
+ * })
  */
-class Comment
+class Comment implements TrackCreationInterface, TrackUpdateInterface
 {
     /**
      * @ORM\Id
      * @ORM\GeneratedValue
      * @ORM\Column(type="integer")
+     * @Groups({"read"})
      */
     private $id;
 
@@ -51,27 +59,32 @@ class Comment
     /**
      * @ORM\ManyToOne(targetEntity=User::class)
      * @ORM\JoinColumn(nullable=false)
+     * @Groups({"read"})
      */
     private $creator;
 
     /**
      * @ORM\Column(type="datetime")
+     * @Groups({"read"})
      */
     private $createdAt;
 
     /**
      * @ORM\Column(type="datetime")
+     * @Groups({"read"})
      */
     private $updatedAt;
 
     /**
      * @ORM\ManyToOne(targetEntity=User::class)
      * @ORM\JoinColumn(nullable=false)
+     * @Groups({"read"})
      */
     private $updatedBy;
 
     /**
      * @ORM\Column(type="text")
+     * @Groups({"read", "write"})
      */
     private $content;
 
@@ -104,6 +117,11 @@ class Comment
         return $this;
     }
 
+    public function setCreatedBy(User $user): self
+    {
+        return $this->setCreator($user);
+    }
+
     public function getCreatedAt(): ?\DateTimeInterface
     {
         return $this->createdAt;
@@ -133,7 +151,7 @@ class Comment
         return $this->updatedBy;
     }
 
-    public function setUpdatedBy(?User $updatedBy): self
+    public function setUpdatedBy(User $updatedBy): self
     {
         $this->updatedBy = $updatedBy;
 

src/Bundle/ChillPersonBundle/chill.api.specs.yaml

@@ -92,6 +92,31 @@ components:
       required:
         - id
         - type
+    Comment:
+      type: object
+      properties:
+        type:
+          type: string
+          enum:
+            - 'accompanying_period_comment'
+          readOnly: true
+        id:
+          type: integer
+          readOnly: true
+        content:
+          type: string
+    CommentById:
+      type: object
+      properties:
+        id:
+          type: integer
+        type:
+          type: string
+          enum:
+            - 'accompanying_period_comment'
+      required:
+        - id
+        - type
 
 paths:
   /1.0/person/accompanying-course/{id}.json:
@@ -345,3 +370,72 @@ paths:
           description: "OK"
         422:
           description: "object with validation errors"
+
+  /1.0/person/accompanying-course/{id}/comment.json:
+    post:
+      tags:
+        - person
+      summary: "Add a comment to the accompanying course"
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: The accompanying period's id
+          schema:
+            type: integer
+            format: integer
+            minimum: 1
+      requestBody:
+        description: "A comment"
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Comment'
+            examples:
+              a single comment:
+                summary: "a simple comment"
+                value:
+                  type: accompanying_period_comment
+                  content: |
+                    This is a funny comment I would like to share with you.
+
+                    Thank you for reading this !
+      responses:
+        401:
+          description: "Unauthorized"
+        404:
+          description: "Not found"
+        200:
+          description: "OK"
+        422:
+          description: "object with validation errors"
+    delete:
+      tags:
+        - person
+      summary: "Remove the resource"
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: The accompanying period's id
+          schema:
+            type: integer
+            format: integer
+            minimum: 1
+      requestBody:
+        description: "A resource"
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CommentById'
+      responses:
+        401:
+          description: "Unauthorized"
+        404:
+          description: "Not found"
+        200:
+          description: "OK"
+        422:
+          description: "object with validation errors"