vendor/doctrine/dbal/src/Types/ConversionException.php line 25

  1. <?php
  3. namespace Doctrine\DBAL\Types;
  5. use Doctrine\DBAL\Exception;
  6. use Throwable;
  8. use function func_get_arg;
  9. use function func_num_args;
  10. use function get_class;
  11. use function gettype;
  12. use function implode;
  13. use function is_object;
  14. use function is_scalar;
  15. use function sprintf;
  16. use function strlen;
  17. use function substr;
  18. use function var_export;
  20. /**
  21.  * Conversion Exception is thrown when the database to PHP conversion fails.
  22.  *
  23.  * @psalm-immutable
  24.  */
  25. class ConversionException extends Exception
  26. {
  27.     /**
  28.      * Thrown when a Database to Doctrine Type Conversion fails.
  29.      *
  30.      * @param mixed  $value
  31.      * @param string $toType
  32.      *
  33.      * @return ConversionException
  34.      */
  35.     public static function conversionFailed($value, $toType, ?Throwable $previous = null)
  36.     {
  37.         $value = strlen($value) > 32 ? substr($value, 0, 20) . '...' : $value;
  39.         return new self('Could not convert database value "' . $value . '" to Doctrine Type ' . $toType, 0, $previous);
  40.     }
  42.     /**
  43.      * Thrown when a Database to Doctrine Type Conversion fails and we can make a statement
  44.      * about the expected format.
  45.      *
  46.      * @param mixed  $value
  47.      * @param string $toType
  48.      * @param string $expectedFormat
  49.      *
  50.      * @return ConversionException
  51.      */
  52.     public static function conversionFailedFormat($value, $toType, $expectedFormat, ?Throwable $previous = null)
  53.     {
  54.         $value = strlen($value) > 32 ? substr($value, 0, 20) . '...' : $value;
  56.         return new self(
  57.             'Could not convert database value "' . $value . '" to Doctrine Type ' .
  58.             $toType . '. Expected format: ' . $expectedFormat,
  59.             0,
  60.             $previous,
  61.         );
  62.     }
  64.     /**
  65.      * Thrown when the PHP value passed to the converter was not of the expected type.
  66.      *
  67.      * @param mixed    $value
  68.      * @param string   $toType
  69.      * @param string[] $possibleTypes
  70.      *
  71.      * @return ConversionException
  72.      */
  73.     public static function conversionFailedInvalidType(
  74.         $value,
  75.         $toType,
  76.         array $possibleTypes,
  77.         ?Throwable $previous = null
  78.     ) {
  79.         if (is_scalar($value) || $value === null) {
  80.             return new self(sprintf(
  81.                 'Could not convert PHP value %s to type %s. Expected one of the following types: %s',
  82.                 var_export($value, true),
  83.                 $toType,
  84.                 implode(', ', $possibleTypes),
  85.             ), 0, $previous);
  86.         }
  88.         return new self(sprintf(
  89.             'Could not convert PHP value of type %s to type %s. Expected one of the following types: %s',
  90.             is_object($value) ? get_class($value) : gettype($value),
  91.             $toType,
  92.             implode(', ', $possibleTypes),
  93.         ), 0, $previous);
  94.     }
  96.     /**
  97.      * @param mixed  $value
  98.      * @param string $format
  99.      * @param string $error
  100.      *
  101.      * @return ConversionException
  102.      */
  103.     public static function conversionFailedSerialization($value, $format, $error /*, ?Throwable $previous = null */)
  104.     {
  105.         $actualType = is_object($value) ? get_class($value) : gettype($value);
  107.         return new self(sprintf(
  108.             "Could not convert PHP type '%s' to '%s', as an '%s' error was triggered by the serialization",
  109.             $actualType,
  110.             $format,
  111.             $error,
  112.         ), 0, func_num_args() >= 4 ? func_get_arg(3) : null);
  113.     }
  115.     public static function conversionFailedUnserialization(string $format, string $error): self
  116.     {
  117.         return new self(sprintf(
  118.             "Could not convert database value to '%s' as an error was triggered by the unserialization: '%s'",
  119.             $format,
  120.             $error,
  121.         ));
  122.     }
  123. }