feat: add CollectionHasSpecifyingExtension

Author: shyim

rules.neon

@@ -6,3 +6,9 @@ rules:
     - Shopware\PhpStan\Rule\SetForeignKeyRule
     - Shopware\PhpStan\Rule\MethodBecomesAbstractRule
     - Shopware\PhpStan\Rule\ScheduledTaskTooLowIntervalRule
+
+services:
+    -
+        class: Shopware\PhpStan\Type\CollectionHasSpecifyingExtension
+        tags:
+            - phpstan.typeSpecifier.methodTypeSpecifyingExtension

src/Type/CollectionHasSpecifyingExtension.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Shopware\PhpStan\Type;
+
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Analyser\SpecifiedTypes;
+use PHPStan\Analyser\TypeSpecifier;
+use PHPStan\Analyser\TypeSpecifierAwareExtension;
+use PHPStan\Analyser\TypeSpecifierContext;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\MethodTypeSpecifyingExtension;
+use PHPStan\Type\NullType;
+use PHPStan\Type\TypeCombinator;
+use Shopware\Core\Framework\Struct\Collection;
+
+/**
+ * @internal
+ */
+class CollectionHasSpecifyingExtension implements MethodTypeSpecifyingExtension, TypeSpecifierAwareExtension
+{
+    private TypeSpecifier $typeSpecifier;
+
+    public function getClass(): string
+    {
+        return Collection::class;
+    }
+
+    public function isMethodSupported(MethodReflection $methodReflection, MethodCall $node, TypeSpecifierContext $context): bool
+    {
+        $declaringClass = $methodReflection->getDeclaringClass();
+
+        return (
+            $declaringClass->getName() === Collection::class
+            || $declaringClass->isSubclassOf(Collection::class)
+        )
+            && $methodReflection->getName() === 'has' && !$context->null();
+    }
+
+    public function specifyTypes(
+        MethodReflection $methodReflection,
+        MethodCall $node,
+        Scope $scope,
+        TypeSpecifierContext $context,
+    ): SpecifiedTypes {
+        $getExpr = new MethodCall($node->var, 'get', $node->args);
+
+        $getterTypes = $this->typeSpecifier->create(
+            $getExpr,
+            TypeCombinator::removeNull($scope->getType($getExpr)),
+            $context,
+            $scope,
+        );
+
+        return $getterTypes->unionWith(
+            $this->typeSpecifier->create(
+                $getExpr,
+                new NullType(),
+                $context->negate(),
+                $scope,
+            ),
+        );
+    }
+
+    public function setTypeSpecifier(TypeSpecifier $typeSpecifier): void
+    {
+        $this->typeSpecifier = $typeSpecifier;
+    }
+}

tests/Type/CollectionHasSpecifyingExtensionTest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Shopware\PhpStan\Tests\Type;
+
+use PHPStan\Testing\TypeInferenceTestCase;
+
+class CollectionHasSpecifyingExtensionTest extends TypeInferenceTestCase
+{
+    public function testCollectionHas(): void
+    {
+        foreach (static::gatherAssertTypes(__DIR__ . '/../data/CollectionHasSpecifyingExtension/collection_has.php') as $args) {
+            // because of the autoload issue we can not use data providers as phpstan does itself,
+            // therefore we need to rely on this hacks
+            $assertType = array_shift($args);
+            $file = array_shift($args);
+
+            $this->assertFileAsserts($assertType, $file, ...$args);
+        }
+    }
+
+    public static function getAdditionalConfigFiles(): array
+    {
+        return [
+            __DIR__ . '/../data/CollectionHasSpecifyingExtension/extension.neon',
+        ];
+    }
+}

tests/data/CollectionHasSpecifyingExtension/collection_has.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+use Shopware\Core\Framework\DataAbstractionLayer\Entity;
+use Shopware\Core\Framework\DataAbstractionLayer\EntityCollection;
+
+use function PHPStan\Testing\assertType;
+
+$collection = new EntityCollection(['foo' => new Entity()]);
+
+if ($collection->has('foo')) {
+    assertType(Entity::class, $collection->get('foo'));
+    assertType(Entity::class . '|null', $collection->get('bar'));
+} else {
+    assertType('null', $collection->get('foo'));
+    assertType(Entity::class . '|null', $collection->get('bar'));
+}

tests/data/CollectionHasSpecifyingExtension/extension.neon

@@ -0,0 +1,5 @@
+services:
+        -
+            class: Shopware\PhpStan\Type\CollectionHasSpecifyingExtension
+            tags:
+                - phpstan.typeSpecifier.methodTypeSpecifyingExtension