Merge branch '3.4.x' into 4.0.x

doctrine · Aug 4, 2022 · 7483ccf · 7483ccf
2 parents 60f014a + eb78575
commit 7483ccf
Show file tree

Hide file tree

Showing 12 changed files with 119 additions and 0 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -826,6 +826,15 @@ The following methods have been removed.
 
 # Upgrade to 3.4
 
+## Deprecated wrapper- and driver-level `Statement::bindParam()` methods.
+
+The following methods have been deprecated:
+
+1. `Doctrine\DBAL\Statement::bindParam()`,
+2. `Doctrine\DBAL\Driver\Statement::bindParam()`.
+
+Use the corresponding `bindValue()` instead.
+
 ## Deprecated not passing parameter type to the driver-level `Statement::bind*()` methods.
 
 Not passing `$type` to the driver-level `Statement::bindParam()` and `::bindValue()` is deprecated.

diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -39,6 +39,16 @@
                     See https://github.com/doctrine/dbal/pull/4317
                 -->
                 <file name="tests/Functional/LegacyAPITest.php"/>
+                <!--
+                    TODO: remove in 4.0.0
+                -->
+                <referencedMethod name="Doctrine\DBAL\Driver\Statement::bindParam"/>
+                <referencedMethod name="Doctrine\DBAL\Driver\IBMDB2\Statement::bindParam"/>
+                <referencedMethod name="Doctrine\DBAL\Driver\Middleware\AbstractStatementMiddleware::bindParam"/>
+                <referencedMethod name="Doctrine\DBAL\Driver\OCI8\Statement::bindParam"/>
+                <referencedMethod name="Doctrine\DBAL\Driver\PDO\Statement::bindParam"/>
+                <referencedMethod name="Doctrine\DBAL\Driver\PDO\SQLSrv\Statement::bindParam"/>
+                <referencedMethod name="Doctrine\DBAL\Statement::bindParam"/>
             </errorLevel>
         </DeprecatedMethod>
         <DocblockTypeContradiction>

diff --git a/src/Driver/IBMDB2/Statement.php b/src/Driver/IBMDB2/Statement.php
@@ -10,6 +10,7 @@
 use Doctrine\DBAL\Driver\IBMDB2\Exception\StatementError;
 use Doctrine\DBAL\Driver\Statement as StatementInterface;
 use Doctrine\DBAL\ParameterType;
+use Doctrine\Deprecations\Deprecation;
 
 use function assert;
 use function db2_bind_param;
@@ -57,8 +58,18 @@ public function bindValue(int|string $param, mixed $value, ParameterType $type):
         $this->bindParam($param, $value, $type);
     }
 
+    /**
+     * @deprecated Use {@see bindValue()} instead.
+     */
     public function bindParam(int|string $param, mixed &$variable, ParameterType $type, ?int $length = null): void
     {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5563',
+            '%s is deprecated. Use bindValue() instead.',
+            __METHOD__
+        );
+
         assert(is_int($param));
 
         switch ($type) {

diff --git a/src/Driver/Middleware/AbstractStatementMiddleware.php b/src/Driver/Middleware/AbstractStatementMiddleware.php
@@ -7,6 +7,7 @@
 use Doctrine\DBAL\Driver\Result;
 use Doctrine\DBAL\Driver\Statement;
 use Doctrine\DBAL\ParameterType;
+use Doctrine\Deprecations\Deprecation;
 
 abstract class AbstractStatementMiddleware implements Statement
 {
@@ -19,12 +20,22 @@ public function bindValue(int|string $param, mixed $value, ParameterType $type):
         $this->wrappedStatement->bindValue($param, $value, $type);
     }
 
+    /**
+     * @deprecated Use {@see bindValue()} instead.
+     */
     public function bindParam(
         int|string $param,
         mixed &$variable,
         ParameterType $type,
         ?int $length = null
     ): void {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5563',
+            '%s is deprecated. Use bindValue() instead.',
+            __METHOD__
+        );
+
         $this->wrappedStatement->bindParam($param, $variable, $type, $length);
     }
 

diff --git a/src/Driver/Mysqli/Statement.php b/src/Driver/Mysqli/Statement.php
@@ -10,6 +10,7 @@
 use Doctrine\DBAL\Driver\Mysqli\Exception\StatementError;
 use Doctrine\DBAL\Driver\Statement as StatementInterface;
 use Doctrine\DBAL\ParameterType;
+use Doctrine\Deprecations\Deprecation;
 use mysqli_sql_exception;
 use mysqli_stmt;
 
@@ -51,12 +52,22 @@ public function __construct(private readonly mysqli_stmt $stmt)
         $this->boundValues = array_fill(1, $paramCount, null);
     }
 
+    /**
+     * @deprecated Use {@see bindValue()} instead.
+     */
     public function bindParam(
         int|string $param,
         mixed &$variable,
         ParameterType $type,
         ?int $length = null
     ): void {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5563',
+            '%s is deprecated. Use bindValue() instead.',
+            __METHOD__
+        );
+
         assert(is_int($param));
 
         $this->types[$param - 1]   = $this->convertParameterType($type);

diff --git a/src/Driver/OCI8/Statement.php b/src/Driver/OCI8/Statement.php
@@ -8,6 +8,7 @@
 use Doctrine\DBAL\Driver\OCI8\Exception\UnknownParameterIndex;
 use Doctrine\DBAL\Driver\Statement as StatementInterface;
 use Doctrine\DBAL\ParameterType;
+use Doctrine\Deprecations\Deprecation;
 
 use function is_int;
 use function oci_bind_by_name;
@@ -44,12 +45,22 @@ public function bindValue(int|string $param, mixed $value, ParameterType $type):
         $this->bindParam($param, $value, $type);
     }
 
+    /**
+     * @deprecated Use {@see bindValue()} instead.
+     */
     public function bindParam(
         int|string $param,
         mixed &$variable,
         ParameterType $type,
         ?int $length = null
     ): void {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5563',
+            '%s is deprecated. Use bindValue() instead.',
+            __METHOD__
+        );
+
         if (is_int($param)) {
             if (! isset($this->parameterMap[$param])) {
                 throw UnknownParameterIndex::new($param);

diff --git a/src/Driver/PDO/SQLSrv/Statement.php b/src/Driver/PDO/SQLSrv/Statement.php
@@ -7,6 +7,7 @@
 use Doctrine\DBAL\Driver\Middleware\AbstractStatementMiddleware;
 use Doctrine\DBAL\Driver\PDO\Statement as PDOStatement;
 use Doctrine\DBAL\ParameterType;
+use Doctrine\Deprecations\Deprecation;
 use PDO;
 
 final class Statement extends AbstractStatementMiddleware
@@ -23,12 +24,22 @@ public function __construct(PDOStatement $statement)
         $this->statement = $statement;
     }
 
+    /**
+     * @deprecated Use {@see bindValue()} instead.
+     */
     public function bindParam(
         int|string $param,
         mixed &$variable,
         ParameterType $type,
         ?int $length = null
     ): void {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5563',
+            '%s is deprecated. Use bindValue() instead.',
+            __METHOD__
+        );
+
         switch ($type) {
             case ParameterType::LARGE_OBJECT:
             case ParameterType::BINARY:

diff --git a/src/Driver/PDO/Statement.php b/src/Driver/PDO/Statement.php
@@ -7,6 +7,7 @@
 use Doctrine\DBAL\Driver\Exception as ExceptionInterface;
 use Doctrine\DBAL\Driver\Statement as StatementInterface;
 use Doctrine\DBAL\ParameterType;
+use Doctrine\Deprecations\Deprecation;
 use PDO;
 use PDOException;
 use PDOStatement;
@@ -31,12 +32,22 @@ public function bindValue(int|string $param, mixed $value, ParameterType $type):
         }
     }
 
+    /**
+     * @deprecated Use {@see bindValue()} instead.
+     */
     public function bindParam(
         string|int $param,
         mixed &$variable,
         ParameterType $type,
         ?int $length = null
     ): void {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5563',
+            '%s is deprecated. Use bindValue() instead.',
+            __METHOD__
+        );
+
         try {
             if ($length === null) {
                 $this->stmt->bindParam($param, $variable, $this->convertParamType($type));

diff --git a/src/Driver/SQLSrv/Statement.php b/src/Driver/SQLSrv/Statement.php
@@ -8,6 +8,7 @@
 use Doctrine\DBAL\Driver\SQLSrv\Exception\Error;
 use Doctrine\DBAL\Driver\Statement as StatementInterface;
 use Doctrine\DBAL\ParameterType;
+use Doctrine\Deprecations\Deprecation;
 
 use function assert;
 use function is_int;
@@ -74,12 +75,22 @@ public function bindValue(int|string $param, mixed $value, ParameterType $type):
         $this->types[$param]     = $type;
     }
 
+    /**
+     * @deprecated Use {@see bindValue()} instead.
+     */
     public function bindParam(
         int|string $param,
         mixed &$variable,
         ParameterType $type,
         ?int $length = null
     ): void {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5563',
+            '%s is deprecated. Use bindValue() instead.',
+            __METHOD__
+        );
+
         assert(is_int($param));
 
         $this->variables[$param] =& $variable;

diff --git a/src/Driver/Statement.php b/src/Driver/Statement.php
@@ -44,6 +44,8 @@ public function bindValue(int|string $param, mixed $value, ParameterType $type):
      * of stored procedures that return data as output parameters, and some also as input/output
      * parameters that both send in data and are updated to receive it.
      *
+     * @deprecated Use {@see bindValue()} instead.
+     *
      * @param int|string    $param    Parameter identifier. For a prepared statement using named placeholders,
      *                                this will be a parameter name of the form :name. For a prepared statement using
      *                                question mark placeholders, this will be the 1-indexed position of the parameter.

diff --git a/src/Logging/Statement.php b/src/Logging/Statement.php
@@ -8,6 +8,7 @@
 use Doctrine\DBAL\Driver\Result as ResultInterface;
 use Doctrine\DBAL\Driver\Statement as StatementInterface;
 use Doctrine\DBAL\ParameterType;
+use Doctrine\Deprecations\Deprecation;
 use Psr\Log\LoggerInterface;
 
 final class Statement extends AbstractStatementMiddleware
@@ -29,12 +30,22 @@ public function __construct(
         parent::__construct($statement);
     }
 
+    /**
+     * @deprecated Use {@see bindValue()} instead.
+     */
     public function bindParam(
         int|string $param,
         mixed &$variable,
         ParameterType $type,
         ?int $length = null
     ): void {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5563',
+            '%s is deprecated. Use bindValue() instead.',
+            __METHOD__
+        );
+
         $this->params[$param] = &$variable;
         $this->types[$param]  = $type;
 

diff --git a/src/Statement.php b/src/Statement.php
@@ -6,6 +6,7 @@
 
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Types\Type;
+use Doctrine\Deprecations\Deprecation;
 
 use function func_num_args;
 use function is_string;
@@ -102,6 +103,8 @@ public function bindValue(
      *
      * Binding a parameter by reference does not support DBAL mapping types.
      *
+     * @deprecated Use {@see bindValue()} instead.
+     *
      * @param string|int    $param    Parameter identifier. For a prepared statement using named placeholders,
      *                                this will be a parameter name of the form :name. For a prepared statement
      *                                using question mark placeholders, this will be the 1-indexed position
@@ -119,6 +122,13 @@ public function bindParam(
         ParameterType $type = ParameterType::STRING,
         ?int $length = null
     ): void {
+        Deprecation::trigger(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5563',
+            '%s is deprecated. Use bindValue() instead.',
+            __METHOD__
+        );
+
         $this->params[$param] = $variable;
         $this->types[$param]  = $type;