Describe return type accurately

This return type is conditional to $params['wrapperClass']. Luckily, recent versions of Psalm allow documenting it properly. See vimeo/psalm#3277 Note that phpstan is not able to understand this yet, but still attempts to, hence the extra ignore rules.
doctrine · May 1, 2020 · ef3ca0d · ef3ca0d
1 parent 9f78f86
commit ef3ca0d
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 11 deletions.
diff --git a/composer.json b/composer.json
@@ -45,7 +45,7 @@
         "phpunit/phpunit": "^8.5@dev",
         "psalm/plugin-phpunit": "^0.10.0",
         "symfony/console": "^2.0.5|^3.0|^4.0|^5.0",
-        "vimeo/psalm": "^3.11"
+        "vimeo/psalm": "^3.11@dev"
     },
     "suggest": {
         "symfony/console": "For helpful console commands such as SQL execution and import of files."

diff --git a/composer.lock b/composer.lock
diff --git a/lib/Doctrine/DBAL/DriverManager.php b/lib/Doctrine/DBAL/DriverManager.php
@@ -115,11 +115,16 @@ private function __construct()
      * <b>driverClass</b>:
      * The driver class to use.
      *
-     * @param mixed[]            $params       The parameters.
-     * @param Configuration|null $config       The configuration to use.
-     * @param EventManager|null  $eventManager The event manager to use.
+     * @param array{wrapperClass?: class-string<T>} $params
+     * @param Configuration|null                    $config       The configuration to use.
+     * @param EventManager|null                     $eventManager The event manager to use.
      *
      * @throws DBALException
+     *
+     * @phpstan-param mixed[] $params
+     * @phpstan-return Connection
+     * @psalm-return ($params is array{wrapperClass:mixed} ? T : Connection)
+     * @template T of Connection
      */
     public static function getConnection(
         array $params,

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -77,3 +77,10 @@ parameters:
         -
             message: '~^Access to undefined constant PDO::PGSQL_ATTR_DISABLE_PREPARES\.$~'
             path: %currentWorkingDirectory%/lib/Doctrine/DBAL/Driver/PDOPgSql/Driver.php
+
+        # Caused by phpdoc annotations intended for Psalm
+        -
+            message: '~Unable to resolve the template type T in call to method static method Doctrine\\DBAL\\DriverManager::getConnection\(\)~'
+            paths:
+                - %currentWorkingDirectory%/lib/Doctrine/DBAL/Id/TableGenerator.php
+                - %currentWorkingDirectory%/lib/Doctrine/DBAL/Schema/SqliteSchemaManager.php