Merge pull request #6003 from phansys/sc_1

[SCA] Minor improvement on Psalm typing
doctrine · Apr 13, 2023 · 3db3f61 · 3db3f61
2 parents 5d616c9 + 4c7526a
commit 3db3f61
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 8 deletions.
diff --git a/src/ArrayParameterType.php b/src/ArrayParameterType.php
@@ -22,7 +22,7 @@ final class ArrayParameterType
     /**
      * @internal
      *
-     * @psalm-param self::INTEGER|self::STRING|self::ASCII $type
+     * @psalm-param self::* $type
      *
      * @psalm-return ParameterType::INTEGER|ParameterType::STRING|ParameterType::ASCII
      */

diff --git a/src/Driver/PDO/Connection.php b/src/Driver/PDO/Connection.php
@@ -2,6 +2,7 @@
 
 namespace Doctrine\DBAL\Driver\PDO;
 
+use Doctrine\DBAL\Driver\Exception\UnknownParameterType;
 use Doctrine\DBAL\Driver\PDO\PDOException as DriverPDOException;
 use Doctrine\DBAL\Driver\Result as ResultInterface;
 use Doctrine\DBAL\Driver\ServerInfoAwareConnection;
@@ -78,6 +79,10 @@ public function query(string $sql): ResultInterface
 
     /**
      * {@inheritdoc}
+     *
+     * @throws UnknownParameterType
+     *
+     * @psalm-assert ParameterType::* $type
      */
     public function quote($value, $type = ParameterType::STRING)
     {

diff --git a/src/Driver/PDO/ParameterTypeMap.php b/src/Driver/PDO/ParameterTypeMap.php
@@ -27,6 +27,8 @@ final class ParameterTypeMap
      * @psalm-return PDO::PARAM_*
      *
      * @throws UnknownParameterType
+     *
+     * @psalm-assert ParameterType::* $type
      */
     public static function convertParamType(int $type): int
     {

diff --git a/src/Driver/PDO/SQLSrv/Statement.php b/src/Driver/PDO/SQLSrv/Statement.php
@@ -2,6 +2,7 @@
 
 namespace Doctrine\DBAL\Driver\PDO\SQLSrv;
 
+use Doctrine\DBAL\Driver\Exception\UnknownParameterType;
 use Doctrine\DBAL\Driver\Middleware\AbstractStatementMiddleware;
 use Doctrine\DBAL\Driver\PDO\Statement as PDOStatement;
 use Doctrine\DBAL\ParameterType;
@@ -32,6 +33,10 @@ public function __construct(PDOStatement $statement)
      * @param int        $type
      * @param int|null   $length
      * @param mixed      $driverOptions The usage of the argument is deprecated.
+     *
+     * @throws UnknownParameterType
+     *
+     * @psalm-assert ParameterType::* $type
      */
     public function bindParam(
         $param,
@@ -82,7 +87,11 @@ public function bindParam(
     }
 
     /**
+     * @throws UnknownParameterType
+     *
      * {@inheritdoc}
+     *
+     * @psalm-assert ParameterType::* $type
      */
     public function bindValue($param, $value, $type = ParameterType::STRING): bool
     {

diff --git a/src/Driver/PDO/Statement.php b/src/Driver/PDO/Statement.php
@@ -2,6 +2,7 @@
 
 namespace Doctrine\DBAL\Driver\PDO;
 
+use Doctrine\DBAL\Driver\Exception\UnknownParameterType;
 use Doctrine\DBAL\Driver\Result as ResultInterface;
 use Doctrine\DBAL\Driver\Statement as StatementInterface;
 use Doctrine\DBAL\ParameterType;
@@ -25,6 +26,10 @@ public function __construct(PDOStatement $stmt)
 
     /**
      * {@inheritdoc}
+     *
+     * @throws UnknownParameterType
+     *
+     * @psalm-assert ParameterType::* $type
      */
     public function bindValue($param, $value, $type = ParameterType::STRING)
     {
@@ -56,6 +61,10 @@ public function bindValue($param, $value, $type = ParameterType::STRING)
      * @param int      $type
      * @param int|null $length
      * @param mixed    $driverOptions The usage of the argument is deprecated.
+     *
+     * @throws UnknownParameterType
+     *
+     * @psalm-assert ParameterType::* $type
      */
     public function bindParam(
         $param,

diff --git a/src/Driver/SQLite3/Statement.php b/src/Driver/SQLite3/Statement.php
@@ -40,7 +40,13 @@ public function __construct(SQLite3 $connection, SQLite3Stmt $statement)
         $this->statement  = $statement;
     }
 
-    /** @inheritdoc */
+    /**
+     * @throws UnknownParameterType
+     *
+     * {@inheritdoc}
+     *
+     * @psalm-assert ParameterType::* $type
+     */
     public function bindValue($param, $value, $type = ParameterType::STRING): bool
     {
         if (func_num_args() < 3) {
@@ -55,7 +61,13 @@ public function bindValue($param, $value, $type = ParameterType::STRING): bool
         return $this->statement->bindValue($param, $value, $this->convertParamType($type));
     }
 
-    /** @inheritdoc */
+    /**
+     * @throws UnknownParameterType
+     *
+     * {@inheritdoc}
+     *
+     * @psalm-assert ParameterType::* $type
+     */
     public function bindParam($param, &$variable, $type = ParameterType::STRING, $length = null): bool
     {
         Deprecation::trigger(
@@ -108,6 +120,11 @@ public function execute($params = null): Result
         return new Result($result, $this->connection->changes());
     }
 
+    /**
+     * @psalm-return value-of<self::PARAM_TYPE_MAP>
+     *
+     * @psalm-assert ParameterType::* $type
+     */
     private function convertParamType(int $type): int
     {
         if (! isset(self::PARAM_TYPE_MAP[$type])) {

diff --git a/src/DriverManager.php b/src/DriverManager.php
@@ -96,7 +96,8 @@ final class DriverManager
      *
      * @deprecated Use actual driver names instead.
      *
-     * @var string[]
+     * @var array<string, string>
+     * @psalm-var array<string, key-of<self::DRIVER_MAP>>
      */
     private static array $driverSchemeAliases = [
         'db2'        => 'ibm_db2',
@@ -207,10 +208,10 @@ public static function getAvailableDrivers(): array
     }
 
     /**
-     * @param class-string<Driver>|null     $driverClass
-     * @param key-of<self::DRIVER_MAP>|null $driver
-     *
      * @throws Exception
+     *
+     * @psalm-assert key-of<self::DRIVER_MAP>|null $driver
+     * @psalm-assert class-string<Driver>|null     $driverClass
      */
     private static function createDriver(?string $driver, ?string $driverClass): Driver
     {

diff --git a/src/Query/QueryBuilder.php b/src/Query/QueryBuilder.php
@@ -105,11 +105,15 @@ class QueryBuilder
 
     /**
      * The type of query this is. Can be select, update or delete.
+     *
+     * @psalm-var self::SELECT|self::DELETE|self::UPDATE|self::INSERT
      */
     private int $type = self::SELECT;
 
     /**
      * The state of the query object. Can be dirty or clean.
+     *
+     * @psalm-var self::STATE_*
      */
     private int $state = self::STATE_CLEAN;
 
@@ -208,6 +212,7 @@ public function getConnection()
      * @deprecated The builder state is an internal concern.
      *
      * @return int Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.
+     * @psalm-return self::STATE_*
      */
     public function getState()
     {
@@ -413,7 +418,6 @@ public function getSQL()
                 break;
 
             case self::SELECT:
-            default:
                 $sql = $this->getSQLForSelect();
                 break;
         }