Merge pull request doctrine#5735 from morozov/schema-exception-interface

Convert Doctrine\DBAL\Schema\SchemaException to an interface
derrabus · Oct 9, 2022 · a8a2650 · a8a2650
2 parents 7e284a6 + bb16de1
commit a8a2650
Show file tree

Hide file tree

Showing 20 changed files with 35 additions and 91 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -33,9 +33,9 @@ The following `SchemaException` class constants have been removed:
 - `CONSTRAINT_DOESNT_EXIST`,
 - `NAMESPACE_ALREADY_EXISTS`.
 
-## BC BREAK: The base exception class has been converted to an interface
+## BC BREAK: Exception classes have been converted to interfaces
 
-The Doctrine\DBAL\Exception class is now an interface.
+The `Doctrine\DBAL\Exception` and the `Doctrine\DBAL\Schema\SchemaException` classes are now interfaces.
 
 ## BC BREAK: removed misspelled isFullfilledBy() method
 

diff --git a/src/Schema/Column.php b/src/Schema/Column.php
@@ -44,8 +44,6 @@ class Column extends AbstractAsset
      * Creates a new Column.
      *
      * @param array<string, mixed> $options
-     *
-     * @throws SchemaException
      */
     public function __construct(string $name, Type $type, array $options = [])
     {
@@ -54,11 +52,7 @@ public function __construct(string $name, Type $type, array $options = [])
         $this->setOptions($options);
     }
 
-    /**
-     * @param array<string, mixed> $options
-     *
-     * @throws SchemaException
-     */
+    /** @param array<string, mixed> $options */
     public function setOptions(array $options): self
     {
         foreach ($options as $name => $value) {

diff --git a/src/Schema/Comparator.php b/src/Schema/Comparator.php
@@ -24,8 +24,6 @@ public function __construct(private readonly AbstractPlatform $platform)
 
     /**
      * Returns a SchemaDiff object containing the differences between the schemas $fromSchema and $toSchema.
-     *
-     * @throws SchemaException
      */
     public function compareSchemas(Schema $fromSchema, Schema $toSchema): SchemaDiff
     {

diff --git a/src/Schema/Exception/ColumnAlreadyExists.php b/src/Schema/Exception/ColumnAlreadyExists.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use LogicException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class ColumnAlreadyExists extends SchemaException
+final class ColumnAlreadyExists extends LogicException implements SchemaException
 {
     public static function new(string $tableName, string $columnName): self
     {

diff --git a/src/Schema/Exception/ColumnDoesNotExist.php b/src/Schema/Exception/ColumnDoesNotExist.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use LogicException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class ColumnDoesNotExist extends SchemaException
+final class ColumnDoesNotExist extends LogicException implements SchemaException
 {
     public static function new(string $columnName, string $table): self
     {

diff --git a/src/Schema/Exception/ForeignKeyDoesNotExist.php b/src/Schema/Exception/ForeignKeyDoesNotExist.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use LogicException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class ForeignKeyDoesNotExist extends SchemaException
+final class ForeignKeyDoesNotExist extends LogicException implements SchemaException
 {
     public static function new(string $foreignKeyName, string $table): self
     {

diff --git a/src/Schema/Exception/IndexAlreadyExists.php b/src/Schema/Exception/IndexAlreadyExists.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use LogicException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class IndexAlreadyExists extends SchemaException
+final class IndexAlreadyExists extends LogicException implements SchemaException
 {
     public static function new(string $indexName, string $table): self
     {

diff --git a/src/Schema/Exception/IndexDoesNotExist.php b/src/Schema/Exception/IndexDoesNotExist.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use LogicException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class IndexDoesNotExist extends SchemaException
+final class IndexDoesNotExist extends LogicException implements SchemaException
 {
     public static function new(string $indexName, string $table): self
     {

diff --git a/src/Schema/Exception/IndexNameInvalid.php b/src/Schema/Exception/IndexNameInvalid.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use InvalidArgumentException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class IndexNameInvalid extends SchemaException
+final class IndexNameInvalid extends InvalidArgumentException implements SchemaException
 {
     public static function new(string $indexName): self
     {

diff --git a/src/Schema/Exception/InvalidTableName.php b/src/Schema/Exception/InvalidTableName.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use InvalidArgumentException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class InvalidTableName extends SchemaException
+final class InvalidTableName extends InvalidArgumentException implements SchemaException
 {
     public static function new(string $tableName): self
     {

diff --git a/src/Schema/Exception/NamespaceAlreadyExists.php b/src/Schema/Exception/NamespaceAlreadyExists.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use LogicException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class NamespaceAlreadyExists extends SchemaException
+final class NamespaceAlreadyExists extends LogicException implements SchemaException
 {
     public static function new(string $namespaceName): self
     {

diff --git a/src/Schema/Exception/SequenceAlreadyExists.php b/src/Schema/Exception/SequenceAlreadyExists.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use LogicException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class SequenceAlreadyExists extends SchemaException
+final class SequenceAlreadyExists extends LogicException implements SchemaException
 {
     public static function new(string $sequenceName): self
     {

diff --git a/src/Schema/Exception/SequenceDoesNotExist.php b/src/Schema/Exception/SequenceDoesNotExist.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use LogicException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class SequenceDoesNotExist extends SchemaException
+final class SequenceDoesNotExist extends LogicException implements SchemaException
 {
     public static function new(string $sequenceName): self
     {

diff --git a/src/Schema/Exception/TableAlreadyExists.php b/src/Schema/Exception/TableAlreadyExists.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use LogicException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class TableAlreadyExists extends SchemaException
+final class TableAlreadyExists extends LogicException implements SchemaException
 {
     public static function new(string $tableName): self
     {

diff --git a/src/Schema/Exception/TableDoesNotExist.php b/src/Schema/Exception/TableDoesNotExist.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use LogicException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class TableDoesNotExist extends SchemaException
+final class TableDoesNotExist extends LogicException implements SchemaException
 {
     public static function new(string $tableName): self
     {

diff --git a/src/Schema/Exception/UniqueConstraintDoesNotExist.php b/src/Schema/Exception/UniqueConstraintDoesNotExist.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use LogicException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class UniqueConstraintDoesNotExist extends SchemaException
+final class UniqueConstraintDoesNotExist extends LogicException implements SchemaException
 {
     public static function new(string $constraintName, string $table): self
     {

diff --git a/src/Schema/Exception/UnknownColumnOption.php b/src/Schema/Exception/UnknownColumnOption.php
@@ -5,11 +5,12 @@
 namespace Doctrine\DBAL\Schema\Exception;
 
 use Doctrine\DBAL\Schema\SchemaException;
+use InvalidArgumentException;
 
 use function sprintf;
 
 /** @psalm-immutable */
-final class UnknownColumnOption extends SchemaException
+final class UnknownColumnOption extends InvalidArgumentException implements SchemaException
 {
     public static function new(string $name): self
     {

diff --git a/src/Schema/Schema.php b/src/Schema/Schema.php
@@ -63,8 +63,6 @@ class Schema extends AbstractAsset
      * @param array<Table>    $tables
      * @param array<Sequence> $sequences
      * @param array<string>   $namespaces
-     *
-     * @throws SchemaException
      */
     public function __construct(
         array $tables = [],
@@ -95,7 +93,6 @@ public function __construct(
         }
     }
 
-    /** @throws SchemaException */
     protected function _addTable(Table $table): void
     {
         $namespaceName = $table->getNamespaceName();
@@ -117,7 +114,6 @@ protected function _addTable(Table $table): void
         $table->setSchemaConfig($this->_schemaConfig);
     }
 
-    /** @throws SchemaException */
     protected function _addSequence(Sequence $sequence): void
     {
         $namespaceName = $sequence->getNamespaceName();
@@ -158,7 +154,6 @@ public function getTables(): array
         return array_values($this->_tables);
     }
 
-    /** @throws SchemaException */
     public function getTable(string $name): Table
     {
         $name = $this->getFullQualifiedAssetName($name);
@@ -238,7 +233,6 @@ public function hasSequence(string $name): bool
         return isset($this->_sequences[$name]);
     }
 
-    /** @throws SchemaException */
     public function getSequence(string $name): Sequence
     {
         $name = $this->getFullQualifiedAssetName($name);
@@ -259,8 +253,6 @@ public function getSequences(): array
      * Creates a new namespace.
      *
      * @return $this
-     *
-     * @throws SchemaException
      */
     public function createNamespace(string $name): self
     {
@@ -277,8 +269,6 @@ public function createNamespace(string $name): self
 
     /**
      * Creates a new table.
-     *
-     * @throws SchemaException
      */
     public function createTable(string $name): Table
     {
@@ -296,8 +286,6 @@ public function createTable(string $name): Table
      * Renames a table.
      *
      * @return $this
-     *
-     * @throws SchemaException
      */
     public function renameTable(string $oldName, string $newName): self
     {
@@ -314,8 +302,6 @@ public function renameTable(string $oldName, string $newName): self
      * Drops a table from the schema.
      *
      * @return $this
-     *
-     * @throws SchemaException
      */
     public function dropTable(string $name): self
     {
@@ -328,8 +314,6 @@ public function dropTable(string $name): self
 
     /**
      * Creates a new sequence.
-     *
-     * @throws SchemaException
      */
     public function createSequence(string $name, int $allocationSize = 1, int $initialValue = 1): Sequence
     {
@@ -366,8 +350,6 @@ public function toSql(AbstractPlatform $platform): array
      * Return an array of necessary SQL queries to drop the schema on the given platform.
      *
      * @return list<string>
-     *
-     * @throws Exception
      */
     public function toDropSql(AbstractPlatform $platform): array
     {

diff --git a/src/Schema/SchemaException.php b/src/Schema/SchemaException.php
@@ -7,6 +7,6 @@
 use Doctrine\DBAL\Exception;
 
 /** @psalm-immutable */
-class SchemaException extends \Exception implements Exception
+interface SchemaException extends Exception
 {
 }