✨ (Get users collection) Added an advanced search for route GET /users/

Added many filters for the /users routes. User's nickname are now returned when fetching a collection of users

Author: Teddy Roncin

src/ApiPlatform/IsStudentFilter.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\ApiPlatform;
+
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractContextAwareFilter;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use Doctrine\ORM\QueryBuilder;
+
+class IsStudentFilter extends AbstractContextAwareFilter
+{
+    protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
+    {
+        if ($property !== 'is_student') {
+            return;
+        }
+        $alias = $queryBuilder->getRootAliases()[0];
+        $queryBuilder->andWhere("{$alias}.studentId ".($value == 'true' ? 'IS NOT' : 'IS').' NULL');
+    }
+
+    public function getDescription(string $resourceClass): array
+    {
+        return [
+            'is_student' => [
+                'property' => 'studentId',
+                'type' => 'bool',
+                'required' => false,
+            ],
+        ];
+    }
+}

src/ApiPlatform/SearchInNamesFilter.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace App\ApiPlatform;
+
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractContextAwareFilter;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use Doctrine\ORM\QueryBuilder;
+
+class SearchInNamesFilter extends AbstractContextAwareFilter
+{
+    protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
+    {
+        if ($property !== 'name') {
+            return;
+        }
+        $alias = $queryBuilder->getRootAliases()[0];
+        $infoAlias = $queryNameGenerator->generateJoinAlias('info');
+        $queryBuilder
+            ->innerJoin("{$alias}.infos", $infoAlias)
+            ->andWhere("({$alias}.firstName LIKE '%{$value}%' OR {$alias}.lastName LIKE '%{$value}%' OR {$infoAlias}.nickname LIKE '%{$value}%')");
+    }
+
+    public function getDescription(string $resourceClass): array
+    {
+        return [
+            'name' => [
+                'property' => 'name',
+                'type' => 'string',
+                'required' => false,
+            ],
+        ];
+    }
+}

src/ApiPlatform/UEFilter.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace App\ApiPlatform;
+
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractContextAwareFilter;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use App\Repository\SemesterRepository;
+use Doctrine\ORM\QueryBuilder;
+use Symfony\Component\PropertyInfo\Type;
+
+class UEFilter extends AbstractContextAwareFilter
+{
+
+    protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
+    {
+        if ($property !== 'ue') {
+            return;
+        }
+        $alias = $queryBuilder->getRootAliases()[0];
+        foreach ($value as $ueCode) {
+            $ueAlias = $queryNameGenerator->generateJoinAlias('UE');
+            $ueSubscriptionAlias = $queryNameGenerator->generateJoinAlias('UEsSubscriptions');
+            $semesterAlias = $queryNameGenerator->generateJoinAlias('Semester');
+            $queryBuilder->innerJoin("{$alias}.UEsSubscriptions", $ueSubscriptionAlias)
+                ->innerJoin("${ueSubscriptionAlias}.UE", $ueAlias)
+                ->innerJoin("${ueSubscriptionAlias}.semester", $semesterAlias)
+                ->andWhere("{$ueAlias}.code = '{$ueCode}'")
+                ->andWhere("{$semesterAlias}.start <= :now")
+                ->andWhere("{$semesterAlias}.end >= :now");
+        }
+        $queryBuilder->setParameter('now', new \DateTime());
+    }
+
+    public function getDescription(string $resourceClass): array
+    {
+        return [
+            'ue[]' => [
+                'property' => 'ue',
+                'type' => 'array',
+                'required' => false,
+                'is_collection' => true,
+            ],
+        ];
+    }
+}

src/Entity/User.php

@@ -2,11 +2,16 @@
 
 namespace App\Entity;
 
+use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
+use ApiPlatform\Metadata\ApiFilter;
 use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\Delete;
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\GetCollection;
 use ApiPlatform\Metadata\Patch;
+use App\ApiPlatform\IsStudentFilter;
+use App\ApiPlatform\SearchInNamesFilter;
+use App\ApiPlatform\UEFilter;
 use App\Controller\GetEDTController;
 use App\Controller\SoftDeleteController;
 use App\DataProvider\UserDataVisibilityItemDataProvider;
@@ -24,6 +29,7 @@
  * The main entity that represents all Users. It is related to UEs, Covoits, Assos and others.
  *
  * @ORM\Entity(repositoryClass=UserRepository::class)
+ *
  * @ORM\Table(name="users")
  */
 #[
@@ -58,15 +64,33 @@
         ],
         paginationItemsPerPage: 10,
         security: "is_granted('ROLE_USER')",
-    )
+    ),
+    ApiFilter(
+        SearchFilter::class,
+        properties: [
+            'studentId' => 'exact',
+            'mailsPhones.mailPersonal' => 'exact',
+            'mailsPhones.phoneNumber' => 'exact',
+            'branche.branche.code' => 'exact',
+            'branche.filiere.code' => 'exact',
+            'branche.semesterNumber' => 'exact',
+        ]
+    ),
+    ApiFilter(UEFilter::class),
+    ApiFilter(SearchInNamesFilter::class),
+    ApiFilter(IsStudentFilter::class),
 ]
 class User implements UserInterface
 {
     /**
      * @ORM\Id
+     *
      * @ORM\Column(type="uuid", unique=true)
+     *
      * @ORM\GeneratedValue(strategy="CUSTOM")
+     *
      * @ORM\CustomIdGenerator(class=UuidGenerator::class)
+     *
      * @Assert\Uuid()
      */
     #[Groups([
@@ -79,8 +103,11 @@ class User implements UserInterface
      * The CAS login of the User.
      *
      * @ORM\Column(type="string", length=50, unique=true)
+     *
      * @Assert\Type("string")
+     *
      * @Assert\Length(max=50)
+     *
      * @Assert\Regex("/^[a-z_0-9]{1,50}$/")
      */
     #[Groups([
@@ -93,7 +120,9 @@ class User implements UserInterface
      * For the User that are students, this is the UTT student number.
      *
      * @ORM\Column(type="integer", nullable=true, unique=true)
+     *
      * @Assert\Type("int")
+     *
      * @Assert\Positive
      */
     #[Groups([
@@ -103,7 +132,9 @@ class User implements UserInterface
 
     /**
      * @ORM\Column(type="string", length=255)
+     *
      * @Assert\Type("string")
+     *
      * @Assert\Length(max=255)
      */
     #[Groups([
@@ -114,7 +145,9 @@ class User implements UserInterface
 
     /**
      * @ORM\Column(type="string", length=255)
+     *
      * @Assert\Type("string")
+     *
      * @Assert\Length(max=255)
      */
     #[Groups([
@@ -141,6 +174,7 @@ class User implements UserInterface
      * The relation to the entity that contains the User's SocialNetwork.
      *
      * @ORM\OneToOne(targetEntity=UserSocialNetwork::class, mappedBy="user", cascade={"persist", "remove"})
+     *
      * @Assert\Valid()
      */
     #[Groups([
@@ -160,6 +194,7 @@ class User implements UserInterface
      * The relation to the entity that contains the User's RGPD.
      *
      * @ORM\OneToOne(targetEntity=UserRGPD::class, mappedBy="user", cascade={"persist", "remove"})
+     *
      * @Assert\Valid()
      */
     #[Groups([
@@ -244,6 +279,7 @@ class User implements UserInterface
      * The relation to the Preference of the User.
      *
      * @ORM\OneToOne(targetEntity=UserPreference::class, mappedBy="user", cascade={"persist", "remove"})
+     *
      * @Assert\Valid()
      */
     #[Groups([
@@ -256,6 +292,7 @@ class User implements UserInterface
      * The relation to the Infos of the User.
      *
      * @ORM\OneToOne(targetEntity=UserInfos::class, mappedBy="user", cascade={"persist", "remove"})
+     *
      * @Assert\Valid()
      */
     #[Groups([
@@ -269,6 +306,7 @@ class User implements UserInterface
      * The relation to the Addresses of the User.
      *
      * @ORM\OneToMany(targetEntity=UserAddress::class, mappedBy="user", cascade={"persist", "remove"}, orphanRemoval=true)
+     *
      * @Assert\Valid()
      */
     #[Groups([
@@ -281,6 +319,7 @@ class User implements UserInterface
      * The relation to mails and phone number of the User.
      *
      * @ORM\OneToOne(targetEntity=UserMailsPhones::class, mappedBy="user", cascade={"persist", "remove"})
+     *
      * @Assert\Valid()
      */
     #[Groups([

src/Entity/UserInfos.php

@@ -125,6 +125,7 @@ class UserInfos
      */
     #[Groups([
         'user:read:one',
+        'user:read:some',
         'user:write:update',
     ])]
     private $nickname;