1<?php
2/*
3 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14 *
15 * This software consists of voluntary contributions made by many individuals
16 * and is licensed under the MIT license. For more information, see
17 * <http://www.doctrine-project.org>.
18 */
19
20namespace Doctrine\ORM\Cache;
21
22use Doctrine\ORM\ORMException;
23
24/**
25 * Exception for cache.
26 *
27 * @since   2.5
28 * @author  Fabio B. Silva <fabio.bat.silva@gmail.com>
29 */
30class CacheException extends ORMException
31{
32    /**
33     * @param string $sourceEntity
34     * @param string $fieldName
35     *
36     * @return \Doctrine\ORM\Cache\CacheException
37     */
38    public static function updateReadOnlyCollection($sourceEntity, $fieldName)
39    {
40        return new self(sprintf('Cannot update a readonly collection "%s#%s"', $sourceEntity, $fieldName));
41    }
42
43    /**
44     * @param string $entityName
45     *
46     * @return \Doctrine\ORM\Cache\CacheException
47     */
48    public static function updateReadOnlyEntity($entityName)
49    {
50        return new self(sprintf('Cannot update a readonly entity "%s"', $entityName));
51    }
52
53    /**
54     * @param string $entityName
55     *
56     * @return \Doctrine\ORM\Cache\CacheException
57     */
58    public static function nonCacheableEntity($entityName)
59    {
60        return new self(sprintf('Entity "%s" not configured as part of the second-level cache.', $entityName));
61    }
62
63    /**
64     * @param string $entityName
65     * @param string $field
66     *
67     * @return CacheException
68     */
69    public static function nonCacheableEntityAssociation($entityName, $field)
70    {
71        return new self(sprintf('Entity association field "%s#%s" not configured as part of the second-level cache.', $entityName, $field));
72    }
73}
74