Merge pull request #3525 from doctrine/exceptions

Extract exception factory methods into specific exceptions

lib/Doctrine/DBAL/Cache/ArrayStatement.php

@@ -5,8 +5,8 @@
 namespace Doctrine\DBAL\Cache;
 
 use ArrayIterator;
-use Doctrine\DBAL\DBALException;
 use Doctrine\DBAL\Driver\ResultStatement;
+use Doctrine\DBAL\Exception\InvalidColumnIndex;
 use Doctrine\DBAL\FetchMode;
 use InvalidArgumentException;
 use IteratorAggregate;
@@ -149,7 +149,7 @@ public function fetchColumn($columnIndex = 0)
         }
 
         if (! array_key_exists($columnIndex, $row)) {
-            throw DBALException::invalidColumnIndex($columnIndex, count($row));
+            throw InvalidColumnIndex::new($columnIndex, count($row));
         }
 
         return $row[$columnIndex];

lib/Doctrine/DBAL/Cache/CacheException.php

@@ -8,19 +8,4 @@
 
 class CacheException extends DBALException
 {
-    /**
-     * @return \Doctrine\DBAL\Cache\CacheException
-     */
-    public static function noCacheKey()
-    {
-        return new self('No cache key was set.');
-    }
-
-    /**
-     * @return \Doctrine\DBAL\Cache\CacheException
-     */
-    public static function noResultDriverConfigured()
-    {
-        return new self('Trying to cache a query but no result driver is configured.');
-    }
 }

lib/Doctrine/DBAL/Cache/Exception/NoCacheKey.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Cache\Exception;
+
+use Doctrine\DBAL\Cache\CacheException;
+
+final class NoCacheKey extends CacheException
+{
+    public static function new() : self
+    {
+        return new self('No cache key was set.');
+    }
+}

lib/Doctrine/DBAL/Cache/Exception/NoResultDriverConfigured.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\DBAL\Cache\Exception;
+
+use Doctrine\DBAL\Cache\CacheException;
+
+final class NoResultDriverConfigured extends CacheException
+{
+    public static function new() : self
+    {
+        return new self('Trying to cache a query but no result driver is configured.');
+    }
+}

lib/Doctrine/DBAL/Cache/QueryCacheProfile.php

@@ -5,6 +5,7 @@
 namespace Doctrine\DBAL\Cache;
 
 use Doctrine\Common\Cache\Cache;
+use Doctrine\DBAL\Cache\Exception\NoCacheKey;
 use function hash;
 use function serialize;
 use function sha1;
@@ -60,7 +61,7 @@ public function getLifetime()
     public function getCacheKey()
     {
         if ($this->cacheKey === null) {
-            throw CacheException::noCacheKey();
+            throw NoCacheKey::new();
         }
 
         return $this->cacheKey;

lib/Doctrine/DBAL/Cache/ResultCacheStatement.php

@@ -6,8 +6,8 @@
 
 use ArrayIterator;
 use Doctrine\Common\Cache\Cache;
-use Doctrine\DBAL\DBALException;
 use Doctrine\DBAL\Driver\ResultStatement;
+use Doctrine\DBAL\Exception\InvalidColumnIndex;
 use Doctrine\DBAL\FetchMode;
 use InvalidArgumentException;
 use IteratorAggregate;
@@ -184,7 +184,7 @@ public function fetchColumn($columnIndex = 0)
         }
 
         if (! array_key_exists($columnIndex, $row)) {
-            throw DBALException::invalidColumnIndex($columnIndex, count($row));
+            throw InvalidColumnIndex::new($columnIndex, count($row));
         }
 
         return $row[$columnIndex];

lib/Doctrine/DBAL/Connection.php

@@ -8,6 +8,7 @@
 use Doctrine\Common\EventManager;
 use Doctrine\DBAL\Cache\ArrayStatement;
 use Doctrine\DBAL\Cache\CacheException;
+use Doctrine\DBAL\Cache\Exception\NoResultDriverConfigured;
 use Doctrine\DBAL\Cache\QueryCacheProfile;
 use Doctrine\DBAL\Cache\ResultCacheStatement;
 use Doctrine\DBAL\Driver\Connection as DriverConnection;
@@ -16,7 +17,13 @@
 use Doctrine\DBAL\Driver\ResultStatement;
 use Doctrine\DBAL\Driver\ServerInfoAwareConnection;
 use Doctrine\DBAL\Driver\Statement as DriverStatement;
+use Doctrine\DBAL\Exception\CommitFailedRollbackOnly;
+use Doctrine\DBAL\Exception\EmptyCriteriaNotAllowed;
 use Doctrine\DBAL\Exception\InvalidArgumentException;
+use Doctrine\DBAL\Exception\InvalidPlatformType;
+use Doctrine\DBAL\Exception\MayNotAlterNestedTransactionWithSavepointsInTransaction;
+use Doctrine\DBAL\Exception\NoActiveTransaction;
+use Doctrine\DBAL\Exception\SavepointsNotSupported;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Query\Expression\ExpressionBuilder;
 use Doctrine\DBAL\Query\QueryBuilder;
@@ -198,7 +205,7 @@ public function __construct(
 
         if (isset($params['platform'])) {
             if (! $params['platform'] instanceof Platforms\AbstractPlatform) {
-                throw DBALException::invalidPlatformType($params['platform']);
+                throw InvalidPlatformType::new($params['platform']);
             }
 
             $this->platform = $params['platform'];
@@ -642,7 +649,7 @@ private function addIdentifierCondition(
     public function delete($tableExpression, array $identifier, array $types = [])
     {
         if (empty($identifier)) {
-            throw InvalidArgumentException::fromEmptyCriteria();
+            throw EmptyCriteriaNotAllowed::new();
         }
 
         $columns = $values = $conditions = [];
@@ -915,7 +922,7 @@ public function executeCacheQuery($query, $params, $types, QueryCacheProfile $qc
         $resultCache = $qcp->getResultCacheDriver() ?? $this->_config->getResultCacheImpl();
 
         if ($resultCache === null) {
-            throw CacheException::noResultDriverConfigured();
+            throw NoResultDriverConfigured::new();
         }
 
         [$cacheKey, $realKey] = $qcp->generateCacheKeys($query, $params, $types, $this->getParams());
@@ -1122,11 +1129,11 @@ public function transactional(Closure $func)
     public function setNestTransactionsWithSavepoints($nestTransactionsWithSavepoints)
     {
         if ($this->transactionNestingLevel > 0) {
-            throw ConnectionException::mayNotAlterNestedTransactionWithSavepointsInTransaction();
+            throw MayNotAlterNestedTransactionWithSavepointsInTransaction::new();
         }
 
         if (! $this->getDatabasePlatform()->supportsSavepoints()) {
-            throw ConnectionException::savepointsNotSupported();
+            throw SavepointsNotSupported::new();
         }
 
         $this->nestTransactionsWithSavepoints = (bool) $nestTransactionsWithSavepoints;
@@ -1188,11 +1195,10 @@ public function beginTransaction() : void
     public function commit() : void
     {
         if ($this->transactionNestingLevel === 0) {
-            throw ConnectionException::noActiveTransaction();
+            throw NoActiveTransaction::new();
         }
-
         if ($this->isRollbackOnly) {
-            throw ConnectionException::commitFailedRollbackOnly();
+            throw CommitFailedRollbackOnly::new();
         }
 
         $connection = $this->getWrappedConnection();
@@ -1251,7 +1257,7 @@ private function commitAll() : void
     public function rollBack() : void
     {
         if ($this->transactionNestingLevel === 0) {
-            throw ConnectionException::noActiveTransaction();
+            throw NoActiveTransaction::new();
         }
 
         $connection = $this->getWrappedConnection();
@@ -1295,7 +1301,7 @@ public function rollBack() : void
     public function createSavepoint($savepoint)
     {
         if (! $this->getDatabasePlatform()->supportsSavepoints()) {
-            throw ConnectionException::savepointsNotSupported();
+            throw SavepointsNotSupported::new();
         }
 
         $this->getWrappedConnection()->exec($this->platform->createSavePoint($savepoint));
@@ -1313,7 +1319,7 @@ public function createSavepoint($savepoint)
     public function releaseSavepoint($savepoint)
     {
         if (! $this->getDatabasePlatform()->supportsSavepoints()) {
-            throw ConnectionException::savepointsNotSupported();
+            throw SavepointsNotSupported::new();
         }
 
         if (! $this->platform->supportsReleaseSavepoints()) {
@@ -1335,7 +1341,7 @@ public function releaseSavepoint($savepoint)
     public function rollbackSavepoint($savepoint)
     {
         if (! $this->getDatabasePlatform()->supportsSavepoints()) {
-            throw ConnectionException::savepointsNotSupported();
+            throw SavepointsNotSupported::new();
         }
 
         $this->getWrappedConnection()->exec($this->platform->rollbackSavePoint($savepoint));
@@ -1380,7 +1386,7 @@ public function getSchemaManager()
     public function setRollbackOnly()
     {
         if ($this->transactionNestingLevel === 0) {
-            throw ConnectionException::noActiveTransaction();
+            throw NoActiveTransaction::new();
         }
         $this->isRollbackOnly = true;
     }
@@ -1395,7 +1401,7 @@ public function setRollbackOnly()
     public function isRollbackOnly()
     {
         if ($this->transactionNestingLevel === 0) {
-            throw ConnectionException::noActiveTransaction();
+            throw NoActiveTransaction::new();
         }
 
         return $this->isRollbackOnly;

lib/Doctrine/DBAL/ConnectionException.php

@@ -6,35 +6,4 @@
 
 class ConnectionException extends DBALException
 {
-    /**
-     * @return \Doctrine\DBAL\ConnectionException
-     */
-    public static function commitFailedRollbackOnly()
-    {
-        return new self('Transaction commit failed because the transaction has been marked for rollback only.');
-    }
-
-    /**
-     * @return \Doctrine\DBAL\ConnectionException
-     */
-    public static function noActiveTransaction()
-    {
-        return new self('There is no active transaction.');
-    }
-
-    /**
-     * @return \Doctrine\DBAL\ConnectionException
-     */
-    public static function savepointsNotSupported()
-    {
-        return new self('Savepoints are not supported by this driver.');
-    }
-
-    /**
-     * @return \Doctrine\DBAL\ConnectionException
-     */
-    public static function mayNotAlterNestedTransactionWithSavepointsInTransaction()
-    {
-        return new self('May not alter the nested transaction with savepoints behavior while a transaction is open.');
-    }
 }