Parcourir la source

ajout de doc pour array field filter

Maha Bouchiba il y a 1 an
Parent
commit
f0a61a707b
1 fichiers modifiés avec 10 ajouts et 0 suppressions
  1. 10 0
      src/Filter/ApiPlatform/ArrayFieldFilter.php

+ 10 - 0
src/Filter/ApiPlatform/ArrayFieldFilter.php

@@ -7,6 +7,16 @@ use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use Doctrine\ORM\QueryBuilder;
 use ApiPlatform\Metadata\Operation;
 
+/**
+ * Cette classe est un filtre personnalisé pour les champs de type array
+ * Elle recherche des correspondances partielles dans un champ de type array JSON
+ * 
+ * différences avec le filtre InFilter:
+ * - ArrayFieldFilter recherche des correspondances partielles
+ * - InFilter utilise la clause SQL IN pour rechercher des correspondances exactes
+ * - Format est différent : pour ArrayFieldFilter, le format est un tableau JSON,
+ *  pour InFilter, le format est une liste CSV
+ */
 class ArrayFieldFilter extends AbstractFilter
 {
     protected function filterProperty(