feat: add filters support in BaseFormRequest and update related DTOs and requests

Author: aspirantzhang

app/Http/Requests/BaseFormRequest.php

@@ -6,13 +6,28 @@
 
 use Illuminate\Foundation\Http\FormRequest;
 
-class BaseFormRequest extends FormRequest
+abstract class BaseFormRequest extends FormRequest
 {
     protected function prepareForValidation()
     {
         parent::prepareForValidation();
         $this->route('id') && $this->merge(['id' => $this->route('id')]);
         $this->autoCast();
+        $this->filtersCast();
+    }
+
+    private function filtersCast()
+    {
+        if ($this->has('filters')) {
+            $inputFilters = $this->input('filters');
+
+            $filters = $inputFilters[0];
+            $filters = json_decode($inputFilters[0], true);
+
+            if (json_last_error() === JSON_ERROR_NONE) {
+                $this->merge(['filters' => $filters]);
+            }
+        }
     }
 
     protected function idRule(): array
@@ -22,6 +37,15 @@ protected function idRule(): array
         ];
     }
 
+    protected function filtersRule(): array
+    {
+        return [
+            'filters' => ['sometimes', 'array'],
+            'filters.*.id' => ['required_with:filters', 'string'],
+            'filters.*.value' => ['required_with:filters'],
+        ];
+    }
+
     private function autoCast(): void
     {
         $casts = $this->inferCastsFromRules();

contexts/Authorization/Application/DTOs/Role/GetRoleListDTO.php

@@ -17,16 +17,32 @@ public function __construct(
 
     public static function fromRequest(array $data): self
     {
+        $merged = array_merge($data, self::convertFiltersToCriteria($data['filters'] ?? []));
+
         return new self(
-            $data['id'] ?? null,
-            $data['label'] ?? null,
-            $data['status'] ?? null,
-            $data['created_at_range'] ?? null,
-            $data['current_page'] ?? 1,
-            $data['per_page'] ?? 10,
+            $merged['id'] ?? null,
+            $merged['label'] ?? null,
+            $merged['status'] ?? null,
+            $merged['created_at_range'] ?? null,
+            $merged['current_page'] ?? 1,
+            $merged['per_page'] ?? 10,
         );
     }
 
+    private static function convertFiltersToCriteria(array $filters): array
+    {
+        return collect($filters)->mapWithKeys(function ($filter) {
+            $key = $filter['id'];
+            if ($key === 'created_at_range') {
+                $value = json_decode($filter['value'], true);
+            } else {
+                $value = $filter['value'];
+            }
+
+            return [$key => $value];
+        })->toArray();
+    }
+
     public function toCriteria(): array
     {
         return [

contexts/Authorization/Presentation/Requests/Role/GetRoleListRequest.php

@@ -18,6 +18,7 @@ public function rules(): array
             'created_at_range.*' => ['date'],
             'current_page' => ['integer', 'gt:0'],
             'per_page' => ['integer', 'gt:0'],
+            ...$this->filtersRule(),
         ];
     }
 }

contexts/Authorization/Tests/Feature/RoleTest.php

@@ -1,6 +1,8 @@
 <?php
 
 declare(strict_types=1);
+use Contexts\Authorization\Domain\Role\Models\RoleStatus;
+use Contexts\Authorization\Infrastructure\Records\RoleRecord;
 
 it('can create active roles via api', function () {
     $response = $this->postJson('roles', [
@@ -52,6 +54,41 @@
     $response->assertStatus(200);
 });
 
+it('can search for roles', function () {
+    RoleRecord::factory()->create([
+        'label' => 'My Role',
+        'status' => RoleRecord::mapStatusToRecord(RoleStatus::active()),
+    ]);
+    RoleRecord::factory()->create([
+        'label' => 'Other Role',
+        'status' => RoleRecord::mapStatusToRecord(RoleStatus::active()),
+    ]);
+
+    $response = $this->get('roles?label=My');
+
+    $response->assertStatus(200);
+    $response->assertJsonCount(1, 'data');
+    $response->assertJson([
+        'data' => [
+            [
+                'label' => 'My Role',
+            ],
+        ],
+    ]);
+
+    $response = $this->get('roles?filters=[{"id":"label","value":"Other"}]');
+    $response->assertStatus(200);
+    $response->assertJsonCount(1, 'data');
+    $response->assertJson([
+        'data' => [
+            [
+                'label' => 'Other Role',
+            ],
+        ],
+    ]);
+
+});
+
 it('can update a category', function () {
     $response = $this->postJson('roles', [
         'label' => 'My Role',