Improve consistency of exception message formatting.

doctrine · May 1, 2019 · 46809de · 46809de
1 parent e46c09b
commit 46809de
Show file tree

Hide file tree

Showing 78 changed files with 487 additions and 221 deletions.
diff --git a/lib/Doctrine/DBAL/Cache/ArrayStatement.php b/lib/Doctrine/DBAL/Cache/ArrayStatement.php
@@ -15,6 +15,7 @@
 use function array_values;
 use function count;
 use function reset;
+use function sprintf;
 
 class ArrayStatement implements IteratorAggregate, ResultStatement
 {
@@ -48,7 +49,7 @@ public function __construct(array $data)
      */
     public function closeCursor() : void
     {
-        unset($this->data);
+        $this->data = null;
     }
 
     /**
@@ -77,7 +78,7 @@ public function rowCount() : int
     public function setFetchMode($fetchMode, ...$args) : void
     {
         if (count($args) > 0) {
-            throw new InvalidArgumentException('Caching layer does not support 2nd/3rd argument to setFetchMode()');
+            throw new InvalidArgumentException('Caching layer does not support 2nd/3rd argument to setFetchMode().');
         }
 
         $this->defaultFetchMode = $fetchMode;
@@ -121,7 +122,9 @@ public function fetch($fetchMode = null, ...$args)
             return reset($row);
         }
 
-        throw new InvalidArgumentException('Invalid fetch-style given for fetching result.');
+        throw new InvalidArgumentException(
+            sprintf('Invalid fetch mode given for fetching result, %d given.', $fetchMode)
+        );
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/DBALException.php b/lib/Doctrine/DBAL/DBALException.php
@@ -28,21 +28,28 @@ class DBALException extends Exception
      */
     public static function driverExceptionDuringQuery(Driver $driver, Throwable $driverEx, $sql, array $params = [])
     {
-        $msg = "An exception occurred while executing '" . $sql . "'";
-        if ($params) {
-            $msg .= ' with params ' . self::formatParameters($params);
-        }
-        $msg .= ":\n\n" . $driverEx->getMessage();
+        $messageFormat = <<<'MESSAGE'
+An exception occurred while executing "%s"%s:
+
+%s
+MESSAGE;
+
+        $message = sprintf(
+            $messageFormat,
+            $sql,
+            $params !== [] ? sprintf(' with params %s', self::formatParameters($params)) : '',
+            $driverEx->getMessage()
+        );
 
-        return static::wrapException($driver, $driverEx, $msg);
+        return static::wrapException($driver, $driverEx, $message);
     }
 
     /**
      * @return self
      */
     public static function driverException(Driver $driver, Throwable $driverEx)
     {
-        return static::wrapException($driver, $driverEx, 'An exception occurred in driver: ' . $driverEx->getMessage());
+        return static::wrapException($driver, $driverEx, sprintf('An exception occurred in driver with message: %s', $driverEx->getMessage()));
     }
 
     /**
@@ -64,11 +71,9 @@ private static function wrapException(Driver $driver, Throwable $driverEx, $msg)
      * Returns a human-readable representation of an array of parameters.
      * This properly handles binary data by returning a hex representation.
      *
-     * @param mixed[] $params
-     *
-     * @return string
+     * @param array<mixed, mixed> $params
      */
-    private static function formatParameters(array $params)
+    private static function formatParameters(array $params) : string
     {
         return '[' . implode(', ', array_map(static function ($param) {
             if (is_resource($param)) {

diff --git a/lib/Doctrine/DBAL/Driver/Mysqli/MysqliStatement.php b/lib/Doctrine/DBAL/Driver/Mysqli/MysqliStatement.php
@@ -109,7 +109,7 @@ public function bindParam($column, &$variable, $type = ParameterType::STRING, $l
         assert(is_int($column));
 
         if (! isset(self::$_paramTypeMap[$type])) {
-            throw new MysqliException(sprintf("Unknown type: '%s'", $type));
+            throw new MysqliException(sprintf('Unknown type, %d given.', $type));
         }
 
         $this->_bindedValues[$column] =& $variable;
@@ -124,7 +124,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING) : void
         assert(is_int($param));
 
         if (! isset(self::$_paramTypeMap[$type])) {
-            throw new MysqliException(sprintf("Unknown type: '%s'", $type));
+            throw new MysqliException(sprintf('Unknown type, %d given.', $type));
         }
 
         $this->_values[$param]       = $value;
@@ -250,7 +250,7 @@ private function sendLongData($streams)
                 $chunk = fread($stream, 8192);
 
                 if ($chunk === false) {
-                    throw new MysqliException("Failed reading the stream resource for parameter offset ${paramNr}.");
+                    throw new MysqliException(sprintf('Failed reading the stream resource for parameter offset %d.', $paramNr));
                 }
 
                 if (! $this->_stmt->send_long_data($paramNr - 1, $chunk)) {
@@ -344,7 +344,7 @@ public function fetch($fetchMode = null, ...$args)
                 return (object) $assoc;
 
             default:
-                throw new MysqliException(sprintf("Unknown fetch type '%s'", $fetchMode));
+                throw new MysqliException(sprintf('Unknown fetch mode %d.', $fetchMode));
         }
     }
 

diff --git a/lib/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php b/lib/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php
@@ -156,7 +156,7 @@ public static function convertPositionalToNamedPlaceholders($statement)
 
         if ($currentLiteralDelimiter) {
             throw new OCI8Exception(sprintf(
-                'The statement contains non-terminated string literal starting at offset %d',
+                'The statement contains non-terminated string literal starting at offset %d.',
                 $tokenOffset - 1
             ));
         }
@@ -407,7 +407,7 @@ public function fetch($fetchMode = null, ...$args)
         }
 
         if (! isset(self::$fetchModeMap[$fetchMode])) {
-            throw new InvalidArgumentException('Invalid fetch style: ' . $fetchMode);
+            throw new InvalidArgumentException(sprintf('Invalid fetch mode %d.', $fetchMode));
         }
 
         return oci_fetch_array(
@@ -434,7 +434,7 @@ public function fetchAll($fetchMode = null, ...$args)
         }
 
         if (! isset(self::$fetchModeMap[$fetchMode])) {
-            throw new InvalidArgumentException('Invalid fetch style: ' . $fetchMode);
+            throw new InvalidArgumentException(sprintf('Invalid fetch mode %d.', $fetchMode));
         }
 
         if (self::$fetchModeMap[$fetchMode] === OCI_BOTH) {

diff --git a/lib/Doctrine/DBAL/Driver/PDOStatement.php b/lib/Doctrine/DBAL/Driver/PDOStatement.php
@@ -206,7 +206,7 @@ private function convertParamType(int $type) : int
         if (! isset(self::PARAM_TYPE_MAP[$type])) {
             // TODO: next major: throw an exception
             @trigger_error(sprintf(
-                'Using a PDO parameter type (%d given) is deprecated and will cause an error in Doctrine 3.0',
+                'Using a PDO parameter type (%d given) is deprecated and will cause an error in Doctrine 3.0.',
                 $type
             ), E_USER_DEPRECATED);
 
@@ -227,7 +227,7 @@ private function convertFetchMode(int $fetchMode) : int
             // TODO: next major: throw an exception
             @trigger_error(sprintf(
                 'Using a PDO fetch mode or their combination (%d given)' .
-                ' is deprecated and will cause an error in Doctrine 3.0',
+                ' is deprecated and will cause an error in Doctrine 3.0.',
                 $fetchMode
             ), E_USER_DEPRECATED);
 

diff --git a/lib/Doctrine/DBAL/Driver/SQLAnywhere/SQLAnywhereStatement.php b/lib/Doctrine/DBAL/Driver/SQLAnywhere/SQLAnywhereStatement.php
@@ -6,6 +6,7 @@
 
 use Doctrine\DBAL\Driver\Statement;
 use Doctrine\DBAL\Driver\StatementIterator;
+use Doctrine\DBAL\Exception\GetVariableType;
 use Doctrine\DBAL\Exception\InvalidColumnIndex;
 use Doctrine\DBAL\FetchMode;
 use Doctrine\DBAL\ParameterType;
@@ -17,7 +18,6 @@
 use function array_key_exists;
 use function count;
 use function func_get_args;
-use function gettype;
 use function is_array;
 use function is_int;
 use function is_object;
@@ -73,7 +73,10 @@ class SQLAnywhereStatement implements IteratorAggregate, Statement
     public function __construct($conn, $sql)
     {
         if (! is_resource($conn)) {
-            throw new SQLAnywhereException('Invalid SQL Anywhere connection resource: ' . $conn);
+            throw new SQLAnywhereException(sprintf(
+                'Invalid SQL Anywhere connection resource, "%s" given.',
+                (new GetVariableType())->__invoke($conn)
+            ));
         }
 
         $this->conn = $conn;
@@ -108,7 +111,7 @@ public function bindParam($column, &$variable, $type = ParameterType::STRING, $l
                 break;
 
             default:
-                throw new SQLAnywhereException('Unknown type: ' . $type);
+                throw new SQLAnywhereException(sprintf('Unknown type %d.', $type));
         }
 
         $this->boundValues[$column] =& $variable;
@@ -215,7 +218,7 @@ public function fetch($fetchMode = null, ...$args)
                 return sasql_fetch_object($this->result);
 
             default:
-                throw new SQLAnywhereException('Fetch mode is not supported: ' . $fetchMode);
+                throw new SQLAnywhereException(sprintf('Fetch mode is not supported %d.', $fetchMode));
         }
     }
 
@@ -314,8 +317,8 @@ private function castObject(stdClass $sourceObject, $destinationClass, array $ct
         if (! is_string($destinationClass)) {
             if (! is_object($destinationClass)) {
                 throw new SQLAnywhereException(sprintf(
-                    'Destination class has to be of type string or object, %s given.',
-                    gettype($destinationClass)
+                    'Destination class has to be of type string or object, "%s" given.',
+                    (new GetVariableType())->__invoke($destinationClass)
                 ));
             }
         } else {

diff --git a/lib/Doctrine/DBAL/Driver/SQLSrv/Driver.php b/lib/Doctrine/DBAL/Driver/SQLSrv/Driver.php
@@ -17,7 +17,7 @@ class Driver extends AbstractSQLServerDriver
     public function connect(array $params, $username = null, $password = null, array $driverOptions = [])
     {
         if (! isset($params['host'])) {
-            throw new SQLSrvException("Missing 'host' in configuration for sqlsrv driver.");
+            throw new SQLSrvException('Missing "host" in configuration for sqlsrv driver.');
         }
 
         $serverName = $params['host'];

diff --git a/lib/Doctrine/DBAL/Driver/SQLSrv/SQLSrvStatement.php b/lib/Doctrine/DBAL/Driver/SQLSrv/SQLSrvStatement.php
@@ -345,7 +345,7 @@ public function fetch($fetchMode = null, ...$args)
             return sqlsrv_fetch_object($this->stmt, $className, $ctorArgs) ?: false;
         }
 
-        throw new SQLSrvException('Fetch mode is not supported!');
+        throw new SQLSrvException('Fetch mode is not supported.');
     }
 
     /**

diff --git a/lib/Doctrine/DBAL/Exception/DriverRequired.php b/lib/Doctrine/DBAL/Exception/DriverRequired.php
@@ -17,15 +17,15 @@ public static function new(?string $url = null) : self
         if ($url !== null) {
             return new self(
                 sprintf(
-                    "The options 'driver' or 'driverClass' are mandatory if a connection URL without scheme "
-                        . 'is given to DriverManager::getConnection(). Given URL: %s',
+                    'The options "driver" or "driverClass" are mandatory if a connection URL without scheme '
+                        . 'is given to DriverManager::getConnection(). Given URL "%s".',
                     $url
                 )
             );
         }
 
         return new self(
-            "The options 'driver' or 'driverClass' are mandatory if no PDO "
+            'The options "driver" or "driverClass" are mandatory if no PDO '
                 . 'instance is given to DriverManager::getConnection().'
         );
     }

diff --git a/lib/Doctrine/DBAL/Exception/EmptyCriteriaNotAllowed.php b/lib/Doctrine/DBAL/Exception/EmptyCriteriaNotAllowed.php
@@ -8,6 +8,6 @@ final class EmptyCriteriaNotAllowed extends InvalidArgumentException
 {
     public static function new() : self
     {
-        return new self('Empty criteria was used, expected non-empty criteria');
+        return new self('Empty criteria was used, expected non-empty criteria.');
     }
 }
diff --git a/lib/Doctrine/DBAL/Exception/GetVariableType.php b/lib/Doctrine/DBAL/Exception/GetVariableType.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Exception;
+
+use function get_class;
+use function get_resource_type;
+use function gettype;
+use function is_bool;
+use function is_object;
+use function is_resource;
+
+final class GetVariableType
+{
+    /**
+     * @param mixed $value
+     */
+    public function __invoke($value) : string
+    {
+        if (is_object($value)) {
+            return get_class($value);
+        }
+
+        if (is_resource($value)) {
+            return get_resource_type($value);
+        }
+
+        if (is_bool($value)) {
+            return $value === true ? 'true' : 'false';
+        }
+
+        return gettype($value);
+    }
+}
diff --git a/lib/Doctrine/DBAL/Exception/InvalidDriverClass.php b/lib/Doctrine/DBAL/Exception/InvalidDriverClass.php
@@ -14,7 +14,7 @@ public static function new(string $driverClass) : self
     {
         return new self(
             sprintf(
-                "The given 'driverClass' %s has to implement the %s interface.",
+                'The given "driverClass" %s has to implement the %s interface.',
                 $driverClass,
                 Driver::class
             )

diff --git a/lib/Doctrine/DBAL/Exception/InvalidPdoInstance.php b/lib/Doctrine/DBAL/Exception/InvalidPdoInstance.php
@@ -10,6 +10,6 @@ final class InvalidPdoInstance extends DBALException
 {
     public static function new() : self
     {
-        return new self("The 'pdo' option was used in DriverManager::getConnection() but no instance of PDO was given.");
+        return new self('The "pdo" option was used in DriverManager::getConnection() but no instance of PDO was given.');
     }
 }
diff --git a/lib/Doctrine/DBAL/Exception/InvalidPlatformType.php b/lib/Doctrine/DBAL/Exception/InvalidPlatformType.php
@@ -7,7 +7,6 @@
 use Doctrine\DBAL\DBALException;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use function get_class;
-use function gettype;
 use function is_object;
 use function sprintf;
 
@@ -21,7 +20,7 @@ public static function new($invalidPlatform) : self
         if (is_object($invalidPlatform)) {
             return new self(
                 sprintf(
-                    "Option 'platform' must be a subtype of '%s', instance of '%s' given",
+                    'Option "platform" must be a subtype of %s, instance of %s given.',
                     AbstractPlatform::class,
                     get_class($invalidPlatform)
                 )
@@ -30,9 +29,9 @@ public static function new($invalidPlatform) : self
 
         return new self(
             sprintf(
-                "Option 'platform' must be an object and subtype of '%s'. Got '%s'",
+                'Option "platform" must be an object and subtype of %s. Got "%s".',
                 AbstractPlatform::class,
-                gettype($invalidPlatform)
+                (new GetVariableType())->__invoke($invalidPlatform)
             )
         );
     }

diff --git a/lib/Doctrine/DBAL/Exception/InvalidWrapperClass.php b/lib/Doctrine/DBAL/Exception/InvalidWrapperClass.php
@@ -14,7 +14,7 @@ public static function new(string $wrapperClass) : self
     {
         return new self(
             sprintf(
-                "The given 'wrapperClass' %s has to be a subtype of %s.",
+                'The given "wrapperClass" %s has to be a subtype of %s.',
                 $wrapperClass,
                 Connection::class
             )

diff --git a/...ctrine/DBAL/Exception/MissingSQLParam.php → .../DBAL/Exception/MissingArrayParameter.php b/...ctrine/DBAL/Exception/MissingSQLParam.php → .../DBAL/Exception/MissingArrayParameter.php
@@ -7,12 +7,10 @@
 use Doctrine\DBAL\SQLParserUtilsException;
 use function sprintf;
 
-final class MissingSQLParam extends SQLParserUtilsException
+final class MissingArrayParameter extends SQLParserUtilsException
 {
     public static function new(string $paramName) : self
     {
-        return new self(
-            sprintf('Value for :%1$s not found in params array. Params array key should be "%1$s"', $paramName)
-        );
+        return new self(sprintf('Parameter "%s" is missing.', $paramName));
     }
 }
diff --git a/lib/Doctrine/DBAL/Exception/MissingArrayParameterType.php b/lib/Doctrine/DBAL/Exception/MissingArrayParameterType.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Exception;
+
+use Doctrine\DBAL\SQLParserUtilsException;
+use function sprintf;
+
+final class MissingArrayParameterType extends SQLParserUtilsException
+{
+    public static function new(string $paramName) : self
+    {
+        return new self(sprintf('Type of array parameter "%s" is missing.', $paramName));
+    }
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -345,7 +345,7 @@ public function fetch($fetchMode = null, ...$args) @@
                 return sqlsrv_fetch_object($this->stmt, $className, $ctorArgs) ?: false;
             }
-            throw new SQLSrvException('Fetch mode is not supported!');
+            throw new SQLSrvException('Fetch mode is not supported.');
         }
         /**
@@ Expand Down @@