Merge pull request #781 from kayw-geek/bugfix/fix-phpstan-generics

Fix Laravel 9 PHPStan generic check for `__invoke()` method of Filter
spatie · Jul 29, 2022 · 5c6e514 · 5c6e514
2 parents 6f76441 + 7180511
commit 5c6e514
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 1 deletion.
diff --git a/src/Filters/Filter.php b/src/Filters/Filter.php
@@ -4,10 +4,13 @@
 
 use Illuminate\Database\Eloquent\Builder;
 
+/**
+ * @template TModelClass of \Illuminate\Database\Eloquent\Model
+ */
 interface Filter
 {
     /**
-     * @param \Illuminate\Database\Eloquent\Builder<\Illuminate\Database\Eloquent\Model> $query
+     * @param \Illuminate\Database\Eloquent\Builder<TModelClass> $query
      * @param mixed $value
      * @param string $property
      *

diff --git a/src/Filters/FiltersCallback.php b/src/Filters/FiltersCallback.php
@@ -4,6 +4,10 @@
 
 use Illuminate\Database\Eloquent\Builder;
 
+/**
+ * @template TModelClass of \Illuminate\Database\Eloquent\Model
+ * @template-implements \Spatie\QueryBuilder\Filters\Filter<TModelClass>
+ */
 class FiltersCallback implements Filter
 {
     /**

diff --git a/src/Filters/FiltersExact.php b/src/Filters/FiltersExact.php
@@ -7,6 +7,10 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 
+/**
+ * @template TModelClass of \Illuminate\Database\Eloquent\Model
+ * @template-implements \Spatie\QueryBuilder\Filters\Filter<TModelClass>
+ */
 class FiltersExact implements Filter
 {
     protected $relationConstraints = [];
@@ -19,6 +23,7 @@ public function __construct(bool $addRelationConstraint = true)
         $this->addRelationConstraint = $addRelationConstraint;
     }
 
+    /** {@inheritdoc} */
     public function __invoke(Builder $query, $value, string $property)
     {
         if ($this->addRelationConstraint) {

diff --git a/src/Filters/FiltersPartial.php b/src/Filters/FiltersPartial.php
@@ -4,8 +4,13 @@
 
 use Illuminate\Database\Eloquent\Builder;
 
+/**
+ * @template TModelClass of \Illuminate\Database\Eloquent\Model
+ * @template-implements \Spatie\QueryBuilder\Filters\Filter<TModelClass>
+ */
 class FiltersPartial extends FiltersExact implements Filter
 {
+    /** {@inheritdoc} */
     public function __invoke(Builder $query, $value, string $property)
     {
         if ($this->addRelationConstraint) {

diff --git a/src/Filters/FiltersScope.php b/src/Filters/FiltersScope.php
@@ -13,8 +13,13 @@
 use ReflectionUnionType;
 use Spatie\QueryBuilder\Exceptions\InvalidFilterValue;
 
+/**
+ * @template TModelClass of \Illuminate\Database\Eloquent\Model
+ * @template-implements \Spatie\QueryBuilder\Filters\Filter<TModelClass>
+ */
 class FiltersScope implements Filter
 {
+    /** {@inheritdoc} */
     public function __invoke(Builder $query, $values, string $property): Builder
     {
         $propertyParts = collect(explode('.', $property));

diff --git a/src/Filters/FiltersTrashed.php b/src/Filters/FiltersTrashed.php
@@ -4,6 +4,10 @@
 
 use Illuminate\Database\Eloquent\Builder;
 
+/**
+ * @template TModelClass of \Illuminate\Database\Eloquent\Model
+ * @template-implements \Spatie\QueryBuilder\Filters\Filter<TModelClass>
+ */
 class FiltersTrashed implements Filter
 {
     /** {@inheritdoc} */

diff --git a/tests/TestClasses/Filters/FiltersTestModels.php b/tests/TestClasses/Filters/FiltersTestModels.php
@@ -5,8 +5,13 @@
 use Illuminate\Database\Eloquent\Builder;
 use Spatie\QueryBuilder\Filters\Filter;
 
+/**
+ * @template TModelClass of \Illuminate\Database\Eloquent\Model
+ * @template-implements \Spatie\QueryBuilder\Filters\Filter<TModelClass>
+ */
 class FiltersTestModels implements Filter
 {
+    /** {@inheritdoc} */
     public function __invoke(Builder $query, $value, string $property): Builder
     {
         return $query->where($property, $value);