vendor/doctrine/persistence/src/Persistence/Mapping/MappingException.php line 13

Open in your IDE?
  1. <?php
  3. namespace Doctrine\Persistence\Mapping;
  5. use Exception;
  7. use function implode;
  8. use function sprintf;
  10. /**
  11.  * A MappingException indicates that something is wrong with the mapping setup.
  12.  */
  13. class MappingException extends Exception
  14. {
  15.     /**
  16.      * @param string   $className
  17.      * @param string[] $namespaces
  18.      *
  19.      * @return self
  20.      */
  21.     public static function classNotFoundInNamespaces($className, $namespaces)
  22.     {
  23.         return new self(sprintf(
  24.             "The class '%s' was not found in the chain configured namespaces %s",
  25.             $className,
  26.             implode(', ', $namespaces)
  27.         ));
  28.     }
  30.     /**
  31.      * @deprecated Use pathRequiredForDriver instead
  32.      *
  33.      * @return self
  34.      */
  35.     public static function pathRequired()
  36.     {
  37.         return new self('Specifying the paths to your entities is required ' .
  38.             'in the AnnotationDriver to retrieve all class names.');
  39.     }
  41.     /**
  42.      * @param class-string $driverClassName
  43.      */
  44.     public static function pathRequiredForDriver(string $driverClassName): self
  45.     {
  46.         return new self(sprintf(
  47.             'Specifying the paths to your entities is required when using %s to retrieve all class names.',
  48.             $driverClassName
  49.         ));
  50.     }
  52.     /**
  53.      * @param string|null $path
  54.      *
  55.      * @return self
  56.      */
  57.     public static function fileMappingDriversRequireConfiguredDirectoryPath($path = null)
  58.     {
  59.         if (! empty($path)) {
  60.             $path = '[' . $path . ']';
  61.         }
  63.         return new self(sprintf(
  64.             'File mapping drivers must have a valid directory path, ' .
  65.             'however the given path %s seems to be incorrect!',
  66.             (string) $path
  67.         ));
  68.     }
  70.     /**
  71.      * @param string $entityName
  72.      * @param string $fileName
  73.      *
  74.      * @return self
  75.      */
  76.     public static function mappingFileNotFound($entityName, $fileName)
  77.     {
  78.         return new self(sprintf(
  79.             "No mapping file found named '%s' for class '%s'.",
  80.             $fileName,
  81.             $entityName
  82.         ));
  83.     }
  85.     /**
  86.      * @param string $entityName
  87.      * @param string $fileName
  88.      *
  89.      * @return self
  90.      */
  91.     public static function invalidMappingFile($entityName, $fileName)
  92.     {
  93.         return new self(sprintf(
  94.             "Invalid mapping file '%s' for class '%s'.",
  95.             $fileName,
  96.             $entityName
  97.         ));
  98.     }
  100.     /**
  101.      * @param string $className
  102.      *
  103.      * @return self
  104.      */
  105.     public static function nonExistingClass($className)
  106.     {
  107.         return new self(sprintf("Class '%s' does not exist", $className));
  108.     }
  110.     /**
  111.      * @param class-string $className
  112.      */
  113.     public static function classIsAnonymous(string $className): self
  114.     {
  115.         return new self(sprintf('Class "%s" is anonymous', $className));
  116.     }
  117. }