Merge pull request #1012 from liamduckett/main

Improve QueryBuilder Generic Support

Author: freekmurze

phpstan.neon.dist

@@ -8,6 +8,7 @@ parameters:
         - src/
         - config/
         - database/
+        - types/
 
     # Level 9 is the highest level
     level: 5

src/QueryBuilder.php

@@ -51,8 +51,10 @@ public function getSubject(): Relation|EloquentBuilder
     }
 
     /**
-     * @param EloquentBuilder<TModel>|Relation|class-string<TModel> $subject
-     * @return static<TModel>
+     * @template T of Model
+     *
+     * @param EloquentBuilder<T>|Relation<T, *, *>|class-string<T> $subject
+     * @return static<T>
      */
     public static function for(
         EloquentBuilder|Relation|string $subject,
@@ -62,7 +64,7 @@ public static function for(
             $subject = $subject::query();
         }
 
-        /** @var static<TModel> $queryBuilder */
+        /** @var static<T> $queryBuilder */
         $queryBuilder = new static($subject, $request);
 
         return $queryBuilder;

types/query-builder.php

@@ -0,0 +1,22 @@
+<?php
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Spatie\QueryBuilder\QueryBuilder;
+use function PHPStan\Testing\assertType;
+
+class Book extends Model {
+    /**
+     * @return BelongsTo<Author, $this>
+     */
+    public function author(): BelongsTo
+    {
+        return $this->belongsTo(Author::class);
+    }
+}
+
+class Author extends Model {}
+
+assertType('Spatie\QueryBuilder\QueryBuilder<Book>', QueryBuilder::for(Book::class));
+assertType('Spatie\QueryBuilder\QueryBuilder<Book>', QueryBuilder::for(Book::query()));
+assertType('Spatie\QueryBuilder\QueryBuilder<Author>', QueryBuilder::for((new Book)->author()));