Run static analysis jobs on PHP 8.1

.github/workflows/static-analysis.yml

@@ -34,7 +34,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "8.0"
+          - "8.1"
 
     steps:
       - name: "Checkout code"
@@ -60,7 +60,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "8.0"
+          - "8.1"
 
     steps:
       - name: Checkout code

lib/Doctrine/DBAL/Cache/ResultCacheStatement.php

@@ -301,7 +301,7 @@ public function fetchFirstColumn(): array
      * this behaviour is not guaranteed for all databases and should not be
      * relied on for portable applications.
      *
-     * @return int The number of rows.
+     * @return int|string The number of rows.
      */
     public function rowCount()
     {

lib/Doctrine/DBAL/Connection.php

@@ -799,7 +799,7 @@ private function addCriteriaCondition(
      * @param array<string, mixed>                                                 $criteria Deletion criteria
      * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types    Parameter types
      *
-     * @return int The number of affected rows.
+     * @return int|string The number of affected rows.
      *
      * @throws Exception
      */
@@ -835,7 +835,7 @@ public function close()
      *
      * @param int $level The level to set.
      *
-     * @return int
+     * @return int|string
      */
     public function setTransactionIsolation($level)
     {
@@ -868,7 +868,7 @@ public function getTransactionIsolation()
      * @param array<string, mixed>                                                 $criteria Update criteria
      * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types    Parameter types
      *
-     * @return int The number of affected rows.
+     * @return int|string The number of affected rows.
      *
      * @throws Exception
      */
@@ -903,7 +903,7 @@ public function update($table, array $data, array $criteria, array $types = [])
      * @param array<string, mixed>                                                 $data  Column-value pairs
      * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types Parameter types
      *
-     * @return int The number of affected rows.
+     * @return int|string The number of affected rows.
      *
      * @throws Exception
      */
@@ -1472,7 +1472,7 @@ public function query()
      * @param array<int, mixed>|array<string, mixed>                               $params Statement parameters
      * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types  Parameter types
      *
-     * @return int The number of affected rows.
+     * @return int|string The number of affected rows.
      *
      * @throws Exception
      */
@@ -1503,7 +1503,7 @@ public function executeUpdate($sql, array $params = [], array $types = [])
      * @param array<int, mixed>|array<string, mixed>                               $params Statement parameters
      * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types  Parameter types
      *
-     * @return int The number of affected rows.
+     * @return int|string The number of affected rows.
      *
      * @throws Exception
      */
@@ -1556,7 +1556,7 @@ public function executeStatement($sql, array $params = [], array $types = [])
      *
      * @param string $sql
      *
-     * @return int The number of affected rows.
+     * @return int|string The number of affected rows.
      *
      * @throws Exception
      */

lib/Doctrine/DBAL/Driver/Connection.php

@@ -43,7 +43,7 @@ public function quote($value, $type = ParameterType::STRING);
      *
      * @param string $sql
      *
-     * @return int
+     * @return int|string
      */
     public function exec($sql);
 

lib/Doctrine/DBAL/Driver/Mysqli/Exception/ConnectionFailed.php

@@ -9,6 +9,8 @@
 use mysqli_sql_exception;
 use ReflectionProperty;
 
+use function assert;
+
 /**
  * @internal
  *
@@ -18,7 +20,10 @@ final class ConnectionFailed extends MysqliException
 {
     public static function new(mysqli $connection): self
     {
-        return new self($connection->connect_error, 'HY000', $connection->connect_errno);
+        $error = $connection->connect_error;
+        assert($error !== null);
+
+        return new self($error, 'HY000', $connection->connect_errno);
     }
 
     public static function upcast(mysqli_sql_exception $exception): self

lib/Doctrine/DBAL/Driver/Result.php

@@ -70,7 +70,7 @@ public function fetchFirstColumn(): array;
      * some database drivers may return the number of rows returned by that query. However, this behaviour
      * is not guaranteed for all drivers and should not be relied on in portable applications.
      *
-     * @return int The number of rows.
+     * @return int|string The number of rows.
      */
     public function rowCount();
 

lib/Doctrine/DBAL/Driver/Statement.php

@@ -103,7 +103,7 @@ public function execute($params = null);
      * this behaviour is not guaranteed for all databases and should not be
      * relied on for portable applications.
      *
-     * @return int The number of rows.
+     * @return int|string The number of rows.
      */
     public function rowCount();
 }

lib/Doctrine/DBAL/Query/QueryBuilder.php

@@ -201,7 +201,7 @@ public function getState()
     /**
      * Executes this query using the bound parameters and their types.
      *
-     * @return ForwardCompatibility\Result|int
+     * @return ForwardCompatibility\Result|int|string
      *
      * @throws Exception
      */

lib/Doctrine/DBAL/Statement.php

@@ -779,7 +779,7 @@ public function iterateColumn(): Traversable
     /**
      * Returns the number of rows affected by the last execution of this statement.
      *
-     * @return int The number of affected rows.
+     * @return int|string The number of affected rows.
      */
     public function rowCount()
     {

phpstan.neon.dist

@@ -125,3 +125,10 @@ parameters:
             message: '~^Parameter #2 \$code of class RuntimeException constructor expects int, string given\.$~'
             paths:
                 - lib/Doctrine/DBAL/Tools/Console/Command/ImportCommand.php
+
+        # Fixing the issue would cause a BC break.
+        # TODO: fix in 4.0.0
+        -
+            message: '~^Method Doctrine\\DBAL\\Statement::executeStatement\(\) should return int but returns int\|string\.$~'
+            paths:
+                - lib/Doctrine/DBAL/Statement.php

psalm.xml.dist

@@ -309,6 +309,14 @@
                 <file name="lib/Doctrine/DBAL/Schema/View.php"/>
             </errorLevel>
         </PropertyNotSetInConstructor>
+        <RedundantCondition>
+            <errorLevel type="suppress">
+                <!--
+                    See https://github.com/vimeo/psalm/pull/7660
+                -->
+                <file name="lib/Doctrine/DBAL/Driver/Mysqli/Exception/ConnectionFailed.php"/>
+            </errorLevel>
+        </RedundantCondition>
         <!-- This is necessary pre 4.0  -->
         <RedundantCastGivenDocblockType>
             <errorLevel type="suppress">
@@ -402,10 +410,24 @@
                 <file name="tests/Doctrine/Tests/DBAL/DriverManagerTest.php"/>
             </errorLevel>
         </InvalidArgument>
+        <InvalidReturnStatement>
+            <errorLevel type="suppress">
+                <!-- lastInsertId has a return type that does not match the one defined in the interface-->
+                <file name="lib/Doctrine/DBAL/Driver/Mysqli/MysqliConnection.php"/>
+                <!--
+                    This issue should be fixed in 4.0
+                -->
+                <file name="lib/Doctrine/DBAL/Statement.php"/>
+            </errorLevel>
+        </InvalidReturnStatement>
         <InvalidReturnType>
             <errorLevel type="suppress">
                 <!-- lastInsertId has a return type that does not match the one defined in the interface-->
                 <file name="lib/Doctrine/DBAL/Driver/Mysqli/MysqliConnection.php"/>
+                <!--
+                    This issue should be fixed in 4.0
+                -->
+                <file name="lib/Doctrine/DBAL/Statement.php"/>
             </errorLevel>
         </InvalidReturnType>
         <InvalidScalarArgument>
@@ -439,11 +461,5 @@
                 <referencedFunction name="db2_autocommit"/>
             </errorLevel>
         </InvalidScalarArgument>
-        <InvalidReturnStatement>
-            <errorLevel type="suppress">
-                <!-- lastInsertId has a return type that does not match the one defined in the interface-->
-                <file name="lib/Doctrine/DBAL/Driver/Mysqli/MysqliConnection.php"/>
-            </errorLevel>
-        </InvalidReturnStatement>
     </issueHandlers>
 </psalm>