feat: respect custom collection types on builders

Author: Neol3108

extension.neon

@@ -14,6 +14,8 @@ services:
       tags: [phpstan.broker.dynamicFunctionReturnTypeExtension]
     - class: Recoded\PHPStanLaravel\Extensions\Contracts\Container\ContainerDynamicReturnType
       tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
+    - class: Recoded\PHPStanLaravel\Extensions\Eloquent\BuilderCollectionDynamicReturnType
+      tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
     - class: Recoded\PHPStanLaravel\Extensions\StubExtension
       tags: [phpstan.stubFilesExtension]
     - class: Recoded\PHPStanLaravel\DependencyRegistry

src/Extensions/Eloquent/BuilderCollectionDynamicReturnType.php

@@ -0,0 +1,99 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Recoded\PHPStanLaravel\Extensions\Eloquent;
+
+use Illuminate\Contracts\Database\Eloquent\Builder;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Type\ArrayType;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\Generic\GenericObjectType;
+use PHPStan\Type\Generic\TemplateUnionType;
+use PHPStan\Type\IntegerType;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\StringType;
+use PHPStan\Type\Type;
+use PHPStan\Type\UnionType;
+use PHPStan\Type\VerbosityLevel;
+
+final class BuilderCollectionDynamicReturnType implements DynamicMethodReturnTypeExtension
+{
+    public function getClass(): string
+    {
+        return Builder::class;
+    }
+
+    public function isMethodSupported(MethodReflection $methodReflection): bool
+    {
+        $modelType = $methodReflection
+            ->getDeclaringClass()
+            ->getAncestorWithClassName(Builder::class)
+            ?->getActiveTemplateTypeMap()
+            ->getType('TModel');
+
+        if ($modelType === null) {
+            return false;
+        }
+
+        $model = new ObjectType('Illuminate\Database\Eloquent\Model');
+
+        if (!$model->isSuperTypeOf($modelType)->yes()) {
+            return false;
+        }
+
+        foreach ($methodReflection->getVariants() as $variant) {
+            $eloquentCollection = new GenericObjectType('Illuminate\Database\Eloquent\Collection', [
+                new IntegerType(),
+                $modelType,
+            ]);
+
+            if ($eloquentCollection->isSuperTypeOf($variant->getReturnType())->yes()) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): ?Type
+    {
+        /** @var \PHPStan\Type\ObjectType $modelType */
+        $modelType = $methodReflection
+            ->getDeclaringClass()
+            ->getAncestorWithClassName(Builder::class)
+            ?->getActiveTemplateTypeMap()
+            ->getType('TModel');
+
+        $regularReturnType = ParametersAcceptorSelector::selectFromArgs(
+            $scope,
+            $methodCall->getArgs(),
+            $methodReflection->getVariants()
+        )->getReturnType();
+
+        $eloquentCollection = new GenericObjectType('Illuminate\Database\Eloquent\Collection', [
+            new IntegerType(),
+            $modelType,
+        ]);
+
+        if (!$eloquentCollection->isSuperTypeOf($regularReturnType)->yes()) {
+            return null;
+        }
+
+        $newCollectionReflection = $scope->getMethodReflection($modelType, 'newCollection');
+
+        if ($newCollectionReflection === null) {
+            return null;
+        }
+
+        $variant = ParametersAcceptorSelector::selectFromTypes([
+            new ArrayType(new IntegerType(), $modelType),
+        ], $newCollectionReflection->getVariants(), false);
+
+        return $variant->getReturnType();
+    }
+}

stubs/database/eloquent/model.stub

@@ -4,6 +4,13 @@ namespace Illuminate\Database\Eloquent;
 
 class Model
 {
+    /**
+     * @template TKey of array-key
+     * @param array<TKey, static> $models
+     * @return \Illuminate\Database\Eloquent\Collection<TKey, static>
+     */
+    public function newCollection(array $models = []);
+
     /**
      * @param \Illuminate\Database\Query\Builder $query
      * @return \Illuminate\Database\Eloquent\Builder<static>

tests/Types/Fakes/Activity.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Types\Fakes;
+
+use Illuminate\Database\Eloquent\Model;
+use Tests\Types\Fakes\Collections\ActivityCollection;
+
+final class Activity extends Model
+{
+    /**
+     * @template TKey of array-key
+     * @param array<TKey, self> $models
+     * @return \Tests\Types\Fakes\Collections\ActivityCollection<TKey>
+     */
+    public function newCollection(array $models = []): ActivityCollection
+    {
+        return new ActivityCollection($models);
+    }
+}

tests/Types/Fakes/Collections/ActivityCollection.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Types\Fakes\Collections;
+
+use Illuminate\Database\Eloquent\Collection;
+
+/**
+ * @template TKey of array-key
+ * @extends \Illuminate\Database\Eloquent\Collection<TKey, \Tests\Types\Fakes\Activity>
+ */
+final class ActivityCollection extends Collection
+{
+    //
+}

tests/Types/data/database/eloquent/builder.php

@@ -193,3 +193,22 @@
 assertType('Illuminate\Database\Eloquent\Builder<Tests\Types\Fakes\User>', $builder->orWhereDoesntHaveMorph('related', '*', function ($param1) {
     assertType('Illuminate\Database\Eloquent\Builder<Illuminate\Database\Eloquent\Model>', $param1);
 }));
+
+// Custom collections
+
+/** @var \Illuminate\Database\Eloquent\Builder<\Tests\Types\Fakes\Activity> $builder */
+/** @var \Illuminate\Contracts\Support\Arrayable<array-key, mixed> $arrayable */
+
+assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->hydrate([]));
+assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->fromQuery(''));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->find([]));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->find($arrayable));
+assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->findMany([]));
+assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->findMany($arrayable));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->findOrFail([]));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->findOrFail($arrayable));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->findOrNew([]));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->findOrNew($arrayable));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->findOr([]));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->findOr($arrayable));
+assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $builder->get());

tests/Types/data/database/eloquent/relations/relation.php

@@ -68,3 +68,22 @@
 assertType('Illuminate\Database\Eloquent\Relations\Relation<Tests\Types\Fakes\Post, Tests\Types\Fakes\User>', $relation->orWhereDoesntHaveMorph('related', [Post::class, 'media'], function ($param1) {
     assertType('Illuminate\Database\Eloquent\Builder<Tests\Types\Fakes\Post>|Tests\Types\Fakes\Builders\MediaBuilder', $param1);
 }));
+
+// Custom collections
+
+/** @var \Illuminate\Database\Eloquent\Relations\Relation<\Tests\Types\Fakes\User, \Tests\Types\Fakes\Activity> $relation */
+/** @var \Illuminate\Contracts\Support\Arrayable<array-key, mixed> $arrayable */
+
+assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->hydrate([]));
+assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->fromQuery(''));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->find([]));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->find($arrayable));
+assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->findMany([]));
+assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->findMany($arrayable));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->findOrFail([]));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->findOrFail($arrayable));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->findOrNew([]));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->findOrNew($arrayable));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->findOr([]));
+// assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->findOr($arrayable));
+assertType('Tests\Types\Fakes\Collections\ActivityCollection<int>', $relation->get());