Skip to content

Commit 5ba53f9

Browse files
jwagejwage
committed
Improve consistency of exception message formatting.
1 parent e46c09b commit 5ba53f9

File tree

77 files changed

+376
-232
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+376
-232
lines changed

‎lib/Doctrine/DBAL/Cache/ArrayStatement.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public function rowCount() : int
7777
public function setFetchMode($fetchMode, ...$args) : void
7878
{
7979
if (count($args) > 0) {
80-
throw new InvalidArgumentException('Caching layer does not support 2nd/3rd argument to setFetchMode()');
80+
throw new InvalidArgumentException('Caching layer does not support 2nd/3rd argument to setFetchMode().');
8181
}
8282

8383
$this->defaultFetchMode = $fetchMode;

‎lib/Doctrine/DBAL/DBALException.php

Lines changed: 15 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,9 @@
77
use Doctrine\DBAL\Driver\DriverException as DriverExceptionInterface;
88
use Doctrine\DBAL\Driver\ExceptionConverterDriver;
99
use Doctrine\DBAL\Exception\DriverException;
10+
use Doctrine\DBAL\Exception\FormatArray;
1011
use Exception;
1112
use Throwable;
12-
use function array_map;
13-
use function bin2hex;
14-
use function implode;
15-
use function is_resource;
16-
use function is_string;
17-
use function json_encode;
18-
use function preg_replace;
1913
use function sprintf;
2014

2115
class DBALException extends Exception
@@ -28,21 +22,28 @@ class DBALException extends Exception
2822
*/
2923
public static function driverExceptionDuringQuery(Driver $driver, Throwable $driverEx, $sql, array $params = [])
3024
{
31-
$msg = "An exception occurred while executing '" . $sql . "'";
32-
if ($params) {
33-
$msg .= ' with params ' . self::formatParameters($params);
34-
}
35-
$msg .= ":\n\n" . $driverEx->getMessage();
25+
$messageFormat = <<<'MESSAGE'
26+
An exception occurred while executing "%s"%s:
27+
28+
%s
29+
MESSAGE;
3630

37-
return static::wrapException($driver, $driverEx, $msg);
31+
$message = sprintf(
32+
$messageFormat,
33+
$sql,
34+
$params !== [] ? sprintf(' with params %s', (new FormatArray())->__invoke($params)) : '',
35+
$driverEx->getMessage()
36+
);
37+
38+
return static::wrapException($driver, $driverEx, $message);
3839
}
3940

4041
/**
4142
* @return self
4243
*/
4344
public static function driverException(Driver $driver, Throwable $driverEx)
4445
{
45-
return static::wrapException($driver, $driverEx, 'An exception occurred in driver: ' . $driverEx->getMessage());
46+
return static::wrapException($driver, $driverEx, sprintf('An exception occurred in driver with message: %s', $driverEx->getMessage()));
4647
}
4748

4849
/**
@@ -59,30 +60,4 @@ private static function wrapException(Driver $driver, Throwable $driverEx, $msg)
5960

6061
return new self($msg, 0, $driverEx);
6162
}
62-
63-
/**
64-
* Returns a human-readable representation of an array of parameters.
65-
* This properly handles binary data by returning a hex representation.
66-
*
67-
* @param mixed[] $params
68-
*
69-
* @return string
70-
*/
71-
private static function formatParameters(array $params)
72-
{
73-
return '[' . implode(', ', array_map(static function ($param) {
74-
if (is_resource($param)) {
75-
return (string) $param;
76-
}
77-
78-
$json = @json_encode($param);
79-
80-
if (! is_string($json) || $json === 'null' && is_string($param)) {
81-
// JSON encoding failed, this is not a UTF-8 string.
82-
return sprintf('"%s"', preg_replace('/.{2}/', '\\x$0', bin2hex($param)));
83-
}
84-
85-
return $json;
86-
}, $params)) . ']';
87-
}
8863
}

‎lib/Doctrine/DBAL/Driver/Mysqli/MysqliStatement.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public function bindParam($column, &$variable, $type = ParameterType::STRING, $l
109109
assert(is_int($column));
110110

111111
if (! isset(self::$_paramTypeMap[$type])) {
112-
throw new MysqliException(sprintf("Unknown type: '%s'", $type));
112+
throw new MysqliException(sprintf('Unknown type, "%s" given.', $type));
113113
}
114114

115115
$this->_bindedValues[$column] =& $variable;
@@ -124,7 +124,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING) : void
124124
assert(is_int($param));
125125

126126
if (! isset(self::$_paramTypeMap[$type])) {
127-
throw new MysqliException(sprintf("Unknown type: '%s'", $type));
127+
throw new MysqliException(sprintf('Unknown type, "%s" given.', $type));
128128
}
129129

130130
$this->_values[$param] = $value;
@@ -250,7 +250,7 @@ private function sendLongData($streams)
250250
$chunk = fread($stream, 8192);
251251

252252
if ($chunk === false) {
253-
throw new MysqliException("Failed reading the stream resource for parameter offset ${paramNr}.");
253+
throw new MysqliException(sprintf('Failed reading the stream resource for parameter offset %d.', $paramNr));
254254
}
255255

256256
if (! $this->_stmt->send_long_data($paramNr - 1, $chunk)) {
@@ -344,7 +344,7 @@ public function fetch($fetchMode = null, ...$args)
344344
return (object) $assoc;
345345

346346
default:
347-
throw new MysqliException(sprintf("Unknown fetch type '%s'", $fetchMode));
347+
throw new MysqliException(sprintf('Unknown fetch mode %d.', $fetchMode));
348348
}
349349
}
350350

‎lib/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ public static function convertPositionalToNamedPlaceholders($statement)
156156

157157
if ($currentLiteralDelimiter) {
158158
throw new OCI8Exception(sprintf(
159-
'The statement contains non-terminated string literal starting at offset %d',
159+
'The statement contains non-terminated string literal starting at offset %d.',
160160
$tokenOffset - 1
161161
));
162162
}
@@ -407,7 +407,7 @@ public function fetch($fetchMode = null, ...$args)
407407
}
408408

409409
if (! isset(self::$fetchModeMap[$fetchMode])) {
410-
throw new InvalidArgumentException('Invalid fetch style: ' . $fetchMode);
410+
throw new InvalidArgumentException(sprintf('Invalid fetch mode %d.', $fetchMode));
411411
}
412412

413413
return oci_fetch_array(
@@ -434,7 +434,7 @@ public function fetchAll($fetchMode = null, ...$args)
434434
}
435435

436436
if (! isset(self::$fetchModeMap[$fetchMode])) {
437-
throw new InvalidArgumentException('Invalid fetch style: ' . $fetchMode);
437+
throw new InvalidArgumentException(sprintf('Invalid fetch mode %d.', $fetchMode));
438438
}
439439

440440
if (self::$fetchModeMap[$fetchMode] === OCI_BOTH) {

‎lib/Doctrine/DBAL/Driver/PDOStatement.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ private function convertParamType(int $type) : int
206206
if (! isset(self::PARAM_TYPE_MAP[$type])) {
207207
// TODO: next major: throw an exception
208208
@trigger_error(sprintf(
209-
'Using a PDO parameter type (%d given) is deprecated and will cause an error in Doctrine 3.0',
209+
'Using a PDO parameter type (%d given) is deprecated and will cause an error in Doctrine 3.0.',
210210
$type
211211
), E_USER_DEPRECATED);
212212

@@ -227,7 +227,7 @@ private function convertFetchMode(int $fetchMode) : int
227227
// TODO: next major: throw an exception
228228
@trigger_error(sprintf(
229229
'Using a PDO fetch mode or their combination (%d given)' .
230-
' is deprecated and will cause an error in Doctrine 3.0',
230+
' is deprecated and will cause an error in Doctrine 3.0.',
231231
$fetchMode
232232
), E_USER_DEPRECATED);
233233

‎lib/Doctrine/DBAL/Driver/SQLAnywhere/SQLAnywhereStatement.php

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
use Doctrine\DBAL\Driver\Statement;
88
use Doctrine\DBAL\Driver\StatementIterator;
9+
use Doctrine\DBAL\Exception\FormatVariable;
910
use Doctrine\DBAL\Exception\InvalidColumnIndex;
1011
use Doctrine\DBAL\FetchMode;
1112
use Doctrine\DBAL\ParameterType;
@@ -17,7 +18,6 @@
1718
use function array_key_exists;
1819
use function count;
1920
use function func_get_args;
20-
use function gettype;
2121
use function is_array;
2222
use function is_int;
2323
use function is_object;
@@ -73,7 +73,10 @@ class SQLAnywhereStatement implements IteratorAggregate, Statement
7373
public function __construct($conn, $sql)
7474
{
7575
if (! is_resource($conn)) {
76-
throw new SQLAnywhereException('Invalid SQL Anywhere connection resource: ' . $conn);
76+
throw new SQLAnywhereException(sprintf(
77+
'Invalid SQL Anywhere connection resource, "%s" given.',
78+
(new FormatVariable())->__invoke($conn)
79+
));
7780
}
7881

7982
$this->conn = $conn;
@@ -108,7 +111,7 @@ public function bindParam($column, &$variable, $type = ParameterType::STRING, $l
108111
break;
109112

110113
default:
111-
throw new SQLAnywhereException('Unknown type: ' . $type);
114+
throw new SQLAnywhereException(sprintf('Unknown type %d.', $type));
112115
}
113116

114117
$this->boundValues[$column] =& $variable;
@@ -215,7 +218,7 @@ public function fetch($fetchMode = null, ...$args)
215218
return sasql_fetch_object($this->result);
216219

217220
default:
218-
throw new SQLAnywhereException('Fetch mode is not supported: ' . $fetchMode);
221+
throw new SQLAnywhereException(sprintf('Fetch mode is not supported %d.', $fetchMode));
219222
}
220223
}
221224

@@ -314,8 +317,8 @@ private function castObject(stdClass $sourceObject, $destinationClass, array $ct
314317
if (! is_string($destinationClass)) {
315318
if (! is_object($destinationClass)) {
316319
throw new SQLAnywhereException(sprintf(
317-
'Destination class has to be of type string or object, %s given.',
318-
gettype($destinationClass)
320+
'Destination class has to be of type string or object, "%s" given.',
321+
(new FormatVariable())->__invoke($destinationClass)
319322
));
320323
}
321324
} else {

‎lib/Doctrine/DBAL/Driver/SQLSrv/Driver.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class Driver extends AbstractSQLServerDriver
1717
public function connect(array $params, $username = null, $password = null, array $driverOptions = [])
1818
{
1919
if (! isset($params['host'])) {
20-
throw new SQLSrvException("Missing 'host' in configuration for sqlsrv driver.");
20+
throw new SQLSrvException('Missing "host" in configuration for sqlsrv driver.');
2121
}
2222

2323
$serverName = $params['host'];

‎lib/Doctrine/DBAL/Driver/SQLSrv/SQLSrvStatement.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ public function fetch($fetchMode = null, ...$args)
345345
return sqlsrv_fetch_object($this->stmt, $className, $ctorArgs) ?: false;
346346
}
347347

348-
throw new SQLSrvException('Fetch mode is not supported!');
348+
throw new SQLSrvException('Fetch mode is not supported.');
349349
}
350350

351351
/**

‎lib/Doctrine/DBAL/Exception/DriverRequired.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ public static function new(?string $url = null) : self
1717
if ($url !== null) {
1818
return new self(
1919
sprintf(
20-
"The options 'driver' or 'driverClass' are mandatory if a connection URL without scheme "
21-
. 'is given to DriverManager::getConnection(). Given URL: %s',
20+
'The options "driver" or "driverClass" are mandatory if a connection URL without scheme '
21+
. 'is given to DriverManager::getConnection(). Given URL "%s".',
2222
$url
2323
)
2424
);
2525
}
2626

2727
return new self(
28-
"The options 'driver' or 'driverClass' are mandatory if no PDO "
28+
'The options "driver" or "driverClass" are mandatory if no PDO '
2929
. 'instance is given to DriverManager::getConnection().'
3030
);
3131
}

‎lib/Doctrine/DBAL/Exception/EmptyCriteriaNotAllowed.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ final class EmptyCriteriaNotAllowed extends InvalidArgumentException
88
{
99
public static function new() : self
1010
{
11-
return new self('Empty criteria was used, expected non-empty criteria');
11+
return new self('Empty criteria was used, expected non-empty criteria.');
1212
}
1313
}

‎lib/Doctrine/DBAL/Exception/FormatArray.php

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Doctrine\DBAL\Exception;
6+
7+
use function array_map;
8+
use function bin2hex;
9+
use function implode;
10+
use function is_resource;
11+
use function is_string;
12+
use function json_encode;
13+
use function preg_replace;
14+
use function sprintf;
15+
16+
final class FormatArray
17+
{
18+
/**
19+
* Returns a human-readable representation of an array of parameters.
20+
* This properly handles binary data by returning a hex representation.
21+
*
22+
* @param array<mixed, mixed> $array
23+
*/
24+
public function __invoke(array $array) : string
25+
{
26+
return '[' . implode(', ', array_map(static function ($param) {
27+
if (is_resource($param)) {
28+
return (string) $param;
29+
}
30+
31+
$json = @json_encode($param);
32+
33+
if (! is_string($json) || $json === 'null' && is_string($param)) {
34+
// JSON encoding failed, this is not a UTF-8 string.
35+
return sprintf('"%s"', preg_replace('/.{2}/', '\\x$0', bin2hex($param)));
36+
}
37+
38+
return $json;
39+
}, $array)) . ']';
40+
}
41+
}

‎lib/Doctrine/DBAL/Exception/FormatVariable.php

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Doctrine\DBAL\Exception;
6+
7+
use InvalidArgumentException;
8+
use function get_class;
9+
use function get_resource_type;
10+
use function gettype;
11+
use function is_array;
12+
use function is_bool;
13+
use function is_object;
14+
use function is_resource;
15+
use function is_string;
16+
use function sprintf;
17+
18+
final class FormatVariable
19+
{
20+
/**
21+
* @param mixed $value
22+
*/
23+
public function __invoke($value) : string
24+
{
25+
if ($value === null) {
26+
return 'NULL';
27+
}
28+
29+
if (is_object($value)) {
30+
return get_class($value);
31+
}
32+
33+
if (is_resource($value)) {
34+
return get_resource_type($value);
35+
}
36+
37+
if (is_bool($value)) {
38+
return $value === true ? 'true' : 'false';
39+
}
40+
41+
if (is_array($value)) {
42+
return 'array';
43+
}
44+
45+
if (is_string($value)) {
46+
return $value;
47+
}
48+
49+
throw new InvalidArgumentException(sprintf('Could not format value of type "%s".', gettype($value)));
50+
}
51+
}

‎lib/Doctrine/DBAL/Exception/InvalidDriverClass.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public static function new(string $driverClass) : self
1414
{
1515
return new self(
1616
sprintf(
17-
"The given 'driverClass' %s has to implement the %s interface.",
17+
'The given "driverClass" "%s" has to implement the "%s" interface.',
1818
$driverClass,
1919
Driver::class
2020
)

‎lib/Doctrine/DBAL/Exception/InvalidPdoInstance.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ final class InvalidPdoInstance extends DBALException
1010
{
1111
public static function new() : self
1212
{
13-
return new self("The 'pdo' option was used in DriverManager::getConnection() but no instance of PDO was given.");
13+
return new self('The "pdo" option was used in DriverManager::getConnection() but no instance of PDO was given.');
1414
}
1515
}

0 commit comments

Comments
 (0)