Просмотр исходного кода

ajout de doc pour array field filter

Maha Bouchiba 1 год назад
Родитель
Сommit
f0a61a707b
1 измененных файлов с 10 добавлено и 0 удалено
  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 Doctrine\ORM\QueryBuilder;
 use ApiPlatform\Metadata\Operation;
 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
 class ArrayFieldFilter extends AbstractFilter
 {
 {
     protected function filterProperty(
     protected function filterProperty(