Merge pull request #76 from spatie/allow-instantiated-filters

Allow for instantiated custom filters
spatie · Jun 12, 2018 · b1333e2 · b1333e2
2 parents 69323ce + c2bb23b
commit b1333e2
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-query-builder` will be documented in this file
 
+## 1.10.0 - 2018-06-12
+
+- add support for instantiated custom filter classes
+
 ## 1.9.6 - 2018-06-11
 
 - fix for using reserved SQL words as attributes in Postgres

diff --git a/src/Filter.php b/src/Filter.php
@@ -6,6 +6,7 @@
 use Spatie\QueryBuilder\Filters\FiltersExact;
 use Spatie\QueryBuilder\Filters\FiltersScope;
 use Spatie\QueryBuilder\Filters\FiltersPartial;
+use Spatie\QueryBuilder\Filters\Filter as CustomFilter;
 
 class Filter
 {
@@ -15,15 +16,15 @@ class Filter
     /** @var string */
     protected $property;
 
-    public function __construct(string $property, string $filterClass)
+    public function __construct(string $property, $filterClass)
     {
         $this->property = $property;
         $this->filterClass = $filterClass;
     }
 
     public function filter(Builder $builder, $value)
     {
-        $filterClass = new $this->filterClass;
+        $filterClass = $this->resolveFilterClass();
 
         ($filterClass)($builder, $value, $this->property);
     }
@@ -43,7 +44,7 @@ public static function scope(string $property) : self
         return new static($property, FiltersScope::class);
     }
 
-    public static function custom(string $property, string $filterClass) : self
+    public static function custom(string $property, $filterClass) : self
     {
         return new static($property, $filterClass);
     }
@@ -57,4 +58,13 @@ public function isForProperty(string $property): bool
     {
         return $this->property === $property;
     }
+
+    private function resolveFilterClass(): CustomFilter
+    {
+        if ($this->filterClass instanceof CustomFilter) {
+            return $this->filterClass;
+        }
+
+        return new $this->filterClass;
+    }
 }
diff --git a/tests/FilterTest.php b/tests/FilterTest.php
@@ -9,6 +9,7 @@
 use Illuminate\Database\Eloquent\Builder;
 use Spatie\QueryBuilder\Tests\Models\TestModel;
 use Spatie\QueryBuilder\Exceptions\InvalidFilterQuery;
+use Spatie\QueryBuilder\Filters\Filter as CustomFilter;
 use Spatie\QueryBuilder\Filters\Filter as FilterInterface;
 
 class FilterTest extends TestCase
@@ -238,6 +239,36 @@ public function it_guards_against_invalid_filters()
             ->allowedFilters('id');
     }
 
+    /** @test */
+    public function it_can_create_a_custom_filter_with_an_instantiated_filter()
+    {
+        $customFilter = new class('test1') implements CustomFilter {
+            /** @var string */
+            private $filter;
+
+            public function __construct(string $filter)
+            {
+                $this->filter = $filter;
+            }
+
+            public function __invoke(Builder $query, $value, string $property): Builder
+            {
+                return $query;
+            }
+        };
+
+        TestModel::create(['name' => 'abcdef']);
+
+        $results = $this
+            ->createQueryFromFilterRequest([
+                '*' => '*',
+            ])
+            ->allowedFilters('name', Filter::custom('*', $customFilter))
+            ->get();
+
+        $this->assertNotEmpty($results);
+    }
+
     /** @test */
     public function an_invalid_filter_query_exception_contains_the_unknown_and_allowed_filters()
     {