<?php namespace Doctrine\DBAL; use Doctrine\DBAL\Driver\DriverException as DriverExceptionInterface; use Doctrine\DBAL\Driver\ExceptionConverterDriver; use Doctrine\DBAL\Exception\DriverException; use Doctrine\DBAL\Platforms\AbstractPlatform; use Exception; use Throwable; use function array_map; use function bin2hex; use function get_class; use function gettype; use function implode; use function is_object; use function is_resource; use function is_string; use function json_encode; use function sprintf; use function str_split; class DBALException extends Exception { /** * @param string $method * * @return \Doctrine\DBAL\DBALException */ public static function notSupported($method) { return new self(sprintf("Operation '%s' is not supported by platform.", $method)); } public static function invalidPlatformSpecified() : self { return new self( "Invalid 'platform' option specified, need to give an instance of " . AbstractPlatform::class . '.' ); } /** * @param mixed $invalidPlatform */ public static function invalidPlatformType($invalidPlatform) : self { if (is_object($invalidPlatform)) { return new self( sprintf( "Option 'platform' must be a subtype of '%s', instance of '%s' given", AbstractPlatform::class, get_class($invalidPlatform) ) ); } return new self( sprintf( "Option 'platform' must be an object and subtype of '%s'. Got '%s'", AbstractPlatform::class, gettype($invalidPlatform) ) ); } /** * Returns a new instance for an invalid specified platform version. * * @param string $version The invalid platform version given. * @param string $expectedFormat The expected platform version format. * * @return DBALException */ public static function invalidPlatformVersionSpecified($version, $expectedFormat) { return new self( sprintf( 'Invalid platform version "%s" specified. ' . 'The platform version has to be specified in the format: "%s".', $version, $expectedFormat ) ); } /** * @return \Doctrine\DBAL\DBALException */ public static function invalidPdoInstance() { return new self( "The 'pdo' option was used in DriverManager::getConnection() but no " . 'instance of PDO was given.' ); } /** * @param string|null $url The URL that was provided in the connection parameters (if any). * * @return \Doctrine\DBAL\DBALException */ public static function driverRequired($url = null) { if ($url) { return new self( sprintf( "The options 'driver' or 'driverClass' are mandatory if a connection URL without scheme " . 'is given to DriverManager::getConnection(). Given URL: %s', $url ) ); } return new self("The options 'driver' or 'driverClass' are mandatory if no PDO " . 'instance is given to DriverManager::getConnection().'); } /** * @param string $unknownDriverName * @param string[] $knownDrivers * * @return \Doctrine\DBAL\DBALException */ public static function unknownDriver($unknownDriverName, array $knownDrivers) { return new self("The given 'driver' " . $unknownDriverName . ' is unknown, ' . 'Doctrine currently supports only the following drivers: ' . implode(', ', $knownDrivers)); } /** * @param Exception $driverEx * @param string $sql * @param mixed[] $params * * @return \Doctrine\DBAL\DBALException */ public static function driverExceptionDuringQuery(Driver $driver, Throwable $driverEx, $sql, array $params = []) { $msg = "An exception occurred while executing '" . $sql . "'"; if ($params) { $msg .= ' with params ' . self::formatParameters($params); } $msg .= ":\n\n" . $driverEx->getMessage(); return static::wrapException($driver, $driverEx, $msg); } /** * @param Exception $driverEx * * @return \Doctrine\DBAL\DBALException */ public static function driverException(Driver $driver, Throwable $driverEx) { return static::wrapException($driver, $driverEx, 'An exception occurred in driver: ' . $driverEx->getMessage()); } /** * @param Exception $driverEx * * @return \Doctrine\DBAL\DBALException */ private static function wrapException(Driver $driver, Throwable $driverEx, $msg) { if ($driverEx instanceof DriverException) { return $driverEx; } if ($driver instanceof ExceptionConverterDriver && $driverEx instanceof DriverExceptionInterface) { return $driver->convertException($msg, $driverEx); } return new self($msg, 0, $driverEx); } /** * Returns a human-readable representation of an array of parameters. * This properly handles binary data by returning a hex representation. * * @param mixed[] $params * * @return string */ private static function formatParameters(array $params) { return '[' . implode(', ', array_map(static function ($param) { if (is_resource($param)) { return (string) $param; } $json = @json_encode($param); if (! is_string($json) || $json === 'null' && is_string($param)) { // JSON encoding failed, this is not a UTF-8 string. return '"\x' . implode('\x', str_split(bin2hex($param), 2)) . '"'; } return $json; }, $params)) . ']'; } /** * @param string $wrapperClass * * @return \Doctrine\DBAL\DBALException */ public static function invalidWrapperClass($wrapperClass) { return new self("The given 'wrapperClass' " . $wrapperClass . ' has to be a ' . 'subtype of \Doctrine\DBAL\Connection.'); } /** * @param string $driverClass * * @return \Doctrine\DBAL\DBALException */ public static function invalidDriverClass($driverClass) { return new self("The given 'driverClass' " . $driverClass . ' has to implement the ' . Driver::class . ' interface.'); } /** * @param string $tableName * * @return \Doctrine\DBAL\DBALException */ public static function invalidTableName($tableName) { return new self('Invalid table name specified: ' . $tableName); } /** * @param string $tableName * * @return \Doctrine\DBAL\DBALException */ public static function noColumnsSpecifiedForTable($tableName) { return new self('No columns specified for table ' . $tableName); } /** * @return \Doctrine\DBAL\DBALException */ public static function limitOffsetInvalid() { return new self('Invalid Offset in Limit Query, it has to be larger than or equal to 0.'); } /** * @param string $name * * @return \Doctrine\DBAL\DBALException */ public static function typeExists($name) { return new self('Type ' . $name . ' already exists.'); } /** * @param string $name * * @return \Doctrine\DBAL\DBALException */ public static function unknownColumnType($name) { return new self('Unknown column type "' . $name . '" requested. Any Doctrine type that you use has ' . 'to be registered with \Doctrine\DBAL\Types\Type::addType(). You can get a list of all the ' . 'known types with \Doctrine\DBAL\Types\Type::getTypesMap(). If this error occurs during database ' . 'introspection then you might have forgotten to register all database types for a Doctrine Type. Use ' . 'AbstractPlatform#registerDoctrineTypeMapping() or have your custom types implement ' . 'Type#getMappedDatabaseTypes(). If the type name is empty you might ' . 'have a problem with the cache or forgot some mapping information.'); } /** * @param string $name * * @return \Doctrine\DBAL\DBALException */ public static function typeNotFound($name) { return new self('Type to be overwritten ' . $name . ' does not exist.'); } }