[BC] Replaced extension of \PDOStatement with a composition to avoid …

…having to replicate the \PDOStatement interface in ResultStatement
doctrine · Jan 3, 2018 · 965353c · 965353c
1 parent b094888
commit 965353c
Show file tree

Hide file tree

Showing 13 changed files with 91 additions and 48 deletions.
diff --git a/lib/Doctrine/DBAL/Cache/ArrayStatement.php b/lib/Doctrine/DBAL/Cache/ArrayStatement.php
@@ -97,7 +97,7 @@ public function getIterator()
     /**
      * {@inheritdoc}
      */
-    public function fetch($fetchMode = null, $_ = null, $__ = null)
+    public function fetch($fetchMode = null)
     {
         if ( ! isset($this->data[$this->num])) {
             return false;

diff --git a/lib/Doctrine/DBAL/Cache/ResultCacheStatement.php b/lib/Doctrine/DBAL/Cache/ResultCacheStatement.php
@@ -146,7 +146,7 @@ public function getIterator()
     /**
      * {@inheritdoc}
      */
-    public function fetch($fetchMode = null, $_ = null, $__ = null)
+    public function fetch($fetchMode = null)
     {
         if ($this->data === null) {
             $this->data = [];

diff --git a/lib/Doctrine/DBAL/Driver/IBMDB2/DB2Statement.php b/lib/Doctrine/DBAL/Driver/IBMDB2/DB2Statement.php
@@ -206,7 +206,7 @@ public function getIterator()
     /**
      * {@inheritdoc}
      */
-    public function fetch($fetchMode = null, $_ = null, $__ = null)
+    public function fetch($fetchMode = null)
     {
         // do not try fetching from the statement if it's not expected to contain result
         // in order to prevent exceptional situation

diff --git a/lib/Doctrine/DBAL/Driver/Mysqli/MysqliStatement.php b/lib/Doctrine/DBAL/Driver/Mysqli/MysqliStatement.php
@@ -263,7 +263,7 @@ private function _fetch()
     /**
      * {@inheritdoc}
      */
-    public function fetch($fetchMode = null, $_ = null, $__ = null)
+    public function fetch($fetchMode = null)
     {
         // do not try fetching from the statement if it's not expected to contain result
         // in order to prevent exceptional situation

diff --git a/lib/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php b/lib/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php
@@ -376,7 +376,7 @@ public function getIterator()
     /**
      * {@inheritdoc}
      */
-    public function fetch($fetchMode = null, $_ = null, $__ = null)
+    public function fetch($fetchMode = null)
     {
         // do not try fetching from the statement if it's not expected to contain result
         // in order to prevent exceptional situation

diff --git a/lib/Doctrine/DBAL/Driver/PDOConnection.php b/lib/Doctrine/DBAL/Driver/PDOConnection.php
@@ -41,7 +41,6 @@ public function __construct($dsn, $user = null, $password = null, array $options
     {
         try {
             parent::__construct($dsn, $user, $password, $options);
-            $this->setAttribute(PDO::ATTR_STATEMENT_CLASS, ['Doctrine\DBAL\Driver\PDOStatement', []]);
             $this->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
         } catch (\PDOException $exception) {
             throw new PDOException($exception);
@@ -74,7 +73,9 @@ public function getServerVersion()
     public function prepare($prepareString, $driverOptions = [])
     {
         try {
-            return parent::prepare($prepareString, $driverOptions);
+            return $this->createStatement(
+                parent::prepare($prepareString, $driverOptions)
+            );
         } catch (\PDOException $exception) {
             throw new PDOException($exception);
         }
@@ -86,22 +87,11 @@ public function prepare($prepareString, $driverOptions = [])
     public function query()
     {
         $args = func_get_args();
-        $argsCount = count($args);
 
         try {
-            if ($argsCount == 4) {
-                return parent::query($args[0], $args[1], $args[2], $args[3]);
-            }
-
-            if ($argsCount == 3) {
-                return parent::query($args[0], $args[1], $args[2]);
-            }
-
-            if ($argsCount == 2) {
-                return parent::query($args[0], $args[1]);
-            }
-
-            return parent::query($args[0]);
+            return $this->createStatement(
+                parent::query(...$args)
+            );
         } catch (\PDOException $exception) {
             throw new PDOException($exception);
         }
@@ -130,4 +120,15 @@ public function requiresQueryForServerVersion()
     {
         return false;
     }
+
+    /**
+     * Creates a wrapped statement
+     *
+     * @param \PDOStatement $stmt
+     * @return PDOStatement
+     */
+    private function createStatement(\PDOStatement $stmt) : PDOStatement
+    {
+        return new PDOStatement($stmt);
+    }
 }
diff --git a/lib/Doctrine/DBAL/Driver/PDOStatement.php b/lib/Doctrine/DBAL/Driver/PDOStatement.php
@@ -19,6 +19,7 @@
 
 namespace Doctrine\DBAL\Driver;
 
+use IteratorAggregate;
 use PDO;
 
 /**
@@ -27,7 +28,7 @@
  *
  * @since 2.0
  */
-class PDOStatement extends \PDOStatement implements Statement
+class PDOStatement implements IteratorAggregate, Statement
 {
     /**
      * @var array<int,int>
@@ -53,10 +54,13 @@ class PDOStatement extends \PDOStatement implements Statement
     ];
 
     /**
-     * Protected constructor.
+     * @var \PDOStatement
      */
-    protected function __construct()
+    private $stmt;
+
+    public function __construct(\PDOStatement $stmt)
     {
+        $this->stmt = $stmt;
     }
 
     /**
@@ -72,14 +76,14 @@ public function setFetchMode($fetchMode, $arg2 = null, $arg3 = null)
         // declaration.
         try {
             if ($arg2 === null && $arg3 === null) {
-                return parent::setFetchMode($fetchMode);
+                return $this->stmt->setFetchMode($fetchMode);
             }
 
             if ($arg3 === null) {
-                return parent::setFetchMode($fetchMode, $arg2);
+                return $this->stmt->setFetchMode($fetchMode, $arg2);
             }
 
-            return parent::setFetchMode($fetchMode, $arg2, $arg3);
+            return $this->stmt->setFetchMode($fetchMode, $arg2, $arg3);
         } catch (\PDOException $exception) {
             throw new PDOException($exception);
         }
@@ -93,7 +97,7 @@ public function bindValue($param, $value, $type = self::PARAM_STR)
         $type = $this->convertParamType($type);
 
         try {
-            return parent::bindValue($param, $value, $type);
+            return $this->stmt->bindValue($param, $value, $type);
         } catch (\PDOException $exception) {
             throw new PDOException($exception);
         }
@@ -107,7 +111,7 @@ public function bindParam($column, &$variable, $type = self::PARAM_STR, $length
         $type = $this->convertParamType($type);
 
         try {
-            return parent::bindParam($column, $variable, $type, $length, $driverOptions);
+            return $this->stmt->bindParam($column, $variable, $type, $length, $driverOptions);
         } catch (\PDOException $exception) {
             throw new PDOException($exception);
         }
@@ -119,21 +123,45 @@ public function bindParam($column, &$variable, $type = self::PARAM_STR, $length
     public function closeCursor()
     {
         try {
-            return parent::closeCursor();
+            return $this->stmt->closeCursor();
         } catch (\PDOException $exception) {
             // Exceptions not allowed by the interface.
             // In case driver implementations do not adhere to the interface, silence exceptions here.
             return true;
         }
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function columnCount()
+    {
+        return $this->stmt->columnCount();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function errorCode()
+    {
+        return $this->stmt->errorCode();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function errorInfo()
+    {
+        return $this->stmt->errorInfo();
+    }
+
     /**
      * {@inheritdoc}
      */
     public function execute($params = null)
     {
         try {
-            return parent::execute($params);
+            return $this->stmt->execute($params);
         } catch (\PDOException $exception) {
             throw new PDOException($exception);
         }
@@ -142,16 +170,24 @@ public function execute($params = null)
     /**
      * {@inheritdoc}
      */
-    public function fetch($fetchMode = null, $_ = null, $__ = null)
+    public function rowCount()
+    {
+        return $this->stmt->rowCount();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function fetch($fetchMode = null)
     {
         $fetchMode = $this->convertFetchMode($fetchMode);
 
         try {
             if ($fetchMode === null) {
-                return parent::fetch();
+                return $this->stmt->fetch();
             }
 
-            return parent::fetch($fetchMode);
+            return $this->stmt->fetch($fetchMode);
         } catch (\PDOException $exception) {
             throw new PDOException($exception);
         }
@@ -166,18 +202,18 @@ public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = n
 
         try {
             if ($fetchMode === null && null === $fetchArgument && null === $ctorArgs) {
-                return parent::fetchAll();
+                return $this->stmt->fetchAll();
             }
 
             if (null === $fetchArgument && null === $ctorArgs) {
-                return parent::fetchAll($fetchMode);
+                return $this->stmt->fetchAll($fetchMode);
             }
 
             if (null === $ctorArgs) {
-                return parent::fetchAll($fetchMode, $fetchArgument);
+                return $this->stmt->fetchAll($fetchMode, $fetchArgument);
             }
 
-            return parent::fetchAll($fetchMode, $fetchArgument, $ctorArgs);
+            return $this->stmt->fetchAll($fetchMode, $fetchArgument, $ctorArgs);
         } catch (\PDOException $exception) {
             throw new PDOException($exception);
         }
@@ -189,7 +225,7 @@ public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = n
     public function fetchColumn($columnIndex = 0)
     {
         try {
-            return parent::fetchColumn($columnIndex);
+            return $this->stmt->fetchColumn($columnIndex);
         } catch (\PDOException $exception) {
             throw new PDOException($exception);
         }
@@ -228,4 +264,12 @@ private function convertFetchMode(?int $fetchMode) : ?int
 
         return self::$fetchModeMap[$fetchMode];
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getIterator()
+    {
+        yield from $this->stmt;
+    }
 }
diff --git a/lib/Doctrine/DBAL/Driver/ResultStatement.php b/lib/Doctrine/DBAL/Driver/ResultStatement.php
@@ -114,15 +114,13 @@ public function setFetchMode($fetchMode, $arg2 = null, $arg3 = null);
      * @param int|null $fetchMode    Controls how the next row will be returned to the caller.
      *                               The value must be one of the self::FETCH_* constants,
      *                               defaulting to self::FETCH_BOTH.
-     * @param int|null $_            Unused argument for compatibility with PDOStatement
-     * @param int|null $__           Unused argument for compatibility with PDOStatement
      *
      * @return mixed The return value of this method on success depends on the fetch mode. In all cases, FALSE is
      *               returned on failure.
      *
      * @see self::FETCH_* constants.
      */
-    public function fetch($fetchMode = null, $_ = null, $__ = null);
+    public function fetch($fetchMode = null);
 
     /**
      * Returns an array containing all of the result set rows.

diff --git a/lib/Doctrine/DBAL/Driver/SQLAnywhere/SQLAnywhereStatement.php b/lib/Doctrine/DBAL/Driver/SQLAnywhere/SQLAnywhereStatement.php
@@ -196,7 +196,7 @@ public function execute($params = null)
      *
      * @throws SQLAnywhereException
      */
-    public function fetch($fetchMode = null, $_ = null, $__ = null)
+    public function fetch($fetchMode = null)
     {
         if ( ! is_resource($this->result)) {
             return false;

diff --git a/lib/Doctrine/DBAL/Driver/SQLSrv/SQLSrvStatement.php b/lib/Doctrine/DBAL/Driver/SQLSrv/SQLSrvStatement.php
@@ -303,7 +303,7 @@ public function getIterator()
      *
      * @throws SQLSrvException
      */
-    public function fetch($fetchMode = null, $_ = null, $__ = null)
+    public function fetch($fetchMode = null)
     {
         // do not try fetching from the statement if it's not expected to contain result
         // in order to prevent exceptional situation

diff --git a/lib/Doctrine/DBAL/Portability/Statement.php b/lib/Doctrine/DBAL/Portability/Statement.php
@@ -140,7 +140,7 @@ public function getIterator()
     /**
      * {@inheritdoc}
      */
-    public function fetch($fetchMode = null, $_ = null, $__ = null)
+    public function fetch($fetchMode = null)
     {
         $fetchMode = $fetchMode ?: $this->defaultFetchMode;
 

diff --git a/lib/Doctrine/DBAL/Statement.php b/lib/Doctrine/DBAL/Statement.php
@@ -254,7 +254,7 @@ public function getIterator()
     /**
      * {@inheritdoc}
      */
-    public function fetch($fetchMode = null, $_ = null, $__ = null)
+    public function fetch($fetchMode = null)
     {
         return $this->stmt->fetch($fetchMode);
     }

diff --git a/tests/Doctrine/Tests/Mocks/HydratorMockStatement.php b/tests/Doctrine/Tests/Mocks/HydratorMockStatement.php
@@ -45,7 +45,7 @@ public function fetchColumn($columnNumber = 0)
      *
      * {@inheritdoc}
      */
-    public function fetch($fetchMode = null, $_ = null, $__ = null)
+    public function fetch($fetchMode = null)
     {
         $current = current($this->_resultSet);
         next($this->_resultSet);
@@ -93,7 +93,7 @@ public function errorInfo()
     {
     }
 
-    public function execute($params = array())
+    public function execute($params = null)
     {
     }