- Add tests on return types of Connection::executeQuery()

- More accurate documentation for return types of executed queries

lib/Doctrine/DBAL/Connection.php

@@ -1263,7 +1263,9 @@ public function prepare($sql)
      * @param array<int, mixed>|array<string, mixed>                               $params Query parameters
      * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types  Parameter types
      *
-     * @return ForwardCompatibility\Result The executed statement.
+     * @return ForwardCompatibility\DriverStatement|ForwardCompatibility\DriverResultStatement
+     *
+     * The executed statement or the cached result statement if a query cache profile is used
      *
      * @throws Exception
      */
@@ -1319,7 +1321,7 @@ public function executeQuery($sql, array $params = [], $types = [], ?QueryCacheP
      * @param array<int, mixed>|array<string, mixed>                               $params Query parameters
      * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types  Parameter types
      *
-     * @return ForwardCompatibility\Result
+     * @return ForwardCompatibility\DriverResultStatement
      *
      * @throws CacheException
      */

lib/Doctrine/DBAL/ForwardCompatibility/DriverResultStatement.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Doctrine\DBAL\ForwardCompatibility;
+
+use Doctrine\DBAL;
+
+interface DriverResultStatement extends DBAL\Driver\ResultStatement, DBAL\Result
+{
+}

lib/Doctrine/DBAL/ForwardCompatibility/DriverStatement.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Doctrine\DBAL\ForwardCompatibility;
+
+use Doctrine\DBAL;
+
+interface DriverStatement extends DBAL\Driver\Statement, DBAL\Result
+{
+}

lib/Doctrine/DBAL/ForwardCompatibility/Result.php

@@ -2,12 +2,10 @@
 
 namespace Doctrine\DBAL\ForwardCompatibility;
 
-use Doctrine\DBAL\Driver\ResultStatement as DriverResultStatement;
-use Doctrine\DBAL\Driver\Statement as DriverStatement;
+use Doctrine\DBAL\Driver;
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Exception\NoKeyValue;
 use Doctrine\DBAL\ParameterType;
-use Doctrine\DBAL\Result as BaseResult;
 use Doctrine\Deprecations\Deprecation;
 use IteratorAggregate;
 use PDO;
@@ -20,18 +18,18 @@
  * A wrapper around a Doctrine\DBAL\Driver\ResultStatement that adds 3.0 features
  * defined in Result interface
  */
-final class Result implements IteratorAggregate, DriverStatement, BaseResult
+class Result implements IteratorAggregate, DriverStatement, DriverResultStatement
 {
-    /** @var DriverResultStatement */
+    /** @var Driver\ResultStatement */
     private $stmt;
 
-    public function __construct(DriverResultStatement $stmt)
+    public function __construct(Driver\ResultStatement $stmt)
     {
         $this->stmt = $stmt;
     }
 
     /**
-     * @return DriverResultStatement
+     * @return Driver\ResultStatement
      */
     public function getIterator()
     {
@@ -317,7 +315,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING)
             'Result::bindValue() is deprecated, no replacement.'
         );
 
-        if ($this->stmt instanceof DriverStatement) {
+        if ($this->stmt instanceof Driver\Statement) {
             return $this->stmt->bindValue($param, $value, $type);
         }
 
@@ -337,7 +335,7 @@ public function bindParam($param, &$variable, $type = ParameterType::STRING, $le
             'Result::bindParam() is deprecated, no replacement.'
         );
 
-        if ($this->stmt instanceof DriverStatement) {
+        if ($this->stmt instanceof Driver\Statement) {
             return $this->stmt->bindParam($param, $variable, $type, $length);
         }
 
@@ -357,7 +355,7 @@ public function errorCode()
             'Result::errorCode() is deprecated, the error information is available via exceptions.'
         );
 
-        if ($this->stmt instanceof DriverStatement) {
+        if ($this->stmt instanceof Driver\Statement) {
             return $this->stmt->errorCode();
         }
 
@@ -377,7 +375,7 @@ public function errorInfo()
             'Result::errorInfo() is deprecated, the error information is available via exceptions.'
         );
 
-        if ($this->stmt instanceof DriverStatement) {
+        if ($this->stmt instanceof Driver\Statement) {
             return $this->stmt->errorInfo();
         }
 
@@ -397,7 +395,7 @@ public function execute($params = null)
             'Result::execute() is deprecated, no replacement.'
         );
 
-        if ($this->stmt instanceof DriverStatement) {
+        if ($this->stmt instanceof Driver\Statement) {
             return $this->stmt->execute($params);
         }
 

lib/Doctrine/DBAL/Query/QueryBuilder.php

@@ -4,7 +4,7 @@
 
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Exception;
-use Doctrine\DBAL\ForwardCompatibility\Result as ForwardCompatibleResult;
+use Doctrine\DBAL\ForwardCompatibility;
 use Doctrine\DBAL\ParameterType;
 use Doctrine\DBAL\Query\Expression\CompositeExpression;
 use Doctrine\DBAL\Query\Expression\ExpressionBuilder;
@@ -201,7 +201,7 @@ public function getState()
     /**
      * Executes this query using the bound parameters and their types.
      *
-     * @return ForwardCompatibleResult|int
+     * @return ForwardCompatibility\DriverStatement|ForwardCompatibility\DriverResultStatement|int
      *
      * @throws Exception
      */

tests/Doctrine/Tests/DBAL/Functional/ConnectionTest.php

@@ -6,11 +6,13 @@
 use Doctrine\DBAL\Cache\QueryCacheProfile;
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\ConnectionException;
+use Doctrine\DBAL\Driver;
 use Doctrine\DBAL\Driver\Connection as DriverConnection;
 use Doctrine\DBAL\DriverManager;
 use Doctrine\DBAL\ForwardCompatibility;
 use Doctrine\DBAL\ParameterType;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Result;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\Tests\DbalFunctionalTestCase;
 use Error;
@@ -366,7 +368,32 @@ public function testResultCompatibilityWhenExecutingQueryWithoutParam(): void
             $this->connection->getDatabasePlatform()->getDummySelectSQL()
         );
 
-        self::assertInstanceOf(ForwardCompatibility\Result::class, $result);
+        self::assertInstanceOf(Result::class, $result);
+        self::assertInstanceOf(Driver\Statement::class, $result);
+    }
+
+    public function testResultCompatibilityWhenExecutingQueryWithParams(): void
+    {
+        $result = $this->connection->executeQuery(
+            $this->connection->getDatabasePlatform()->getDummySelectSQL(),
+            ['param1' => 'value']
+        );
+
+        self::assertInstanceOf(Result::class, $result);
+        self::assertInstanceOf(Driver\Statement::class, $result);
+    }
+
+    public function testResultCompatibilityWhenExecutingQueryWithQueryCacheParam(): void
+    {
+        $result = $this->connection->executeQuery(
+            $this->connection->getDatabasePlatform()->getDummySelectSQL(),
+            [],
+            [],
+            new QueryCacheProfile(1, 'cacheKey', new ArrayCache())
+        );
+
+        self::assertInstanceOf(Result::class, $result);
+        self::assertInstanceOf(Driver\ResultStatement::class, $result);
     }
 
     public function testResultCompatibilityWhenExecutingCacheQuery(): void
@@ -378,6 +405,7 @@ public function testResultCompatibilityWhenExecutingCacheQuery(): void
             new QueryCacheProfile(1, 'cacheKey', new ArrayCache())
         );
 
-        self::assertInstanceOf(ForwardCompatibility\Result::class, $result);
+        self::assertInstanceOf(Result::class, $result);
+        self::assertInstanceOf(Driver\ResultStatement::class, $result);
     }
 }