filters rework

Author: iamgergo

src/Fields/Field.php

@@ -116,9 +116,9 @@ abstract class Field implements Arrayable, JsonSerializable
     protected bool|Closure $searchable = false;
 
     /**
-     * The search query resolver callback.
+     * The filter query resolver callback.
      */
-    protected ?Closure $searchQueryResolver = null;
+    protected ?Closure $filterQueryResolver = null;
 
     /**
      * Determine if the field is computed.
@@ -313,35 +313,27 @@ public function isSortable(): bool
     /**
      * Set the searchable attribute.
      */
-    public function searchable(bool|Closure $value = true): static
+    public function searchable(bool|Closure $value = true, ?Closure $callback = null): static
     {
-        $this->searchable = $value;
+        $callback ??= function (Request $request, Builder $query, mixed $value, string $attribute): Builder {
+            return $query->where($query->qualifyColumn($attribute), 'like', "%{$value}%", 'or');
+        };
 
-        return $this;
+        return $this->filterable($callback, $value);
     }
 
     /**
      * Determine if the field is searchable.
      */
     public function isSearchable(): bool
     {
-        if ($this->computed) {
+        if (! $this->isFilterable()) {
             return false;
         }
 
         return $this->searchable instanceof Closure ? call_user_func($this->searchable) : $this->searchable;
     }
 
-    /**
-     * Set the search query resolver.
-     */
-    public function searchWithQuery(Closure $callback): static
-    {
-        $this->searchQueryResolver = $callback;
-
-        return $this;
-    }
-
     /**
      * Set the translatable attribute.
      */
@@ -365,13 +357,35 @@ public function isTranslatable(): bool
     }
 
     /**
-     * Resolve the search query.
+     * Set the filterable attribute.
+     */
+    public function filterable(?Closure $callback = null, bool|Closure $search = false): static
+    {
+        $this->searchable = $search;
+
+        $this->filterQueryResolver = $callback ?: function (Request $request, Builder $query, mixed $value, string $attribute): Builder {
+            return $query->where($query->qualifyColumn($attribute), $value);
+        };
+
+        return $this;
+    }
+
+    /**
+     * Determine whether the field is filterable.
+     */
+    public function isFilterable(): bool
+    {
+        return ! $this->computed && $this->filterQueryResolver instanceof Closure;
+    }
+
+    /**
+     * Resolve the filter query.
      */
-    public function resolveSearchQuery(Request $request, Builder $query, mixed $value): Builder
+    public function resolveFilterQuery(Request $request, Builder $query, mixed $value): Builder
     {
-        return is_null($this->searchQueryResolver)
-            ? $query
-            : call_user_func_array($this->searchQueryResolver, [$request, $query, $value]);
+        return $this->isFilterable()
+            ? call_user_func_array($this->filterQueryResolver, [$request, $query, $value, $this->getModelAttribute()])
+            : $query;
     }
 
     /**

src/Fields/Relation.php

@@ -251,11 +251,26 @@ public function isNullable(): bool
     /**
      * {@inheritdoc}
      */
-    public function searchable(bool|Closure $value = true, array $columns = ['id']): static
+    public function searchable(bool|Closure $value = true, ?Closure $callback = null, array $columns = ['id']): static
     {
         $this->searchableColumns = $columns;
 
-        return parent::searchable($value);
+        $callback ??= function (Request $request, Builder $query, mixed $value, array $attributes): Builder {
+            return $query->has($this->getModelAttribute(), '>=', 1, 'or', static function (Builder $query) use ($attributes, $value): Builder {
+                foreach ($attributes as $attribute) {
+                    $query->where(
+                        $query->qualifyColumn($attribute),
+                        'like',
+                        "%{$value}%",
+                        $attributes[0] === $attribute ? 'and' : 'or'
+                    );
+                }
+
+                return $query;
+            });
+        };
+
+        return parent::searchable($value, $callback);
     }
 
     /**
@@ -267,15 +282,17 @@ public function getSearchableColumns(): array
     }
 
     /**
-     * {@inheritdoc}
+     * Resolve the filter query.
      */
-    public function isSearchable(): bool
+    public function resolveFilterQuery(Request $request, Builder $query, mixed $value): Builder
     {
-        if ($this->isSubResource()) {
-            return false;
+        if (! $this->isFilterable()) {
+            return parent::resolveFilterQuery($request, $query, $value);
         }
 
-        return parent::isSearchable();
+        return call_user_func_array($this->filterQueryResolver, [
+            $request, $query, $value, $this->getSearchableColumns(),
+        ]);
     }
 
     /**

src/Filters/Search.php

@@ -4,7 +4,6 @@
 
 use Cone\Root\Fields\Field;
 use Cone\Root\Fields\Fields;
-use Cone\Root\Fields\Relation;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Http\Request;
 
@@ -30,43 +29,17 @@ public function __construct(Fields $fields)
      */
     public function apply(Request $request, Builder $query, mixed $value): Builder
     {
-        $attributes = $this->getSearchableAttributes();
-
-        if (empty($value) || empty($attributes)) {
+        if (empty($value)) {
             return $query;
         }
 
-        return $query->where(static function (Builder $query) use ($attributes, $value): void {
-            foreach ($attributes as $attribute => $fields) {
-                $operator = array_key_first($attributes) === $attribute ? 'and' : 'or';
-
-                if (is_array($fields)) {
-                    $query->has($attribute, '>=', 1, $operator, static function (Builder $query) use ($fields, $value): Builder {
-                        foreach ($fields as $field) {
-                            $operator = $fields[0] === $field ? 'and' : 'or';
-
-                            $query->where($query->qualifyColumn($field), 'like', "%{$value}%", $operator);
-                        }
-
-                        return $query;
-                    });
-                } else {
-                    $query->where($query->qualifyColumn($attribute), 'like', "%{$value}%", $operator);
-                }
-            }
+        return $query->where(function (Builder $query) use ($request, $value): void {
+            $this->fields->each(function (Field $field) use ($request, $query, $value): void {
+                $field->resolveFilterQuery($request, $query, $value);
+            });
         });
     }
 
-    /**
-     * Get the serachable attributes.
-     */
-    public function getSearchableAttributes(): array
-    {
-        return $this->fields->mapWithKeys(static fn (Field $field): array => [
-            $field->getModelAttribute() => $field instanceof Relation ? $field->getSearchableColumns() : null,
-        ])->all();
-    }
-
     /**
      * {@inheritdoc}
      */

src/Root.php

@@ -25,7 +25,7 @@ class Root
      *
      * @var string
      */
-    public const string VERSION = '2.6.0';
+    public const string VERSION = '2.6.1';
 
     /**
      * The registered booting callbacks.

tests/Filters/SearchTest.php

@@ -14,8 +14,8 @@ class SearchTest extends TestCase
     public function test_a_search_filter_modifies_query(): void
     {
         $filter = new Search(new Fields([
-            new Text('Name'),
-            new BelongsToMany('Teams'),
+            (new Text('Name'))->searchable(),
+            (new BelongsToMany('Teams'))->searchable(),
         ]));
 
         $this->assertSame(