Skip to content

Improve QueryBuilder Generic Support #1012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 25, 2025
Merged

Improve QueryBuilder Generic Support #1012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c4cf2ee
use method declared generic for query builder for, as static method c…
liamduckett Jul 19, 2025
4b41ef2
allow inferring generic for query builder for when called with a rela…
liamduckett Jul 19, 2025
7f42132
fix incorrect generic on query builder for docblock
liamduckett Jul 23, 2025
0fd2e4f
add type assertion test for query builder for
liamduckett Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions phpstan.neon.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ parameters:
- src/
- config/
- database/
- types/

# Level 9 is the highest level
level: 5
Expand Down
8 changes: 5 additions & 3 deletions src/QueryBuilder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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;
Expand Down
22 changes: 22 additions & 0 deletions types/query-builder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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()));