vendor/doctrine/dbal/src/Exception.php line 18

Open in your IDE?
  1. <?php
  3. namespace Doctrine\DBAL;
  5. use Doctrine\DBAL\Platforms\AbstractPlatform;
  6. use Doctrine\DBAL\Types\Type;
  8. use function get_class;
  9. use function gettype;
  10. use function implode;
  11. use function is_object;
  12. use function spl_object_hash;
  13. use function sprintf;
  15. /**
  16.  * @psalm-immutable
  17.  */
  18. class Exception extends \Exception
  19. {
  20.     public static function notSupported(string $method): self
  21.     {
  22.         return new self(sprintf("Operation '%s' is not supported by platform.", $method));
  23.     }
  25.     /**
  26.      * @param mixed $invalidPlatform
  27.      */
  28.     public static function invalidPlatformType($invalidPlatform): self
  29.     {
  30.         if (is_object($invalidPlatform)) {
  31.             return new self(
  32.                 sprintf(
  33.                     "Option 'platform' must be a subtype of '%s', instance of '%s' given",
  34.                     AbstractPlatform::class,
  35.                     get_class($invalidPlatform)
  36.                 )
  37.             );
  38.         }
  40.         return new self(
  41.             sprintf(
  42.                 "Option 'platform' must be an object and subtype of '%s'. Got '%s'",
  43.                 AbstractPlatform::class,
  44.                 gettype($invalidPlatform)
  45.             )
  46.         );
  47.     }
  49.     /**
  50.      * Returns a new instance for an invalid specified platform version.
  51.      *
  52.      * @param string $version        The invalid platform version given.
  53.      * @param string $expectedFormat The expected platform version format.
  54.      */
  55.     public static function invalidPlatformVersionSpecified(string $version, string $expectedFormat): self
  56.     {
  57.         return new self(
  58.             sprintf(
  59.                 'Invalid platform version "%s" specified. ' .
  60.                 'The platform version has to be specified in the format: "%s".',
  61.                 $version,
  62.                 $expectedFormat
  63.             )
  64.         );
  65.     }
  67.     /**
  68.      * @param string|null $url The URL that was provided in the connection parameters (if any).
  69.      */
  70.     public static function driverRequired(?string $url = null): self
  71.     {
  72.         if ($url !== null) {
  73.             return new self(
  74.                 sprintf(
  75.                     "The options 'driver' or 'driverClass' are mandatory if a connection URL without scheme " .
  76.                     'is given to DriverManager::getConnection(). Given URL: %s',
  77.                     $url
  78.                 )
  79.             );
  80.         }
  82.         return new self("The options 'driver' or 'driverClass' are mandatory if no PDO " .
  83.             'instance is given to DriverManager::getConnection().');
  84.     }
  86.     /**
  87.      * @param string[] $knownDrivers
  88.      */
  89.     public static function unknownDriver(string $unknownDriverName, array $knownDrivers): self
  90.     {
  91.         return new self("The given 'driver' " . $unknownDriverName . ' is unknown, ' .
  92.             'Doctrine currently supports only the following drivers: ' . implode(', ', $knownDrivers));
  93.     }
  95.     public static function invalidWrapperClass(string $wrapperClass): self
  96.     {
  97.         return new self("The given 'wrapperClass' " . $wrapperClass . ' has to be a ' .
  98.             'subtype of \Doctrine\DBAL\Connection.');
  99.     }
  101.     public static function invalidDriverClass(string $driverClass): self
  102.     {
  103.         return new self(
  104.             "The given 'driverClass' " . $driverClass . ' has to implement the ' . Driver::class . ' interface.'
  105.         );
  106.     }
  108.     public static function noColumnsSpecifiedForTable(string $tableName): self
  109.     {
  110.         return new self('No columns specified for table ' . $tableName);
  111.     }
  113.     public static function typeExists(string $name): self
  114.     {
  115.         return new self('Type ' . $name . ' already exists.');
  116.     }
  118.     public static function unknownColumnType(string $name): self
  119.     {
  120.         return new self('Unknown column type "' . $name . '" requested. Any Doctrine type that you use has ' .
  121.             'to be registered with \Doctrine\DBAL\Types\Type::addType(). You can get a list of all the ' .
  122.             'known types with \Doctrine\DBAL\Types\Type::getTypesMap(). If this error occurs during database ' .
  123.             'introspection then you might have forgotten to register all database types for a Doctrine Type. Use ' .
  124.             'AbstractPlatform#registerDoctrineTypeMapping() or have your custom types implement ' .
  125.             'Type#getMappedDatabaseTypes(). If the type name is empty you might ' .
  126.             'have a problem with the cache or forgot some mapping information.');
  127.     }
  129.     public static function typeNotFound(string $name): self
  130.     {
  131.         return new self('Type to be overwritten ' . $name . ' does not exist.');
  132.     }
  134.     public static function typeNotRegistered(Type $type): self
  135.     {
  136.         return new self(
  137.             sprintf('Type of the class %s@%s is not registered.', get_class($type), spl_object_hash($type))
  138.         );
  139.     }
  141.     public static function typeAlreadyRegistered(Type $type): self
  142.     {
  143.         return new self(
  144.             sprintf('Type of the class %s@%s is already registered.', get_class($type), spl_object_hash($type))
  145.         );
  146.     }
  147. }