✨ (Routes /ues) Added routes for UEs

Added route GET /ues/search : it can search UEs by their code and the type of ECTS they give. Added route GET /ues/{code} that returns informations about the UE with the provided code. Added a new search
filter for ApiPlatform which allows to change the name of the parameters in the URL. Fixed a small bug in the UpdateAtSubscriber class that could make the server produce an error

Author: Teddy Roncin

src/ApiPlatform/SearchWithCustomParametersNamesFilter.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace App\ApiPlatform;
+
+use ApiPlatform\Api\IdentifiersExtractorInterface;
+use ApiPlatform\Api\IriConverterInterface;
+use ApiPlatform\Doctrine\Common\Filter\SearchFilterInterface;
+use ApiPlatform\Doctrine\Common\Filter\SearchFilterTrait;
+use ApiPlatform\Doctrine\Orm\Filter\AbstractFilter;
+use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
+use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use ApiPlatform\Metadata\Operation;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\ORM\QueryBuilder;
+use Doctrine\Persistence\ManagerRegistry;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+
+final class SearchWithCustomParametersNamesFilter extends AbstractFilter implements SearchFilterInterface
+{
+    use SearchFilterTrait;
+
+    protected array $aliasMap;
+    private SearchFilter $searchFilter;
+
+    public function __construct(ManagerRegistry $managerRegistry, IriConverterInterface $iriConverter, PropertyAccessorInterface $propertyAccessor = null, LoggerInterface $logger = null, array $properties = null, IdentifiersExtractorInterface $identifiersExtractor = null, array $aliasMap = null)
+    {
+        parent::__construct($managerRegistry, $logger, $properties);
+        $this->aliasMap = $aliasMap;
+        $this->searchFilter = new SearchFilter($managerRegistry, $iriConverter, $propertyAccessor, $logger, $properties, $identifiersExtractor);
+    }
+
+    protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, Operation $operation = null, array $context = []): void
+    {
+        $this->searchFilter->filterProperty($property, $value, $queryBuilder, $queryNameGenerator, $resourceClass, $operation, $context);
+    }
+
+    protected function denormalizePropertyName(int|string $property): string
+    {
+        return array_search($property, $this->aliasMap, strict: true) ?: $property;
+    }
+
+    protected function normalizePropertyName(int|string $property): string
+    {
+        return $this->aliasMap[$property] ?? $property;
+    }
+
+    protected function getType(string $doctrineType): string
+    {
+        return match ($doctrineType) {
+            Types::ARRAY => 'array',
+            Types::BIGINT, Types::INTEGER, Types::SMALLINT => 'int',
+            Types::BOOLEAN => 'bool',
+            Types::DATE_MUTABLE, Types::TIME_MUTABLE, Types::DATETIME_MUTABLE, Types::DATETIMETZ_MUTABLE, Types::DATE_IMMUTABLE, Types::TIME_IMMUTABLE, Types::DATETIME_IMMUTABLE, Types::DATETIMETZ_IMMUTABLE => \DateTimeInterface::class,
+            Types::FLOAT => 'float',
+            default => 'string',
+        };
+    }
+
+    protected function getIriConverter(): IriConverterInterface
+    {
+        return $this->iriConverter;
+    }
+
+    protected function getPropertyAccessor(): PropertyAccessorInterface
+    {
+        return $this->propertyAccessor;
+    }
+}

src/Entity/UE.php

@@ -2,19 +2,45 @@
 
 namespace App\Entity;
 
+use ApiPlatform\Metadata\ApiFilter;
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Metadata\GetCollection;
+use App\ApiPlatform\SearchWithCustomParametersNamesFilter;
 use App\Repository\UERepository;
 use DateTime;
 use Doctrine\Common\Collections\ArrayCollection;
 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;
 
 /**
  * @ORM\Entity(repositoryClass=UERepository::class)
  * @ORM\Table(name="ues")
  */
+#[
+    ApiResource(
+        shortName: 'ue',
+        operations: [
+            new GetCollection(
+                uriTemplate: '/ues/search',
+                normalizationContext: ['groups' => ['ue:read:some'], 'skip_null_values' => false],
+            ),
+            new Get(
+                normalizationContext: ['groups' => ['ue:read:one'], 'skip_null_values' => false],
+            ),
+        ],
+    ),
+    ApiFilter(
+        SearchWithCustomParametersNamesFilter::class,
+        properties: ['code' => 'partial', 'credits.category.code' => 'exact'],
+        arguments: ['aliasMap' => ['credits.category.code' => 'category']],
+    ),
+]
 class UE
 {
     /**
@@ -25,17 +51,27 @@ class UE
      *
      * @Assert\Uuid
      */
+    #[Groups([
+        'ue:read:some',
+        'ue:read:one',
+    ])]
+    #[ApiProperty(identifier: false)]
     private $id;
 
     /**
      * The code of the UE (e.g. "MATH01").
      *
-     * @ORM\Column(type="string", length=10)
+     * @ORM\Column(type="string", length=10, unique=true)
      *
      * @Assert\Type("string")
      * @Assert\Length(min=1, max=10)
      * @Assert\Regex("/^[a-zA-Z]{1,5}[0-9]{1,2}$/")
      */
+    #[Groups([
+        'ue:read:some',
+        'ue:read:one',
+    ])]
+    #[ApiProperty(identifier: true)]
     private $code;
 
     /**
@@ -46,6 +82,10 @@ class UE
      * @Assert\Type("string")
      * @Assert\Length(min=1, max=255)
      */
+    #[Groups([
+        'ue:read:some',
+        'ue:read:one',
+    ])]
     private $name;
 
     /**
@@ -57,6 +97,9 @@ class UE
      * @Assert\LessThanOrEqual(100)
      * @Assert\GreaterThanOrEqual(0)
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $validationRate;
 
     /**
@@ -86,13 +129,20 @@ class UE
      * @ORM\ManyToOne(targetEntity=UTTFiliere::class, inversedBy="UEs")
      * @ORM\JoinColumn(name="filiere_code", referencedColumnName="code")
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $filiere;
 
     /**
      * The amount of UECredits of this UE. A UECredit object is a number of credit in a UECreditCategory.
      *
      * @ORM\OneToMany(targetEntity=UECredit::class, mappedBy="UE", orphanRemoval=true)
      */
+    #[Groups([
+        'ue:read:one',
+        'ue:read:some',
+    ])]
     private $credits;
 
     /**
@@ -112,41 +162,72 @@ class UE
      *     inverseJoinColumns={@ORM\JoinColumn(name="semester_code", referencedColumnName="code")}
      * )
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $openSemester;
 
+    /**
+     * Whether this UE is closed. A UE can still be opened, but not available at a given semester
+     * (it could for example only be available in spring). When it is marked as closed, it should never be available again.
+     *
+     * @ORM\Column(type="boolean", options={"default": false})
+     * @Assert\Type("boolean")
+     */
+    #[Groups([
+        'ue:read:some',
+        'ue:read:one',
+    ])]
+    private $isClosed = false;
+
     /**
      * The relation to the entity that store the work time of this UE.
      *
      * @ORM\OneToOne(targetEntity=UEWorkTime::class, mappedBy="UE", cascade={"persist", "remove"})
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $workTime;
 
     /**
      * The relation to the entity that store the info of this UE given by UTT.
      *
      * @ORM\OneToOne(targetEntity=UEInfo::class, mappedBy="UE", cascade={"persist", "remove"})
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $info;
 
     /**
      * The relation to all UEAnnals related to this UE.
      *
      * @ORM\OneToMany(targetEntity=UEAnnal::class, mappedBy="UE", orphanRemoval=true)
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $annals;
 
     /**
      * The relation to all UEComments related to this UE.
      *
      * @ORM\OneToMany(targetEntity=UEComment::class, mappedBy="UE", orphanRemoval=true)
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $comments;
 
     /**
      * The relation to all UECourses of this UE.
      *
      * @ORM\OneToMany(targetEntity=UECourse::class, mappedBy="UE")
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $courses;
 
     public function __construct()
@@ -354,6 +435,17 @@ public function removeOpenSemester(Semester $openSemester): self
         return $this;
     }
 
+    public function getIsClosed(): bool
+    {
+        return $this->isClosed;
+    }
+
+    public function close(): self
+    {
+        $this->isClosed = false;
+        return $this;
+    }
+
     public function getWorkTime(): ?UEWorkTime
     {
         return $this->workTime;

src/Entity/UEAnnal.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;
 
@@ -41,6 +42,9 @@ class UEAnnal
      * @ORM\ManyToOne(targetEntity=User::class)
      * @ORM\JoinColumn(nullable=false)
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $sender;
 
     /**
@@ -49,6 +53,9 @@ class UEAnnal
      * @ORM\ManyToOne(targetEntity=Semester::class)
      * @ORM\JoinColumn(name="semester_code", referencedColumnName="code")
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $semester;
 
     /**
@@ -57,6 +64,9 @@ class UEAnnal
      * @ORM\ManyToOne(targetEntity=UEAnnalType::class)
      * @ORM\JoinColumn(name="type_name", referencedColumnName="name")
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $type;
 
     /**
@@ -67,6 +77,9 @@ class UEAnnal
      * @Assert\Type("string")
      * @Assert\Length(min=1, max=255)
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $filename;
 
     /**

src/Entity/UEComment.php

@@ -9,6 +9,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;
 
@@ -44,6 +45,9 @@ class UEComment
      * @ORM\ManyToOne(targetEntity=User::class)
      * @ORM\JoinColumn(nullable=false)
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $author;
 
     /**
@@ -53,6 +57,9 @@ class UEComment
      *
      * @Assert\Type("string")
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $body;
 
     /**
@@ -70,13 +77,19 @@ class UEComment
      * @ORM\ManyToOne(targetEntity=Semester::class)
      * @ORM\JoinColumn(name="semester_code", referencedColumnName="code")
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $semester;
 
     /**
      * The relation to all UECommentReply that are answering to this Comment.
      *
      * @ORM\OneToMany(targetEntity=UECommentReply::class, mappedBy="comment")
      */
+    #[Groups([
+        'ue:read:one',
+    ])]
     private $answers;
 
     /**