Merge branch '4.2.x' into 5.0.x

* 4.2.x: Fix more PHPStan errors Use generators for large data providers (#6508) PHPStan 1.12 (#6507) Raise a proper exception when calling `getColumnName()` with negative index (#6505)
doctrine · Aug 28, 2024 · d53d332 · d53d332
2 parents 261590e + b9183ca
commit d53d332
Show file tree

Hide file tree

Showing 9 changed files with 406 additions and 359 deletions.
diff --git a/composer.json b/composer.json
@@ -40,7 +40,7 @@
         "doctrine/coding-standard": "12.0.0",
         "fig/log-test": "^1",
         "jetbrains/phpstorm-stubs": "2023.2",
-        "phpstan/phpstan": "1.11.10",
+        "phpstan/phpstan": "1.12.0",
         "phpstan/phpstan-phpunit": "1.4.0",
         "phpstan/phpstan-strict-rules": "^1.6",
         "phpunit/phpunit": "10.5.30",

diff --git a/src/Cache/ArrayResult.php b/src/Cache/ArrayResult.php
@@ -88,11 +88,8 @@ public function columnCount(): int
 
     public function getColumnName(int $index): string
     {
-        if ($this->data === [] || $index > count($this->data[0])) {
-            throw InvalidColumnIndex::new($index);
-        }
-
-        return array_keys($this->data[0])[$index];
+        return array_keys($this->data[0] ?? [])[$index]
+            ?? throw InvalidColumnIndex::new($index);
     }
 
     public function free(): void

diff --git a/src/Driver/AbstractMySQLDriver.php b/src/Driver/AbstractMySQLDriver.php
@@ -73,7 +73,7 @@ private function getMariaDbMysqlVersionNumber(string $versionString): string
                 '/^(?:5\.5\.5-)?(mariadb-)?(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)/i',
                 $versionString,
                 $versionParts,
-            ) === 0
+            ) !== 1
         ) {
             throw InvalidPlatformVersion::new(
                 $versionString,

diff --git a/src/Driver/PDO/Result.php b/src/Driver/PDO/Result.php
@@ -9,6 +9,7 @@
 use PDO;
 use PDOException;
 use PDOStatement;
+use ValueError;
 
 final class Result implements ResultInterface
 {
@@ -78,15 +79,17 @@ public function getColumnName(int $index): string
     {
         try {
             $meta = $this->statement->getColumnMeta($index);
-
-            if ($meta === false) {
-                throw InvalidColumnIndex::new($index);
-            }
-
-            return $meta['name'];
+        } catch (ValueError $exception) {
+            throw InvalidColumnIndex::new($index, $exception);
         } catch (PDOException $exception) {
             throw Exception::new($exception);
         }
+
+        if ($meta === false) {
+            throw InvalidColumnIndex::new($index);
+        }
+
+        return $meta['name'];
     }
 
     public function free(): void

diff --git a/src/Exception/InvalidColumnIndex.php b/src/Exception/InvalidColumnIndex.php
@@ -6,14 +6,15 @@
 
 use Doctrine\DBAL\Exception;
 use LogicException;
+use Throwable;
 
 use function sprintf;
 
 /** @psalm-immutable */
 final class InvalidColumnIndex extends LogicException implements Exception
 {
-    public static function new(int $index): self
+    public static function new(int $index, ?Throwable $previous = null): self
     {
-        return new self(sprintf('Invalid column index "%s".', $index));
+        return new self(sprintf('Invalid column index "%s".', $index), previous: $previous);
     }
 }
diff --git a/src/Schema/SQLiteSchemaManager.php b/src/Schema/SQLiteSchemaManager.php
@@ -221,19 +221,22 @@ protected function _getPortableTableColumnList(string $table, string $database,
      */
     protected function _getPortableTableColumnDefinition(array $tableColumn): Column
     {
-        preg_match('/^([^()]*)\\s*(\\(((\\d+)(,\\s*(\\d+))?)\\))?/', $tableColumn['type'], $matches);
+        $matchResult = preg_match('/^([^()]*)\\s*(\\(((\\d+)(,\\s*(\\d+))?)\\))?/', $tableColumn['type'], $matches);
+        assert($matchResult === 1);
 
         $dbType = trim(strtolower($matches[1]));
 
-        $length = $precision = $unsigned = null;
+        $length = $precision = null;
         $fixed  = $unsigned = false;
         $scale  = 0;
 
-        if (count($matches) >= 6) {
-            $precision = (int) $matches[4];
-            $scale     = (int) $matches[6];
-        } elseif (count($matches) >= 4) {
-            $length = (int) $matches[4];
+        if (isset($matches[4])) {
+            if (isset($matches[6])) {
+                $precision = (int) $matches[4];
+                $scale     = (int) $matches[6];
+            } else {
+                $length = (int) $matches[4];
+            }
         }
 
         if (str_contains($dbType, ' unsigned')) {

diff --git a/tests/Cache/ArrayStatementTest.php b/tests/Cache/ArrayStatementTest.php
@@ -5,6 +5,8 @@
 namespace Doctrine\DBAL\Tests\Cache;
 
 use Doctrine\DBAL\Cache\ArrayResult;
+use Doctrine\DBAL\Exception\InvalidColumnIndex;
+use PHPUnit\Framework\Attributes\TestWith;
 use PHPUnit\Framework\TestCase;
 
 use function array_values;
@@ -49,6 +51,16 @@ public function testColumnNames(): void
         self::assertSame('active', $statement->getColumnName(1));
     }
 
+    #[TestWith([2])]
+    #[TestWith([-1])]
+    public function testColumnNameWithInvalidIndex(int $index): void
+    {
+        $statement = $this->createTestArrayStatement();
+        $this->expectException(InvalidColumnIndex::class);
+
+        $statement->getColumnName($index);
+    }
+
     public function testRowCount(): void
     {
         $statement = $this->createTestArrayStatement();