vendor/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/MappingException.php

   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.phpdoctrine.org>.
  18  */
  19
  20 namespace Doctrine\Common\Persistence\Mapping;
  21
  22 /**
  23  * A MappingException indicates that something is wrong with the mapping setup.
  24  *
  25  * @since 2.2
  26  */
  27 class MappingException extends \Exception
  28 {
  29     /**
  30      *
  31      * @param string $className
  32      * @param array $namespaces
  33      *
  34      * @return MappingException
  35      */
  36     public static function classNotFoundInNamespaces($className, $namespaces)
  37     {
  38         return new self("The class '" . $className . "' was not found in the ".
  39             "chain configured namespaces " . implode(", ", $namespaces));
  40     }
  41
  42     /**
  43      * @return MappingException
  44      */
  45     public static function pathRequired()
  46     {
  47         return new self("Specifying the paths to your entities is required ".
  48             "in the AnnotationDriver to retrieve all class names.");
  49     }
  50
  51     /**
  52      * @param string|null $path
  53      * @return MappingException
  54      */
  55     public static function fileMappingDriversRequireConfiguredDirectoryPath($path = null)
  56     {
  57         if ( ! empty($path)) {
  58             $path = '[' . $path . ']';
  59         }
  60
  61         return new self(
  62             'File mapping drivers must have a valid directory path, ' .
  63             'however the given path ' . $path . ' seems to be incorrect!'
  64         );
  65     }
  66
  67     /**
  68      * @param string $entityName
  69      * @param string $fileName
  70      * @return MappingException
  71      */
  72     public static function mappingFileNotFound($entityName, $fileName)
  73     {
  74         return new self("No mapping file found named '$fileName' for class '$entityName'.");
  75     }
  76
  77     /**
  78      * @param string $entityName
  79      * @param string $fileName
  80      * @return MappingException
  81      */
  82     public static function invalidMappingFile($entityName, $fileName)
  83     {
  84         return new self("Invalid mapping file '$fileName' for class '$entityName'.");
  85     }
  86 }