Feature/edt (#25)

* feat: First part of the exposition of the Asso Event and UE entities

* feat: Added a new entry point on user to retrieve said user's schedule

* fix: code modification to comply with pull request remarks

removal of dead code / switched group name from user:read:one:edt to user-edt:read:one / added documentation

* fix(getEdtController-SemesterRepository): removed an unused overload on getSemesterOfDate / added documentation

* refactor(Asso-Event-Translation-UE): Revert of unwanted files

* fix(UE): fixes a bug created by a conflic during revert

* :bug: (User) fixed entity User

/users routes will now return all fields, even if they are empty (in this case there content will be null)

Closes #28

Co-authored-by: Teddy Roncin <[email protected]>

Author: nicholsp2

src/Controller/GetEDTController.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Controller;
+
+use App\Entity\Semester;
+use App\Entity\User;
+use DateTime;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+
+// This class is a controller that removes expired courses from the user's EDT
+class GetEDTController extends AbstractController
+{
+    private $manager;
+
+    public function __construct(EntityManagerInterface $manager)
+    {
+        $this->manager = $manager;
+    }
+
+    public function __invoke(User $data): User
+    {
+        $repository = $this->getDoctrine()->getRepository(Semester::class);
+        $currentSemesterCode = $repository->getSemesterOfDate(new DateTime())->getCode();
+
+        $nbCourses = \count($data->getCourses());
+
+        for ($i = $nbCourses - 1; $i >= 0; --$i) {
+            if ($data->getCourses()[$i]->getSemester()->getCode() !== $currentSemesterCode) {
+                //altering $data doesn't alter the database as it is only a representation
+                unset($data->getCourses()[$i]);
+            }
+        }
+
+        return $data;
+    }
+}

src/Entity/UE.php

@@ -36,6 +36,11 @@ class UE
      * @Assert\Length(min=1, max=10)
      * @Assert\Regex("/^[a-zA-Z]{1,5}[0-9]{1,2}$/")
      */
+    #[Groups([
+        'ue:read:one',
+        'ue:read:some',
+        'user-edt:read:one',
+    ])]
     private $code;
 
     /**

src/Entity/UECourse.php

@@ -8,6 +8,7 @@
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Bridge\Doctrine\IdGenerator\UuidGenerator;
+use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Uid\Uuid;
 use Symfony\Component\Validator\Constraints as Assert;
 
@@ -34,6 +35,9 @@ class UECourse
      *
      * @ORM\ManyToOne(targetEntity=UE::class, inversedBy="courses")
      */
+    #[Groups([
+        'user-edt:read:one',
+    ])]
     private $UE;
 
     /**
@@ -44,6 +48,9 @@ class UECourse
      * @Assert\Type("string")
      * @Assert\Choice({"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"})
      */
+    #[Groups([
+        'user-edt:read:one',
+    ])]
     private $day;
 
     /**
@@ -53,6 +60,9 @@ class UECourse
      *
      * @Assert\Time
      */
+    #[Groups([
+        'user-edt:read:one',
+    ])]
     private $startHour;
 
     /**
@@ -62,6 +72,9 @@ class UECourse
      *
      * @Assert\Time
      */
+    #[Groups([
+        'user-edt:read:one',
+    ])]
     private $endHour;
 
     /**
@@ -72,6 +85,9 @@ class UECourse
      * @Assert\Type("string")
      * @Assert\Choice({"A", "B"})
      */
+    #[Groups([
+        'user-edt:read:one',
+    ])]
     private $week;
 
     /**
@@ -80,6 +96,9 @@ class UECourse
      * @Assert\Type("string")
      * @Assert\Choice({"CM", "TD", "TP"})
      */
+    #[Groups([
+        'user-edt:read:one',
+    ])]
     private $type;
 
     /**
@@ -90,6 +109,9 @@ class UECourse
      * @Assert\Type("string")
      * @Assert\Length(min=1, max=50)
      */
+    #[Groups([
+        'user-edt:read:one',
+    ])]
     private $room;
 
     /**

src/Entity/User.php

@@ -3,6 +3,7 @@
 namespace App\Entity;
 
 use ApiPlatform\Core\Annotation\ApiResource;
+use App\Controller\GetEDTController;
 use App\Controller\SoftDeleteController;
 use App\Repository\UserRepository;
 use Doctrine\Common\Collections\ArrayCollection;
@@ -27,6 +28,9 @@
             'security' => "is_granted('ROLE_USER')",
             'pagination_items_per_page' => 10,
         ],
+        normalizationContext: [
+            'skip_null_values' => false,
+        ],
         collectionOperations: [
             'get' => [
                 'normalization_context' => [
@@ -42,6 +46,17 @@
                     'skip_null_values' => false,
                 ],
             ],
+            'edt' => [
+                'method' => 'GET',
+                'path' => '/user/{id}/edt',
+                'controller' => GetEDTController::class,
+                'normalization_context' => [
+                    'groups' => ['user-edt:read:one'],
+                ],
+                'openapi_context' => [
+                    'summary' => 'retrieves a user\'s schedule',
+                ],
+            ],
             'delete' => [
                 'controller' => SoftDeleteController::class,
                 'security' => "is_granted('ROLE_ADMIN')",
@@ -326,6 +341,9 @@ class User implements UserInterface
      *
      * @ORM\ManyToMany(targetEntity=UECourse::class, mappedBy="students")
      */
+    #[Groups([
+        'user-edt:read:one',
+    ])]
     private $courses;
 
     public function __construct()