Fix type hinting depending on Eloquent or Query Builder instance (#324)

Author: GeniJaho

docs/rector_rules_overview.md

@@ -615,11 +615,22 @@ Add type hinting to where relation has methods e.g. `whereHas`, `orWhereHas`, `w
 
 ## EloquentWhereTypeHintClosureParameterRector
 
-Change typehint of closure parameter in where method of Eloquent Builder
+Change typehint of closure parameter in where method of Eloquent or Query Builder
 
 - class: [`RectorLaravel\Rector\MethodCall\EloquentWhereTypeHintClosureParameterRector`](../src/Rector/MethodCall/EloquentWhereTypeHintClosureParameterRector.php)
 
 ```diff
+ /** @var \Illuminate\Contracts\Database\Query\Builder $query */
+-$query->where(function ($query) {
++$query->where(function (\Illuminate\Contracts\Database\Query\Builder $query) {
+     $query->where('id', 1);
+ });
+```
+
+<br>
+
+```diff
+ /** @var \Illuminate\Contracts\Database\Eloquent\Builder $query */
 -$query->where(function ($query) {
 +$query->where(function (\Illuminate\Contracts\Database\Eloquent\Builder $query) {
      $query->where('id', 1);

src/Rector/MethodCall/EloquentWhereTypeHintClosureParameterRector.php

@@ -11,6 +11,7 @@
 use PhpParser\Node\Expr\StaticCall;
 use PhpParser\Node\Name;
 use PhpParser\Node\Name\FullyQualified;
+use PHPStan\Type\ObjectType;
 use RectorLaravel\AbstractRector;
 use RectorLaravel\NodeAnalyzer\QueryBuilderAnalyzer;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -26,16 +27,34 @@ public function __construct(private readonly QueryBuilderAnalyzer $queryBuilderA
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition(
-            'Change typehint of closure parameter in where method of Eloquent Builder',
+            'Change typehint of closure parameter in where method of Eloquent or Query Builder',
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
+/** @var \Illuminate\Contracts\Database\Query\Builder $query */
 $query->where(function ($query) {
     $query->where('id', 1);
 });
 CODE_SAMPLE
                     ,
                     <<<'CODE_SAMPLE'
+/** @var \Illuminate\Contracts\Database\Query\Builder $query */
+$query->where(function (\Illuminate\Contracts\Database\Query\Builder $query) {
+    $query->where('id', 1);
+});
+CODE_SAMPLE
+                    ,
+                ),
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+/** @var \Illuminate\Contracts\Database\Eloquent\Builder $query */
+$query->where(function ($query) {
+    $query->where('id', 1);
+});
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+/** @var \Illuminate\Contracts\Database\Eloquent\Builder $query */
 $query->where(function (\Illuminate\Contracts\Database\Eloquent\Builder $query) {
     $query->where('id', 1);
 });
@@ -92,7 +111,15 @@ private function changeClosureParamType(MethodCall|StaticCall $node): void
             return;
         }
 
-        $param->type = new FullyQualified('Illuminate\Contracts\Database\Query\Builder');
+        $classOrVar = $node instanceof MethodCall
+            ? $node->var
+            : $node->class;
+
+        $type = $this->isObjectType($classOrVar, new ObjectType('Illuminate\Database\Eloquent\Model'))
+            ? 'Illuminate\Contracts\Database\Eloquent\Builder'
+            : 'Illuminate\Contracts\Database\Query\Builder';
+
+        $param->type = new FullyQualified($type);
     }
 
     private function expectedObjectTypeAndMethodCall(MethodCall|StaticCall $node): bool

stubs/Illuminate/Contracts/Database/Eloquent/Builder.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Illuminate\Contracts\Database\Eloquent;
+
+use Illuminate\Contracts\Database\Query\Builder as BaseContract;
+
+if (interface_exists('Illuminate\Contracts\Database\Eloquent\Builder')) {
+    return;
+}
+
+/**
+ * This interface is intentionally empty and exists to improve IDE support.
+ *
+ * @mixin \Illuminate\Database\Eloquent\Builder
+ */
+interface Builder extends BaseContract {}

tests/Rector/MethodCall/EloquentWhereTypeHintClosureParameterRector/Fixture/fixture2.php.inc

@@ -17,7 +17,7 @@ namespace RectorLaravel\Tests\Rector\MethodCall\EloquentWhereTypeHintClosurePara
 
 use RectorLaravel\Tests\Rector\MethodCall\EloquentWhereTypeHintClosureParameterRector\Source\FooModel;
 
-FooModel::where(function (\Illuminate\Contracts\Database\Query\Builder $query) {
+FooModel::where(function (\Illuminate\Contracts\Database\Eloquent\Builder $query) {
     $query->where('id', 1)
         ->orWhere('id', 2);
 });