restore comment hint (useful for enumtype declaration)

.github/dependabot.yml

@@ -6,4 +6,4 @@ updates:
       interval: "weekly"
     labels:
       - "CI"
-    target-branch: "3.8.x"
+    target-branch: "3.9.x"

.github/workflows/coding-standards.yml

@@ -25,4 +25,4 @@ on:
 jobs:
   coding-standards:
     name: "Coding Standards"
-    uses: "doctrine/.github/.github/workflows/coding-standards.yml@5.0.1"
+    uses: "doctrine/.github/.github/workflows/coding-standards.yml@5.2.0"

.github/workflows/continuous-integration.yml

@@ -40,6 +40,7 @@ jobs:
           - "8.1"
           - "8.2"
           - "8.3"
+          - "8.4"
         dependencies:
           - "highest"
         extension:
@@ -107,6 +108,9 @@ jobs:
           - "18"
           - "21"
           - "23"
+        include:
+          - php-version: "8.4"
+            oracle-version: "23"
 
     services:
       oracle:
@@ -164,6 +168,9 @@ jobs:
           - "18"
           - "21"
           - "23"
+        include:
+          - php-version: "8.4"
+            oracle-version: "23"
 
     services:
       oracle:
@@ -227,6 +234,12 @@ jobs:
             postgres-version: "16"
             extension: "pgsql"
           - php-version: "8.3"
+            postgres-version: "16"
+            extension: "pgsql"
+          - php-version: "8.4"
+            postgres-version: "16"
+            extension: "pgsql"
+          - php-version: "8.4"
             postgres-version: "16"
             extension: "pdo_pgsql"
 
@@ -299,6 +312,12 @@ jobs:
           - php-version: "8.3"
             mariadb-version: "11.4"
             extension: "pdo_mysql"
+          - php-version: "8.4"
+            mariadb-version: "11.4"
+            extension: "mysqli"
+          - php-version: "8.4"
+            mariadb-version: "11.4"
+            extension: "pdo_mysql"
 
     services:
       mariadb:
@@ -381,6 +400,12 @@ jobs:
             extension: "pdo_mysql"
             custom-entrypoint: >-
               --entrypoint sh mysql:8.4 -c "exec docker-entrypoint.sh mysqld --mysql-native-password=ON"
+          - php-version: "8.4"
+            mysql-version: "9.0"
+            extension: "mysqli"
+          - php-version: "8.4"
+            mysql-version: "9.0"
+            extension: "pdo_mysql"
 
     services:
       mysql:
@@ -438,6 +463,7 @@ jobs:
           - "8.1"
           - "8.2"
           - "8.3"
+          - "8.4"
         extension:
           - "sqlsrv"
           - "pdo_sqlsrv"
@@ -505,6 +531,7 @@ jobs:
           - "8.1"
           - "8.2"
           - "8.3"
+          - "8.4"
 
     services:
       ibm_db2:

.github/workflows/documentation.yml

@@ -0,0 +1,20 @@
+name: "Documentation"
+
+on:
+  pull_request:
+    branches:
+      - "*.x"
+    paths:
+      - ".github/workflows/documentation.yml"
+      - "docs/**"
+  push:
+    branches:
+      - "*.x"
+    paths:
+      - ".github/workflows/documentation.yml"
+      - "docs/**"
+
+jobs:
+  documentation:
+    name: "Documentation"
+    uses: "doctrine/.github/.github/workflows/[email protected]"

.github/workflows/release-on-milestone-closed.yml

@@ -15,7 +15,7 @@ jobs:
         uses: "actions/checkout@v4"
 
       - name: "Release"
-        uses: "laminas/automatic-releases@1.24.0"
+        uses: "laminas/automatic-releases@1.25.0"
         with:
           command-name: "laminas:automatic-releases:release"
         env:

composer.json

@@ -40,7 +40,7 @@
         "doctrine/coding-standard": "12.0.0",
         "fig/log-test": "^1",
         "jetbrains/phpstorm-stubs": "2023.2",
-        "phpstan/phpstan": "1.12.0",
+        "phpstan/phpstan": "1.12.6",
         "phpstan/phpstan-phpunit": "1.4.0",
         "phpstan/phpstan-strict-rules": "^1.6",
         "phpunit/phpunit": "10.5.30",

docs/en/reference/configuration.rst

@@ -409,7 +409,7 @@ Connect to your Postgres server and run the ``SHOW server_version`` query::
     (1 row)
 
 In the example above, ``15.2 (Debian 15.2-1.pgdg110+1)`` is the correct value for
-``server Version``.
+``serverVersion``.
 
 Other Platforms
 ^^^^^^^^^^^^^^^

docs/en/reference/testing.rst

@@ -85,7 +85,7 @@ We do not currently have specific instructions on how to run a Database
 server, but we do recommend Docker as a convenient way to do so.
 We do not recommend running against a particular version of the chosen
 RDBMS either, as long as you pick one of the
-:doc:`officially supported versions <reference/platforms>`.
+:doc:`officially supported versions <platforms>`.
 
 Recommendations on Writing Tests
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/en/sidebar.rst

@@ -1,41 +1,36 @@
-.. toc::
-
-   .. tocheader:: Reference
-
-   .. toctree::
-      :depth: 3
-
-      /reference/introduction
-      /reference/architecture
-      /reference/configuration
-      /reference/data-retrieval-and-manipulation
-      /reference/query-builder
-      /reference/transactions
-      /reference/platforms
-      /reference/types
-      /reference/schema-manager
-      /reference/schema-representation
-      /reference/security
-      /reference/supporting-other-databases
-      /reference/portability
-      /reference/caching
-      /reference/known-vendor-issues
-      /reference/testing
-
-.. toc::
-
-   .. tocheader:: Explanation
-
-   .. toctree::
-      :depth: 3
-
-      /explanation/implicit-indexes
-
-.. toc::
-
-   .. tocheader:: How To
-
-   .. toctree::
-      :depth: 3
-
-      /how-to/postgresql-identity-migration
+:orphan:
+
+.. toctree::
+   :caption: Reference
+   :depth: 3
+
+   /reference/introduction
+   /reference/architecture
+   /reference/configuration
+   /reference/data-retrieval-and-manipulation
+   /reference/query-builder
+   /reference/transactions
+   /reference/platforms
+   /reference/types
+   /reference/schema-manager
+   /reference/schema-representation
+   /reference/security
+   /reference/supporting-other-databases
+   /reference/portability
+   /reference/caching
+   /reference/known-vendor-issues
+   /reference/cli-tools
+   /reference/testing
+
+
+.. toctree::
+   :caption: Explanation
+   :depth: 3
+
+   /explanation/implicit-indexes
+
+.. toctree::
+   :caption: How To
+   :depth: 3
+
+   /how-to/postgresql-identity-migration

phpstan.neon.dist

@@ -63,6 +63,9 @@ parameters:
         -
             message: '~^Parameter #1 \$driverOptions of method Doctrine\\DBAL\\Tests\\Functional\\Driver\\Mysqli\\ConnectionTest\:\:getConnection\(\) expects array<string, mixed>, .* given\.$~'
             path: tests/Functional/Driver/Mysqli/ConnectionTest.php
+        -
+            message: '~^Parameter #1 \$params of method Doctrine\\DBAL\\Driver\:\:connect\(\) expects array~'
+            path: tests/Driver/PDO/*/DriverTest.php
 
         # DriverManagerTest::testDatabaseUrl() should be refactored as it's too dynamic.
         -

psalm.xml.dist

@@ -134,6 +134,7 @@
         <InvalidArgument>
             <errorLevel type="suppress">
                 <!-- We're testing with invalid input here. -->
+                <file name="tests/Driver/PDO/*/DriverTest.php"/>
                 <file name="tests/Functional/Driver/Mysqli/ConnectionTest.php"/>
                 <file name="tests/Platforms/AbstractPlatformTestCase.php"/>
             </errorLevel>

src/Driver/PDO/Exception/InvalidConfiguration.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Driver\PDO\Exception;
+
+use Doctrine\DBAL\Driver\AbstractException;
+
+use function get_debug_type;
+use function sprintf;
+
+/** @psalm-immutable */
+final class InvalidConfiguration extends AbstractException
+{
+    public static function notAStringOrNull(string $key, mixed $value): self
+    {
+        return new self(sprintf(
+            'The %s configuration parameter is expected to be either a string or null, got %s.',
+            $key,
+            get_debug_type($value),
+        ));
+    }
+}

src/Driver/PDO/MySQL/Driver.php

@@ -7,10 +7,13 @@
 use Doctrine\DBAL\Driver\AbstractMySQLDriver;
 use Doctrine\DBAL\Driver\PDO\Connection;
 use Doctrine\DBAL\Driver\PDO\Exception;
+use Doctrine\DBAL\Driver\PDO\Exception\InvalidConfiguration;
 use PDO;
 use PDOException;
 use SensitiveParameter;
 
+use function is_string;
+
 final class Driver extends AbstractMySQLDriver
 {
     /**
@@ -26,6 +29,12 @@ public function connect(
             $driverOptions[PDO::ATTR_PERSISTENT] = true;
         }
 
+        foreach (['user', 'password'] as $key) {
+            if (isset($params[$key]) && ! is_string($params[$key])) {
+                throw InvalidConfiguration::notAStringOrNull($key, $params[$key]);
+            }
+        }
+
         $safeParams = $params;
         unset($safeParams['password']);
 

src/Driver/PDO/OCI/Driver.php

@@ -7,10 +7,13 @@
 use Doctrine\DBAL\Driver\AbstractOracleDriver;
 use Doctrine\DBAL\Driver\PDO\Connection;
 use Doctrine\DBAL\Driver\PDO\Exception;
+use Doctrine\DBAL\Driver\PDO\Exception\InvalidConfiguration;
 use PDO;
 use PDOException;
 use SensitiveParameter;
 
+use function is_string;
+
 final class Driver extends AbstractOracleDriver
 {
     /**
@@ -26,6 +29,12 @@ public function connect(
             $driverOptions[PDO::ATTR_PERSISTENT] = true;
         }
 
+        foreach (['user', 'password'] as $key) {
+            if (isset($params[$key]) && ! is_string($params[$key])) {
+                throw InvalidConfiguration::notAStringOrNull($key, $params[$key]);
+            }
+        }
+
         $safeParams = $params;
         unset($safeParams['password']);
 

src/Driver/PDO/PgSQL/Driver.php

@@ -7,10 +7,13 @@
 use Doctrine\DBAL\Driver\AbstractPostgreSQLDriver;
 use Doctrine\DBAL\Driver\PDO\Connection;
 use Doctrine\DBAL\Driver\PDO\Exception;
+use Doctrine\DBAL\Driver\PDO\Exception\InvalidConfiguration;
 use PDO;
 use PDOException;
 use SensitiveParameter;
 
+use function is_string;
+
 final class Driver extends AbstractPostgreSQLDriver
 {
     /**
@@ -26,6 +29,12 @@
             $driverOptions[PDO::ATTR_PERSISTENT] = true;
         }
 
+        foreach (['user', 'password'] as $key) {
+            if (isset($params[$key]) && ! is_string($params[$key])) {
+                throw InvalidConfiguration::notAStringOrNull($key, $params[$key]);
+            }
+        }
+
         $safeParams = $params;
         unset($safeParams['password']);
 

src/Driver/PDO/SQLSrv/Driver.php

@@ -9,10 +9,12 @@
 use Doctrine\DBAL\Driver\Exception;
 use Doctrine\DBAL\Driver\PDO\Connection as PDOConnection;
 use Doctrine\DBAL\Driver\PDO\Exception as PDOException;
+use Doctrine\DBAL\Driver\PDO\Exception\InvalidConfiguration;
 use PDO;
 use SensitiveParameter;
 
 use function is_int;
+use function is_string;
 use function sprintf;
 
 final class Driver extends AbstractSQLServerDriver
@@ -40,6 +42,12 @@ public function connect(
             $driverOptions[PDO::ATTR_PERSISTENT] = true;
         }
 
+        foreach (['user', 'password'] as $key) {
+            if (isset($params[$key]) && ! is_string($params[$key])) {
+                throw InvalidConfiguration::notAStringOrNull($key, $params[$key]);
+            }
+        }
+
         $safeParams = $params;
         unset($safeParams['password']);