Merge pull request #6743 from greg0ire/split_orm_exception

Split orm exception

Author: Ocramius

lib/Doctrine/ORM/AbstractQuery.php

@@ -8,6 +8,7 @@
 use Doctrine\Common\Collections\Collection;
 use Doctrine\DBAL\Cache\QueryCacheProfile;
 use Doctrine\DBAL\Driver\Statement;
+use Doctrine\ORM\Cache\Exception\InvalidResultCacheDriver;
 use Doctrine\ORM\Cache\Logging\CacheLogger;
 use Doctrine\ORM\Cache\QueryCacheKey;
 use Doctrine\ORM\Cache\TimestampCacheKey;
@@ -497,7 +498,7 @@ public function setResultCacheProfile(?QueryCacheProfile $profile = null)
     public function setResultCacheDriver($resultCacheDriver = null)
     {
         if ($resultCacheDriver !== null && ! ($resultCacheDriver instanceof \Doctrine\Common\Cache\Cache)) {
-            throw ORMException::invalidResultCacheDriver();
+            throw InvalidResultCacheDriver::create();
         }
 
         $this->queryCacheProfile = $this->queryCacheProfile

lib/Doctrine/ORM/Cache/CacheException.php

@@ -5,6 +5,8 @@
 namespace Doctrine\ORM\Cache;
 
 use Doctrine\ORM\Cache;
+use Doctrine\ORM\Cache\Exception\FeatureNotImplemented;
+use Doctrine\ORM\Cache\Exception\NonCacheableEntity;
 use Doctrine\ORM\Cache\Logging\CacheLogger;
 use Doctrine\ORM\Cache\Persister\CachedPersister;
 use Doctrine\ORM\EntityManagerInterface;
@@ -229,19 +231,19 @@ public function get(QueryCacheKey $key, ResultSetMapping $rsm, array $hints = []
     public function put(QueryCacheKey $key, ResultSetMapping $rsm, $result, array $hints = [])
     {
         if ($rsm->scalarMappings) {
-            throw new CacheException('Second level cache does not support scalar results.');
+            throw FeatureNotImplemented::scalarResults();
         }
 
         if (count($rsm->entityMappings) > 1) {
-            throw new CacheException('Second level cache does not support multiple root entities.');
+            throw FeatureNotImplemented::multipleRootEntities();
         }
 
         if (! $rsm->isSelect) {
-            throw new CacheException('Second-level cache query supports only select statements.');
+            throw FeatureNotImplemented::nonSelectStatements();
         }
 
         if (isset($hints[Query::HINT_FORCE_PARTIAL_LOAD]) && $hints[Query::HINT_FORCE_PARTIAL_LOAD]) {
-            throw new CacheException('Second level cache does not support partial entities.');
+            throw FeatureNotImplemented::partialEntities();
         }
 
         if (! ($key->cacheMode & Cache::MODE_PUT)) {
@@ -255,7 +257,7 @@ public function put(QueryCacheKey $key, ResultSetMapping $rsm, $result, array $h
         $persister  = $unitOfWork->getEntityPersister($entityName);
 
         if (! ($persister instanceof CachedPersister)) {
-            throw CacheException::nonCacheableEntity($entityName);
+            throw NonCacheableEntity::fromEntity($entityName);
         }
 
         $region = $persister->getCacheRegion();

lib/Doctrine/ORM/Cache/DefaultQueryCache.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Cache\Exception;
+
+use Doctrine\ORM\Exception\ORMException;
+
+/**
+ * Exception for cache.
+ */
+interface CacheException extends ORMException
+{
+}

lib/Doctrine/ORM/Cache/Exception/CacheException.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Cache\Exception;
+
+use function sprintf;
+
+class CannotUpdateReadOnlyCollection extends \LogicException implements CacheException
+{
+    public static function fromEntityAndField(string $sourceEntity, string $fieldName) : self
+    {
+        return new self(sprintf(
+            'Cannot update a readonly collection "%s#%s"',
+            $sourceEntity,
+            $fieldName
+        ));
+    }
+}

lib/Doctrine/ORM/Cache/Exception/CannotUpdateReadOnlyCollection.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Cache\Exception;
+
+use function sprintf;
+
+class CannotUpdateReadOnlyEntity extends \LogicException implements CacheException
+{
+    public static function fromEntity(string $entityName) : self
+    {
+        return new self(sprintf('Cannot update a readonly entity "%s"', $entityName));
+    }
+}

lib/Doctrine/ORM/Cache/Exception/CannotUpdateReadOnlyEntity.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Cache\Exception;
+
+class FeatureNotImplemented extends \LogicException implements CacheException
+{
+    public static function scalarResults() : self
+    {
+        return new self('Second level cache does not support scalar results.');
+    }
+
+    public static function multipleRootEntities() : self
+    {
+        return new self('Second level cache does not support multiple root entities.');
+    }
+
+    public static function nonSelectStatements() : self
+    {
+        return new self('Second-level cache query supports only select statements.');
+    }
+
+    public static function partialEntities() : self
+    {
+        return new self('Second level cache does not support partial entities.');
+    }
+}

lib/Doctrine/ORM/Cache/Exception/FeatureNotImplemented.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Cache\Exception;
+
+final class InvalidResultCacheDriver extends \LogicException implements CacheException
+{
+    public static function create() : self
+    {
+        return new self(
+            'Invalid result cache driver; it must implement Doctrine\\Common\\Cache\\Cache.'
+        );
+    }
+}

lib/Doctrine/ORM/Cache/Exception/InvalidResultCacheDriver.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Cache\Exception;
+
+final class MetadataCacheNotConfigured extends \LogicException implements CacheException
+{
+    public static function create() : self
+    {
+        return new self('Class Metadata Cache is not configured.');
+    }
+}

lib/Doctrine/ORM/Cache/Exception/MetadataCacheNotConfigured.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Cache\Exception;
+
+use Doctrine\Common\Cache\Cache;
+use function get_class;
+
+final class MetadataCacheUsesNonPersistentCache extends \LogicException implements CacheException
+{
+    public static function fromDriver(Cache $cache) : self
+    {
+        return new self(
+            'Metadata Cache uses a non-persistent cache driver, ' . get_class($cache) . '.'
+        );
+    }
+}