PDO: added PDO::FETCH_KEY_PAIR support (#303)

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

Author: staabm

src/DoctrineReflection/DoctrineReflection.php

@@ -23,6 +23,7 @@
 use staabm\PHPStanDba\QueryReflection\QueryReflector;
 use Traversable;
 
+// XXX move into a "Reflection" package on next major version
 final class DoctrineReflection
 {
     public function reduceResultType(MethodReflection $methodReflection, Type $resultType): ?Type

src/PdoReflection/PdoStatementReflection.php

@@ -8,6 +8,7 @@
 use PDOStatement;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Type\ArrayType;
 use PHPStan\Type\Constant\ConstantArrayType;
 use PHPStan\Type\Constant\ConstantArrayTypeBuilder;
 use PHPStan\Type\Constant\ConstantIntegerType;
@@ -20,8 +21,10 @@
 use staabm\PHPStanDba\QueryReflection\QueryReflection;
 use staabm\PHPStanDba\QueryReflection\QueryReflector;
 
+// XXX move into a "Reflection" package on next major version
 final class PdoStatementReflection
 {
+    // XXX move into separate class on next major version
     public function findPrepareQueryStringExpression(MethodCall $methodCall): ?Expr
     {
         $exprFinder = new ExpressionFinder();
@@ -37,6 +40,7 @@ public function findPrepareQueryStringExpression(MethodCall $methodCall): ?Expr
         return null;
     }
 
+    // XXX move into separate class on next major version
     /**
      * @return MethodCall[]
      */
@@ -58,7 +62,9 @@ public function getFetchType(Type $fetchModeType): ?int
             return null;
         }
 
-        if (PDO::FETCH_ASSOC === $fetchModeType->getValue()) {
+        if (PDO::FETCH_KEY_PAIR === $fetchModeType->getValue()) {
+            return QueryReflector::FETCH_TYPE_KEY_VALUE;
+        } elseif (PDO::FETCH_ASSOC === $fetchModeType->getValue()) {
             return QueryReflector::FETCH_TYPE_ASSOC;
         } elseif (PDO::FETCH_NUM === $fetchModeType->getValue()) {
             return QueryReflector::FETCH_TYPE_NUMERIC;
@@ -153,10 +159,17 @@ public function getColumnRowType(Type $statementType, int $columnIndex): ?Type
      */
     private function reduceStatementResultType(Type $bothType, int $fetchType): Type
     {
+        if (!$bothType instanceof ConstantArrayType) {
+            return $bothType;
+        }
+
+        if (\count($bothType->getValueTypes()) <= 0) {
+            return $bothType;
+        }
+
         // turn a BOTH typed statement into either NUMERIC or ASSOC
         if (
-            (QueryReflector::FETCH_TYPE_NUMERIC === $fetchType || QueryReflector::FETCH_TYPE_ASSOC === $fetchType) &&
-            $bothType instanceof ConstantArrayType && \count($bothType->getValueTypes()) > 0
+            QueryReflector::FETCH_TYPE_NUMERIC === $fetchType || QueryReflector::FETCH_TYPE_ASSOC === $fetchType
         ) {
             $builder = ConstantArrayTypeBuilder::createEmpty();
 
@@ -174,6 +187,13 @@ private function reduceStatementResultType(Type $bothType, int $fetchType): Type
             return $builder->getArray();
         }
 
+        // both types contains numeric and string keys, therefore the count is doubled
+        if (QueryReflector::FETCH_TYPE_KEY_VALUE === $fetchType && \count($bothType->getValueTypes()) >= 4) {
+            $valueTypes = $bothType->getValueTypes();
+
+            return new ArrayType($valueTypes[0], $valueTypes[2]);
+        }
+
         // not yet supported fetch type - or $fetchType == BOTH
         return $bothType;
     }

tests/default/data/pdo-stmt-fetch.php

@@ -37,6 +37,9 @@ public function fetchAll(PDO $pdo)
         $all = $stmt->fetchAll(PDO::FETCH_COLUMN, 1);
         assertType('array<int, int<0, 4294967295>>', $all);
 
+        $all = $stmt->fetchAll(PDO::FETCH_KEY_PAIR);
+        assertType('array<int, array<string, int<0, 4294967295>>>', $all);
+
         // not yet supported fetch types
         $all = $stmt->fetchAll(PDO::FETCH_OBJ);
         assertType('array', $all); // XXX since php8 this cannot return false
@@ -72,6 +75,9 @@ public function fetch(PDO $pdo)
         $all = $stmt->fetch(PDO::FETCH_COLUMN, 1);
         assertType('int<0, 4294967295>|false', $all);
 
+        $all = $stmt->fetch(PDO::FETCH_KEY_PAIR);
+        assertType('array<string, int<0, 4294967295>>|false', $all);
+
         // not yet supported fetch types
         $all = $stmt->fetch(PDO::FETCH_OBJ);
         assertType('mixed', $all);