Temporary annotations for PHP 8.1 compatibility (php-debugbar#512)

Author: sbennett-ihasco

src/DebugBar/DataCollector/PDO/TraceablePDO.php

@@ -23,12 +23,13 @@ public function __construct(PDO $pdo)
         $this->pdo->setAttribute(PDO::ATTR_STATEMENT_CLASS, [TraceablePDOStatement::class, [$this]]);
     }
 
-	/**
-	 * Initiates a transaction
-         *
-	 * @link   http://php.net/manual/en/pdo.begintransaction.php
-	 * @return bool TRUE on success or FALSE on failure.
-	 */
+    /**
+     * Initiates a transaction
+     *
+     * @link   http://php.net/manual/en/pdo.begintransaction.php
+     * @return bool TRUE on success or FALSE on failure.
+     */
+    #[\ReturnTypeWillChange]
     public function beginTransaction()
     {
         return $this->pdo->beginTransaction();
@@ -40,6 +41,7 @@ public function beginTransaction()
      * @link   http://php.net/manual/en/pdo.commit.php
      * @return bool TRUE on success or FALSE on failure.
      */
+    #[\ReturnTypeWillChange]
     public function commit()
     {
         return $this->pdo->commit();
@@ -51,6 +53,7 @@ public function commit()
      * @link   http://php.net/manual/en/pdo.errorinfo.php
      * @return array PDO::errorInfo returns an array of error information
      */
+    #[\ReturnTypeWillChange]
     public function errorCode()
     {
         return $this->pdo->errorCode();
@@ -62,6 +65,7 @@ public function errorCode()
      * @link   http://php.net/manual/en/pdo.errorinfo.php
      * @return array PDO::errorInfo returns an array of error information
      */
+    #[\ReturnTypeWillChange]
     public function errorInfo()
     {
         return $this->pdo->errorInfo();
@@ -77,6 +81,7 @@ public function errorInfo()
      * return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE.
      * Please read the section on Booleans for more information
      */
+    #[\ReturnTypeWillChange]
     public function exec($statement)
     {
         return $this->profileCall('exec', $statement, func_get_args());
@@ -90,6 +95,7 @@ public function exec($statement)
      * @return mixed A successful call returns the value of the requested PDO attribute.
      * An unsuccessful call returns null.
      */
+    #[\ReturnTypeWillChange]
     public function getAttribute($attribute)
     {
         return $this->pdo->getAttribute($attribute);
@@ -101,6 +107,7 @@ public function getAttribute($attribute)
      * @link   http://php.net/manual/en/pdo.intransaction.php
      * @return bool TRUE if a transaction is currently active, and FALSE if not.
      */
+    #[\ReturnTypeWillChange]
     public function inTransaction()
     {
         return $this->pdo->inTransaction();
@@ -114,37 +121,40 @@ public function inTransaction()
      * @return string If a sequence name was not specified for the name parameter, PDO::lastInsertId
      * returns a string representing the row ID of the last row that was inserted into the database.
      */
+    #[\ReturnTypeWillChange]
     public function lastInsertId($name = null)
     {
         return $this->pdo->lastInsertId($name);
     }
 
-	/**
-	 * Prepares a statement for execution and returns a statement object
-   *
-	 * @link   http://php.net/manual/en/pdo.prepare.php
-	 * @param  string $statement This must be a valid SQL statement template for the target DB server.
-	 * @param  array  $driver_options [optional] This array holds one or more key=>value pairs to
-	 * set attribute values for the PDOStatement object that this method returns.
-	 * @return TraceablePDOStatement|bool If the database server successfully prepares the statement,
-   * PDO::prepare returns a PDOStatement object. If the database server cannot successfully prepare
-   * the statement, PDO::prepare returns FALSE or emits PDOException (depending on error handling).
-	 */
+    /**
+     * Prepares a statement for execution and returns a statement object
+     *
+     * @link   http://php.net/manual/en/pdo.prepare.php
+     * @param  string $statement This must be a valid SQL statement template for the target DB server.
+     * @param  array  $driver_options [optional] This array holds one or more key=>value pairs to
+     * set attribute values for the PDOStatement object that this method returns.
+     * @return TraceablePDOStatement|bool If the database server successfully prepares the statement,
+     * PDO::prepare returns a PDOStatement object. If the database server cannot successfully prepare
+     * the statement, PDO::prepare returns FALSE or emits PDOException (depending on error handling).
+     */
+    #[\ReturnTypeWillChange]
     public function prepare($statement, $driver_options = [])
     {
         return $this->pdo->prepare($statement, $driver_options);
     }
 
-	/**
-	 * Executes an SQL statement, returning a result set as a PDOStatement object
-   *
-	 * @link   http://php.net/manual/en/pdo.query.php
-	 * @param  string $statement
-	 * @param  int $fetchMode
-	 * @param  mixed ...$fetchModeArgs
-	 * @return TraceablePDOStatement|bool PDO::query returns a PDOStatement object, or FALSE on
-   * failure.
-   */
+    /**
+     * Executes an SQL statement, returning a result set as a PDOStatement object
+     *
+     * @link   http://php.net/manual/en/pdo.query.php
+     * @param  string $statement
+     * @param  int $fetchMode
+     * @param  mixed ...$fetchModeArgs
+     * @return TraceablePDOStatement|bool PDO::query returns a PDOStatement object, or FALSE on
+     * failure.
+     */
+    #[\ReturnTypeWillChange]
     public function query($statement, $fetchMode = null, ...$fetchModeArgs)
     {
         return $this->profileCall('query', $statement, func_get_args());
@@ -160,6 +170,7 @@ public function query($statement, $fetchMode = null, ...$fetchModeArgs)
      * @return string|bool A quoted string that is theoretically safe to pass into an SQL statement.
      * Returns FALSE if the driver does not support quoting in this way.
      */
+    #[\ReturnTypeWillChange]
     public function quote($string, $parameter_type = PDO::PARAM_STR)
     {
         return $this->pdo->quote($string, $parameter_type);
@@ -171,6 +182,7 @@ public function quote($string, $parameter_type = PDO::PARAM_STR)
      * @link   http://php.net/manual/en/pdo.rollback.php
      * @return bool TRUE on success or FALSE on failure.
      */
+    #[\ReturnTypeWillChange]
     public function rollBack()
     {
         return $this->pdo->rollBack();
@@ -184,6 +196,7 @@ public function rollBack()
      * @param  mixed $value
      * @return bool TRUE on success or FALSE on failure.
      */
+    #[\ReturnTypeWillChange]
     public function setAttribute($attribute, $value)
     {
         return $this->pdo->setAttribute($attribute, $value);

src/DebugBar/DataCollector/PDO/TraceablePDOStatement.php

@@ -39,6 +39,7 @@ protected function __construct(TraceablePDO $pdo)
      * @param  mixed $driverdata [optional] Optional parameter(s) for the driver.
      * @return bool  TRUE on success or FALSE on failure.
      */
+    #[\ReturnTypeWillChange]
     public function bindColumn($column, &$param, $type = null, $maxlen = null, $driverdata = null)
     {
         $this->boundParameters[$column] = $param;
@@ -61,6 +62,7 @@ public function bindColumn($column, &$param, $type = null, $maxlen = null, $driv
      * @param  mixed $driver_options [optional]
      * @return bool TRUE on success or FALSE on failure.
      */
+    #[\ReturnTypeWillChange]
     public function bindParam($parameter, &$variable, $data_type = PDO::PARAM_STR, $length = null, $driver_options = null)
     {
         $this->boundParameters[$parameter] = $variable;
@@ -80,6 +82,7 @@ public function bindParam($parameter, &$variable, $data_type = PDO::PARAM_STR, $
      * constants.
      * @return bool TRUE on success or FALSE on failure.
      */
+    #[\ReturnTypeWillChange]
     public function bindValue($parameter, $value, $data_type = PDO::PARAM_STR)
     {
         $this->boundParameters[$parameter] = $value;
@@ -96,6 +99,7 @@ public function bindValue($parameter, $value, $data_type = PDO::PARAM_STR)
      * @throws PDOException
      * @return bool TRUE on success or FALSE on failure.
      */
+    #[\ReturnTypeWillChange]
     public function execute($input_parameters = null)
     {
         $preparedId = spl_object_hash($this);