fix: dont override return type when eloquent builder returns a query …

…builder instance
larastan · Jul 24, 2020 · b5f96b4 · b5f96b4
1 parent c54b517
commit b5f96b4
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 1 deletion.
diff --git a/src/Methods/BuilderHelper.php b/src/Methods/BuilderHelper.php
@@ -178,9 +178,15 @@ public function getMethodReflectionFromBuilder(
                 $returnType = $customReturnType;
             }
 
-            $isBuilderReferenced = (count(array_intersect([EloquentBuilder::class, QueryBuilder::class], $returnType->getReferencedClasses())) > 0)
+            $isBuilderReferenced = (
+                count(array_intersect([EloquentBuilder::class, QueryBuilder::class], $returnType->getReferencedClasses())) > 0)
                 || (new ObjectType(EloquentBuilder::class))->isSuperTypeOf($returnType)->yes();
 
+            // A special case for when return type is just the `QueryBuilder`
+            if ($returnType instanceof ObjectType && $returnType->getClassName() === QueryBuilder::class) {
+                $isBuilderReferenced = false;
+            }
+
             if ($isBuilderReferenced) {
                 $returnType = $customReturnType;
             }

diff --git a/tests/Features/Methods/Builder.php b/tests/Features/Methods/Builder.php
@@ -6,6 +6,8 @@
 
 use App\User;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Query\Builder as QueryBuilder;
+use stdClass;
 
 class Builder
 {
@@ -28,4 +30,30 @@ public function testDynamicWhereAsInt(): ?User
     {
         return (new User())->whereFoo(1)->first();
     }
+
+    public function testGetQueryReturnsQueryBuilder(): QueryBuilder
+    {
+        return User::getQuery();
+    }
+
+    public function testToBaseReturnsQueryBuilder(): QueryBuilder
+    {
+        return User::toBase();
+    }
+
+    public function testToBaseReturnsQueryBuilderAfterChain(): QueryBuilder
+    {
+        return User::whereNull('foo')
+            ->orderBy('fooBar')
+            ->toBase();
+    }
+
+    public function testQueryBuilderChainStartedWithGetQueryReturnsStdClass(): ?stdClass
+    {
+        return User::getQuery()
+        ->select('some_model.created')
+        ->where('some_model.some_column', '=', true)
+        ->orderBy('some_model.created', 'desc')
+        ->first();
+    }
 }