Merge pull request #241 from brambaud/feat/support-entity-query-execute

Support entity query execute dynamic return type whether it is a count query or not

Author: mglaman

extension.neon

@@ -43,6 +43,9 @@ services:
 	-
 		class: mglaman\PHPStanDrupal\Type\DrupalClassResolverDynamicReturnTypeExtension
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
+	-
+		class: mglaman\PHPStanDrupal\Type\EntityQuery\EntityQueryDynamicReturnTypeExtension
+		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: mglaman\PHPStanDrupal\Type\DrupalClassResolverDynamicStaticReturnTypeExtension
 		tags: [phpstan.broker.dynamicStaticMethodReturnTypeExtension]

src/Type/EntityQuery/EntityQueryCountType.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Type\EntityQuery;
+
+use PHPStan\Type\ObjectType;
+
+/**
+ * Type used to represent an entity query instance as count query.
+ */
+final class EntityQueryCountType extends ObjectType
+{
+
+}

src/Type/EntityQuery/EntityQueryDynamicReturnTypeExtension.php

@@ -0,0 +1,66 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Type\EntityQuery;
+
+use Drupal\Core\Entity\Query\QueryInterface;
+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\IntegerType;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\StringType;
+use PHPStan\Type\Type;
+
+class EntityQueryDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+    public function getClass(): string
+    {
+        return QueryInterface::class;
+    }
+
+    public function isMethodSupported(MethodReflection $methodReflection): bool
+    {
+        return in_array($methodReflection->getName(), [
+            'count',
+            'execute',
+        ], true);
+    }
+
+    public function getTypeFromMethodCall(
+        MethodReflection $methodReflection,
+        MethodCall $methodCall,
+        Scope $scope
+    ): Type {
+        $defaultReturnType = ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
+        $varType = $scope->getType($methodCall->var);
+        $methodName = $methodReflection->getName();
+        if ($methodName === 'count') {
+            if ($varType instanceof ObjectType) {
+                return new EntityQueryCountType(
+                    $varType->getClassName(),
+                    $varType->getSubtractedType(),
+                    $varType->getClassReflection()
+                );
+            }
+            return $defaultReturnType;
+        }
+
+        if ($methodName === 'execute') {
+            if ($varType instanceof EntityQueryCountType) {
+                return new IntegerType();
+            }
+            if ($varType instanceof ObjectType) {
+                // @todo if this is a config storage, it'd string keys.
+                // revisit after https://github.com/mglaman/phpstan-drupal/pull/239
+                // then we can check what kind of storage we have.
+                return new ArrayType(new IntegerType(), new StringType());
+            }
+            return $defaultReturnType;
+        }
+        return $defaultReturnType;
+    }
+}

tests/src/Type/EntityQuery/EntityQueryDynamicReturnTypeExtensionTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Type\EntityQuery;
+
+use mglaman\PHPStanDrupal\Tests\AdditionalConfigFilesTrait;
+use PHPStan\Testing\TypeInferenceTestCase;
+
+final class EntityQueryDynamicReturnTypeExtensionTest extends TypeInferenceTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    public function dataFileAsserts(): iterable
+    {
+        yield from $this->gatherAssertTypes(__DIR__ . '/../data/entity-query-execute.php');
+    }
+
+    /**
+     * @dataProvider dataFileAsserts
+     * @param string $assertType
+     * @param string $file
+     * @param mixed ...$args
+     */
+    public function testFileAsserts(
+        string $assertType,
+        string $file,
+        ...$args
+    ): void
+    {
+        $this->assertFileAsserts($assertType, $file, ...$args);
+    }
+}

tests/src/Type/data/entity-query-execute.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace DrupalEntity;
+
+use function PHPStan\Testing\assertType;
+assertType(
+    'array<int, string>',
+    \Drupal::entityTypeManager()->getStorage('node')->getQuery()
+        ->execute()
+);
+assertType(
+    'array<int, string>',
+    \Drupal::entityTypeManager()->getStorage('node')->getQuery()
+        ->accessCheck(TRUE)
+        ->execute()
+);
+assertType(
+    'int',
+    \Drupal::entityTypeManager()->getStorage('node')->getQuery()
+        ->accessCheck(TRUE)
+        ->count()
+        ->execute()
+);
+assertType(
+    'int',
+    \Drupal::entityQuery('node')
+        ->accessCheck(TRUE)
+        ->count()
+        ->execute()
+);
+assertType(
+    'array<int, string>',
+    \Drupal::entityQuery('node')
+        ->accessCheck(TRUE)
+        ->execute()
+);
+
+$query = \Drupal::entityTypeManager()->getStorage('node')->getQuery()
+    ->accessCheck(TRUE);
+assertType('array<int, string>', $query->execute());
+$query = \Drupal::entityTypeManager()->getStorage('node')->getQuery()
+    ->accessCheck(TRUE)->count();
+assertType('int', $query->execute());