Convert Doctrine\DBAL\Exception to an interface

Author: morozov

UPGRADE.md

@@ -8,6 +8,10 @@ awareness about deprecated code.
 
 # Upgrade to 4.0
 
+## BC BREAK: The base exception class has been converted to an interface
+
+The Doctrine\DBAL\Exception class is now an interface.
+
 ## BC BREAK: removed misspelled isFullfilledBy() method
 
 This method's name was spelled incorrectly. Use `isFulfilledBy` instead.

src/Cache/CacheException.php

@@ -7,6 +7,6 @@
 use Doctrine\DBAL\Exception;
 
 /** @psalm-immutable */
-class CacheException extends Exception
+class CacheException extends \Exception implements Exception
 {
 }

src/ConnectionException.php

@@ -5,6 +5,6 @@
 namespace Doctrine\DBAL;
 
 /** @psalm-immutable */
-class ConnectionException extends Exception
+class ConnectionException extends \Exception implements Exception
 {
 }

src/DriverManager.php

@@ -11,6 +11,7 @@
 use Doctrine\DBAL\Driver\PDO;
 use Doctrine\DBAL\Driver\SQLSrv;
 use Doctrine\DBAL\Exception\DriverRequired;
+use Doctrine\DBAL\Exception\InvalidArgumentException;
 use Doctrine\DBAL\Exception\InvalidDriverClass;
 use Doctrine\DBAL\Exception\InvalidWrapperClass;
 use Doctrine\DBAL\Exception\UnknownDriver;
@@ -280,7 +281,7 @@ private static function parseDatabaseUrl(array $params): array
         $url = parse_url($url);
 
         if ($url === false) {
-            throw new Exception('Malformed parameter "url".');
+            throw new InvalidArgumentException('Malformed parameter "url".');
         }
 
         foreach ($url as $param => $value) {

src/Exception.php

@@ -4,7 +4,9 @@
 
 namespace Doctrine\DBAL;
 
+use Throwable;
+
 /** @psalm-immutable */
-class Exception extends \Exception
+interface Exception extends Throwable
 {
 }

src/Exception/DatabaseRequired.php

@@ -9,7 +9,7 @@
 use function sprintf;
 
 /** @psalm-immutable */
-class DatabaseRequired extends Exception
+class DatabaseRequired extends \Exception implements Exception
 {
     public static function new(string $methodName): self
     {

src/Exception/DriverException.php

@@ -15,7 +15,7 @@
  *
  * @psalm-immutable
  */
-class DriverException extends Exception implements Driver\Exception
+class DriverException extends \Exception implements Exception, Driver\Exception
 {
     /**
      * @internal

src/Exception/DriverRequired.php

@@ -9,7 +9,7 @@
 use function sprintf;
 
 /** @psalm-immutable */
-final class DriverRequired extends Exception
+final class DriverRequired extends \Exception implements Exception
 {
     /** @param string|null $url The URL that was provided in the connection parameters (if any). */
     public static function new(?string $url = null): self

src/Exception/InvalidArgumentException.php

@@ -11,6 +11,6 @@
  *
  * @psalm-immutable
  */
-class InvalidArgumentException extends Exception
+class InvalidArgumentException extends \InvalidArgumentException implements Exception
 {
 }

src/Exception/InvalidColumnDeclaration.php

@@ -9,7 +9,7 @@
 use function sprintf;
 
 /** @psalm-immutable */
-final class InvalidColumnDeclaration extends Exception
+final class InvalidColumnDeclaration extends \Exception implements Exception
 {
     public static function fromInvalidColumnType(string $columnName, InvalidColumnType $e): self
     {

src/Exception/InvalidColumnType.php

@@ -7,6 +7,6 @@
 use Doctrine\DBAL\Exception;
 
 /** @psalm-immutable */
-abstract class InvalidColumnType extends Exception
+abstract class InvalidColumnType extends \Exception implements Exception
 {
 }

src/Exception/InvalidDriverClass.php

@@ -10,7 +10,7 @@
 use function sprintf;
 
 /** @psalm-immutable */
-final class InvalidDriverClass extends Exception
+final class InvalidDriverClass extends \Exception implements Exception
 {
     public static function new(string $driverClass): self
     {

src/Exception/InvalidWrapperClass.php

@@ -10,7 +10,7 @@
 use function sprintf;
 
 /** @psalm-immutable */
-final class InvalidWrapperClass extends Exception
+final class InvalidWrapperClass extends \Exception implements Exception
 {
     public static function new(string $wrapperClass): self
     {

src/Exception/NoKeyValue.php

@@ -13,7 +13,7 @@
  *
  * @psalm-immutable
  */
-final class NoKeyValue extends Exception
+final class NoKeyValue extends \Exception implements Exception
 {
     public static function fromColumnCount(int $columnCount): self
     {

src/Exception/UnknownDriver.php

@@ -10,7 +10,7 @@
 use function sprintf;
 
 /** @psalm-immutable */
-final class UnknownDriver extends Exception
+final class UnknownDriver extends \Exception implements Exception
 {
     /** @param string[] $knownDrivers */
     public static function new(string $unknownDriverName, array $knownDrivers): self

src/Platforms/AbstractPlatform.php

@@ -16,6 +16,7 @@
 use Doctrine\DBAL\Event\SchemaDropTableEventArgs;
 use Doctrine\DBAL\Events;
 use Doctrine\DBAL\Exception;
+use Doctrine\DBAL\Exception\InvalidArgumentException;
 use Doctrine\DBAL\Exception\InvalidColumnDeclaration;
 use Doctrine\DBAL\Exception\InvalidColumnType;
 use Doctrine\DBAL\Exception\InvalidColumnType\ColumnLengthRequired;
@@ -40,7 +41,6 @@
 use Doctrine\DBAL\Types;
 use Doctrine\DBAL\Types\Exception\TypeNotFound;
 use Doctrine\DBAL\Types\Type;
-use InvalidArgumentException;
 use UnexpectedValueException;
 
 use function addcslashes;
@@ -364,7 +364,7 @@ public function getDoctrineTypeMapping(string $dbType): string
         $dbType = strtolower($dbType);
 
         if (! isset($this->doctrineTypeMapping[$dbType])) {
-            throw new Exception(sprintf(
+            throw new InvalidArgumentException(sprintf(
                 'Unknown database type "%s" requested, %s may not support it.',
                 $dbType,
                 static::class,
@@ -2235,7 +2235,7 @@ public function getTimeFormatString(): string
     final public function modifyLimitQuery(string $query, ?int $limit, int $offset = 0): string
     {
         if ($offset < 0) {
-            throw new Exception(sprintf(
+            throw new InvalidArgumentException(sprintf(
                 'Offset must be a positive integer or zero, %d given.',
                 $offset,
             ));

src/Platforms/Exception/InvalidPlatformVersion.php

@@ -4,7 +4,7 @@
 
 namespace Doctrine\DBAL\Platforms\Exception;
 
-use Doctrine\DBAL\Exception;
+use Exception;
 
 use function sprintf;
 

src/Platforms/Exception/NoColumnsSpecifiedForTable.php

@@ -4,7 +4,7 @@
 
 namespace Doctrine\DBAL\Platforms\Exception;
 
-use Doctrine\DBAL\Exception;
+use Exception;
 
 use function sprintf;
 

src/Platforms/Exception/NotSupported.php

@@ -4,7 +4,7 @@
 
 namespace Doctrine\DBAL\Platforms\Exception;
 
-use Doctrine\DBAL\Exception;
+use Exception;
 
 use function sprintf;
 

src/Platforms/Exception/PlatformException.php

@@ -4,6 +4,8 @@
 
 namespace Doctrine\DBAL\Platforms\Exception;
 
-interface PlatformException
+use Doctrine\DBAL\Exception;
+
+interface PlatformException extends Exception
 {
 }

src/Platforms/SQLitePlatform.php

@@ -543,17 +543,17 @@ public function getDropTablesSQL(array $tables): array
 
     public function getCreatePrimaryKeySQL(Index $index, string $table): string
     {
-        throw new Exception('Sqlite platform does not support alter primary key.');
+        throw NotSupported::new(__METHOD__);
     }
 
     public function getCreateForeignKeySQL(ForeignKeyConstraint $foreignKey, string $table): string
     {
-        throw new Exception('Sqlite platform does not support alter foreign key.');
+        throw NotSupported::new(__METHOD__);
     }
 
     public function getDropForeignKeySQL(string $foreignKey, string $table): string
     {
-        throw new Exception('Sqlite platform does not support alter foreign key.');
+        throw NotSupported::new(__METHOD__);
     }
 
     /**

src/Query/QueryException.php

@@ -7,6 +7,6 @@
 use Doctrine\DBAL\Exception;
 
 /** @psalm-immutable */
-class QueryException extends Exception
+class QueryException extends \Exception implements Exception
 {
 }

src/Schema/SchemaException.php

@@ -7,7 +7,7 @@
 use Doctrine\DBAL\Exception;
 
 /** @psalm-immutable */
-class SchemaException extends Exception
+class SchemaException extends \Exception implements Exception
 {
     public const TABLE_DOESNT_EXIST       = 10;
     public const TABLE_ALREADY_EXISTS     = 20;

src/Schema/Table.php

@@ -516,14 +516,14 @@ public function getPrimaryKey(): ?Index
      *
      * @return array<string, Column>
      *
-     * @throws Exception
+     * @throws SchemaException
      */
     public function getPrimaryKeyColumns(): array
     {
         $primaryKey = $this->getPrimaryKey();
 
         if ($primaryKey === null) {
-            throw new Exception(sprintf('Table "%s" has no primary key.', $this->getName()));
+            throw new SchemaException(sprintf('Table "%s" has no primary key.', $this->getName()));
         }
 
         return $this->filterColumns($primaryKey->getColumns());

src/Types/ConversionException.php

@@ -11,6 +11,6 @@
  *
  * @psalm-immutable
  */
-class ConversionException extends Exception
+class ConversionException extends \Exception implements Exception
 {
 }

src/Types/Exception/TypeNotFound.php

@@ -4,7 +4,7 @@
 
 namespace Doctrine\DBAL\Types\Exception;
 
-use Doctrine\DBAL\Exception;
+use Exception;
 
 use function sprintf;
 

src/Types/Exception/TypeNotRegistered.php

@@ -4,8 +4,8 @@
 
 namespace Doctrine\DBAL\Types\Exception;
 
-use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Types\Type;
+use Exception;
 
 use function get_debug_type;
 use function spl_object_hash;

src/Types/Exception/TypesAlreadyExists.php

@@ -4,7 +4,7 @@
 
 namespace Doctrine\DBAL\Types\Exception;
 
-use Doctrine\DBAL\Exception;
+use Exception;
 
 use function sprintf;
 

src/Types/Exception/TypesException.php

@@ -4,6 +4,8 @@
 
 namespace Doctrine\DBAL\Types\Exception;
 
-interface TypesException
+use Doctrine\DBAL\Exception;
+
+interface TypesException extends Exception
 {
 }

src/Types/Exception/UnknownColumnType.php

@@ -4,7 +4,7 @@
 
 namespace Doctrine\DBAL\Types\Exception;
 
-use Doctrine\DBAL\Exception;
+use Exception;
 
 use function sprintf;