doctrine-dbal: use proper interface types (#150)

Co-authored-by: Markus Staab <[email protected]>

Author: staabm

config/DoctrineDbal.stub

@@ -8,3 +8,10 @@ namespace Doctrine\DBAL;
 class Result
 {
 }
+
+/**
+ * @template TValue
+ */
+class Statement
+{
+}

src/Extensions/DoctrineConnectionDynamicReturnTypeExtension.php

@@ -4,8 +4,9 @@
 
 namespace staabm\PHPStanDba\Extensions;
 
-use Doctrine\DBAL\Driver\Connection;
+use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Result;
+use Doctrine\DBAL\Statement;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\MethodCall;
 use PHPStan\Analyser\Scope;
@@ -19,14 +20,22 @@
 
 final class DoctrineConnectionDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
 {
+    /**
+     * @var array<string, class-string> return types of Connection methods in doctrine 3.x
+     */
+    private $resultMap = [
+        'query' => Result::class,
+        //'prepare' => Statement::class,
+    ];
+
     public function getClass(): string
     {
         return Connection::class;
     }
 
     public function isMethodSupported(MethodReflection $methodReflection): bool
     {
-        return 'query' === $methodReflection->getName();
+        return \in_array(strtolower($methodReflection->getName()), ['query'/*, 'prepare'*/], true);
     }
 
     public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type
@@ -42,27 +51,26 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
             return $defaultReturn;
         }
 
-        $resultType = $this->inferType($methodCall, $args[0]->value, $scope);
+        $resultType = $this->inferType($methodReflection, $args[0]->value, $scope);
         if (null !== $resultType) {
             return $resultType;
         }
 
         return $defaultReturn;
     }
 
-    private function inferType(MethodCall $methodCall, Expr $queryExpr, Scope $scope): ?Type
+    private function inferType(MethodReflection $methodReflection, Expr $queryExpr, Scope $scope): ?Type
     {
-        $args = $methodCall->getArgs();
-
         $queryReflection = new QueryReflection();
         $queryString = $queryReflection->resolveQueryString($queryExpr, $scope);
         if (null === $queryString) {
             return null;
         }
 
+        $genericMainType = $this->resultMap[strtolower($methodReflection->getName())];
         $resultType = $queryReflection->getResultType($queryString, QueryReflector::FETCH_TYPE_BOTH);
         if ($resultType) {
-            return new GenericObjectType(Result::class, [$resultType]);
+            return new GenericObjectType($genericMainType, [$resultType]);
         }
 
         return null;

tests/data/doctrine-dbal.php

@@ -2,7 +2,7 @@
 
 namespace DoctrineDbalTest;
 
-use Doctrine\DBAL\Driver\Connection;
+use Doctrine\DBAL\Connection;
 use function PHPStan\Testing\assertType;
 
 class Foo