changed filters validation

Author: eceltov

app/V1Module/presenters/UsersPresenter.php

@@ -5,6 +5,7 @@
 use App\Helpers\MetaFormats\Attributes\Post;
 use App\Helpers\MetaFormats\Attributes\Query;
 use App\Helpers\MetaFormats\Attributes\Path;
+use App\Helpers\MetaFormats\FormatDefinitions\UserFilterFormat;
 use App\Helpers\MetaFormats\Validators\VArray;
 use App\Helpers\MetaFormats\Validators\VBool;
 use App\Helpers\MetaFormats\Validators\VEmail;
@@ -29,6 +30,7 @@
 use App\Exceptions\BadRequestException;
 use App\Helpers\EmailVerificationHelper;
 use App\Helpers\AnonymizationHelper;
+use App\Helpers\MetaFormats\Validators\VObject;
 use App\Model\View\GroupViewFactory;
 use App\Model\View\InstanceViewFactory;
 use App\Model\View\UserViewFactory;
@@ -130,7 +132,7 @@ public function checkDefault()
         required: false,
         nullable: true,
     )]
-    #[Query("filters", new VArray(), "Named filters that prune the result.", required: false, nullable: true)]
+    #[Query("filters", new VObject(UserFilterFormat::class), "Named filters that prune the result.", required: false, nullable: true)]
     #[Query(
         "locale",
         new VString(),

app/helpers/MetaFormats/FormatDefinitions/UserFilterFormat.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace App\Helpers\MetaFormats\FormatDefinitions;
+
+use App\Helpers\MetaFormats\Attributes\Format;
+use App\Helpers\MetaFormats\MetaFormat;
+use App\Helpers\MetaFormats\Attributes\FPost;
+use App\Helpers\MetaFormats\Attributes\FQuery;
+use App\Helpers\MetaFormats\Validators\VBool;
+use App\Helpers\MetaFormats\Validators\VInt;
+use App\Helpers\MetaFormats\Validators\VMixed;
+use App\Helpers\MetaFormats\Validators\VString;
+use ArrayAccess;
+
+#[Format(UserFilterFormat::class)]
+class UserFilterFormat extends MetaFormat implements ArrayAccess
+{
+    #[FQuery(new VString(), required: false)]
+    public ?string $search;
+
+    #[FQuery(new VString(), required: false)]
+    public ?string $instanceId;
+
+    #[FQuery(new VString(), required: false)]
+    public ?string $roles;
+
+    public function offsetExists(mixed $offset): bool
+    {
+        return isset($this->$offset);
+    }
+
+    /**
+     * Offset to retrieve
+     * @param mixed $offset The offset to retrieve.
+     * @return mixed Can return all value types.
+     */
+    public function offsetGet(mixed $offset): mixed
+    {
+        return $this->$offset ?? null;
+    }
+
+    /**
+     * Offset to set
+     * @param mixed $offset The offset to assign the value to.
+     * @param mixed $value The value to set.
+     */
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        $this->$offset = $value;
+    }
+
+    /**
+     * Offset to unset
+     * @param mixed $offset The offset to unset.
+     */
+    public function offsetUnset(mixed $offset): void
+    {
+        $this->$offset = null;
+    }
+}

app/helpers/MetaFormats/Validators/VObject.php

@@ -28,6 +28,11 @@ public function __construct(string $format, bool $strict = true)
 
     public function validate(mixed $value): bool
     {
+        // query parameters can contain arrays
+        if (!$this->strict && is_array($value)) {
+            return true;
+        }
+
         // fine-grained checking is done in the properties
         return $value instanceof MetaFormat;
     }

app/helpers/Swagger/AnnotationParameterData.php

@@ -136,6 +136,7 @@ private function generateSchemaAnnotation(): string
         }
 
         $this->addArrayItemsIfArray($body);
+        $this->addObjectParamsIfObject($body);
 
         return $head . $body->toString();
     }

docs/swagger.yaml

@@ -4624,9 +4624,26 @@ paths:
           description: 'Named filters that prune the result.'
           required: false
           schema:
-            type: array
-            items: {  }
+            properties:
+              search:
+                description: ''
+                type: string
+                example: text
+                nullable: false
+              instanceId:
+                description: ''
+                type: string
+                example: text
+                nullable: false
+              roles:
+                description: ''
+                type: string
+                example: text
+                nullable: false
+            type: object
             nullable: true
+          style: deepObject
+          explode: true
         -
           name: locale
           in: query