Skip to content

Commit 64ebece

Browse files
beberleibeberlei
committed
Undeprecate \Doctrine\DBAL\Driver\DriverException interface
1 parent 3691e81 commit 64ebece

23 files changed

+103
-152
lines changed

‎UPGRADE.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ The non-interface methods of driver-level classes have been marked internal:
8888

8989
The following classes under the `Driver` namespace have been deprecated in favor of their consistently named counterparts:
9090

91-
- `DriverException` → `Exception`
9291
- `AbstractDriverException` → `AbstractException`
9392
- `IBMDB2\DB2Driver` → `IBMDB2\Driver`
9493
- `IBMDB2\DB2Connection` → `IBMDB2\Connection`
@@ -110,7 +109,8 @@ All driver-specific exception classes have been deprecated:
110109
- `PDOException`
111110
- `SQLSrv\SQLSrvException`
112111

113-
A driver-level exception should be only identified as a subtype of `Driver\Exception`.
112+
A driver-level exception should be only identified as a subtype of `Doctrine\DBAL\Driver\DriverException`
113+
or when its wrapped as `Doctrine\DBAL\Exception\DriverException`.
114114
Internal driver-level exception implementations may use `Driver\AbstractException` as the base class.
115115
Driver-specific exception handling has to be implemented either in the driver or based on the type of the `Driver` implementation.
116116

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
use ArrayIterator;
66
use Doctrine\Common\Cache\Cache;
7-
use Doctrine\DBAL\Driver\Exception;
7+
use Doctrine\DBAL\Driver\DriverException;
88
use Doctrine\DBAL\Driver\FetchUtils;
99
use Doctrine\DBAL\Driver\Result;
1010
use Doctrine\DBAL\Driver\ResultStatement;
@@ -297,7 +297,7 @@ public function free(): void
297297
/**
298298
* @return array<string,mixed>|false
299299
*
300-
* @throws Exception
300+
* @throws DriverException
301301
*/
302302
private function doFetch()
303303
{

‎lib/Doctrine/DBAL/DBALException.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
namespace Doctrine\DBAL;
44

5-
use Doctrine\DBAL\Driver\DriverException as DeprecatedDriverException;
5+
use Doctrine\DBAL\Driver\DriverException as LowLevelDriverException;
66
use Doctrine\DBAL\Driver\ExceptionConverterDriver;
77
use Doctrine\DBAL\Exception\DriverException;
88
use Doctrine\DBAL\Platforms\AbstractPlatform;
@@ -177,7 +177,7 @@ private static function wrapException(Driver $driver, Throwable $driverEx, strin
177177
return $driverEx;
178178
}
179179

180-
if ($driver instanceof ExceptionConverterDriver && $driverEx instanceof DeprecatedDriverException) {
180+
if ($driver instanceof ExceptionConverterDriver && $driverEx instanceof LowLevelDriverException) {
181181
return $driver->convertException($msg, $driverEx);
182182
}
183183

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ public function convertException($message, DeprecatedDriverException $exception)
8585
return new TableExistsException($message, $exception);
8686

8787
case '08006':
88-
return new Exception\ConnectionException($message, $exception);
88+
return new ConnectionException($message, $exception);
8989

9090
case '7':
9191
// Prior to fixing https://bugs.php.net/bug.php?id=64705 (PHP 7.3.22 and PHP 7.4.10),

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

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,34 @@
11
<?php
22

3+
declare(strict_types=1);
4+
35
namespace Doctrine\DBAL\Driver;
46

7+
use Throwable;
8+
59
/**
6-
* @deprecated Use {@link Exception} instead
7-
*
810
* @psalm-immutable
911
*/
10-
interface DriverException extends Exception
12+
interface DriverException extends Throwable
1113
{
14+
/**
15+
* Returns the driver specific error code if available.
16+
*
17+
* @deprecated Use {@link getCode()} or {@link getSQLState()} instead
18+
*
19+
* Returns null if no driver specific error code is available
20+
* for the error raised by the driver.
21+
*
22+
* @return int|string|null
23+
*/
24+
public function getErrorCode();
25+
26+
/**
27+
* Returns the SQLSTATE the driver was in at the time the error occurred.
28+
*
29+
* Returns null if the driver does not provide a SQLSTATE for the error occurred.
30+
*
31+
* @return string|null
32+
*/
33+
public function getSQLState();
1234
}

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

Lines changed: 0 additions & 34 deletions
This file was deleted.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ final class FetchUtils
1212
/**
1313
* @return mixed|false
1414
*
15-
* @throws Exception
15+
* @throws DriverException
1616
*/
1717
public static function fetchOne(Result $result)
1818
{
@@ -28,7 +28,7 @@ public static function fetchOne(Result $result)
2828
/**
2929
* @return array<int,array<int,mixed>>
3030
*
31-
* @throws Exception
31+
* @throws DriverException
3232
*/
3333
public static function fetchAllNumeric(Result $result): array
3434
{
@@ -44,7 +44,7 @@ public static function fetchAllNumeric(Result $result): array
4444
/**
4545
* @return array<int,array<string,mixed>>
4646
*
47-
* @throws Exception
47+
* @throws DriverException
4848
*/
4949
public static function fetchAllAssociative(Result $result): array
5050
{
@@ -60,7 +60,7 @@ public static function fetchAllAssociative(Result $result): array
6060
/**
6161
* @return array<int,mixed>
6262
*
63-
* @throws Exception
63+
* @throws DriverException
6464
*/
6565
public static function fetchFirstColumn(Result $result): array
6666
{

‎lib/Doctrine/DBAL/Driver/PDO/Exception.php‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

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

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@
33
namespace Doctrine\DBAL\Driver;
44

55
use Doctrine\DBAL\Driver\Connection as ConnectionInterface;
6-
use Doctrine\DBAL\Driver\PDO\Exception;
76
use Doctrine\DBAL\Driver\PDO\Statement;
87
use PDO;
9-
use PDOException;
8+
use PDOException as OriginalPDOException;
109
use PDOStatement;
1110

1211
use function assert;
@@ -36,8 +35,8 @@ public function __construct($dsn, $user = null, $password = null, ?array $option
3635
parent::__construct($dsn, (string) $user, (string) $password, (array) $options);
3736
$this->setAttribute(PDO::ATTR_STATEMENT_CLASS, [Statement::class, []]);
3837
$this->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
39-
} catch (PDOException $exception) {
40-
throw Exception::new($exception);
38+
} catch (OriginalPDOException $exception) {
39+
throw PDOException::new($exception);
4140
}
4241
}
4342

@@ -51,8 +50,8 @@ public function exec($sql)
5150
assert($result !== false);
5251

5352
return $result;
54-
} catch (PDOException $exception) {
55-
throw Exception::new($exception);
53+
} catch (OriginalPDOException $exception) {
54+
throw PDOException::new($exception);
5655
}
5756
}
5857

@@ -77,8 +76,8 @@ public function prepare($sql, $driverOptions = [])
7776
assert($statement instanceof PDOStatement);
7877

7978
return $statement;
80-
} catch (PDOException $exception) {
81-
throw Exception::new($exception);
79+
} catch (OriginalPDOException $exception) {
80+
throw PDOException::new($exception);
8281
}
8382
}
8483

@@ -96,8 +95,8 @@ public function query()
9695
assert($stmt instanceof PDOStatement);
9796

9897
return $stmt;
99-
} catch (PDOException $exception) {
100-
throw Exception::new($exception);
98+
} catch (OriginalPDOException $exception) {
99+
throw PDOException::new($exception);
101100
}
102101
}
103102

@@ -112,8 +111,8 @@ public function lastInsertId($name = null)
112111
}
113112

114113
return parent::lastInsertId($name);
115-
} catch (PDOException $exception) {
116-
throw Exception::new($exception);
114+
} catch (OriginalPDOException $exception) {
115+
throw PDOException::new($exception);
117116
}
118117
}
119118

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
use Doctrine\DBAL\Driver\PDO\Exception;
66

77
/**
8-
* @deprecated Use {@link Exception} instead
9-
*
108
* @psalm-immutable
119
*/
1210
class PDOException extends \PDOException implements DriverException
@@ -25,6 +23,11 @@ class PDOException extends \PDOException implements DriverException
2523
*/
2624
private $sqlState;
2725

26+
public static function new(\PDOException $exception): self
27+
{
28+
return new self($exception);
29+
}
30+
2831
/**
2932
* @param \PDOException $exception The PDO exception to wrap.
3033
*/

0 commit comments

Comments
 (0)