vendor/doctrine/dbal/src/Types/DateTimeImmutableType.php line 27

  1. <?php
  3. namespace Doctrine\DBAL\Types;
  5. use DateTimeImmutable;
  6. use Doctrine\DBAL\Platforms\AbstractPlatform;
  7. use Doctrine\Deprecations\Deprecation;
  9. use function date_create_immutable;
  11. /**
  12.  * Immutable type of {@see DateTimeType}.
  13.  */
  14. class DateTimeImmutableType extends DateTimeType
  15. {
  16.     /**
  17.      * {@inheritdoc}
  18.      */
  19.     public function getName()
  20.     {
  21.         return Types::DATETIME_IMMUTABLE;
  22.     }
  24.     /**
  25.      * {@inheritdoc}
  26.      */
  27.     public function convertToDatabaseValue($value, AbstractPlatform $platform)
  28.     {
  29.         if ($value === null) {
  30.             return $value;
  31.         }
  33.         if ($value instanceof DateTimeImmutable) {
  34.             return $value->format($platform->getDateTimeFormatString());
  35.         }
  37.         throw ConversionException::conversionFailedInvalidType(
  38.             $value,
  39.             $this->getName(),
  40.             ['null', DateTimeImmutable::class],
  41.         );
  42.     }
  44.     /**
  45.      * {@inheritdoc}
  46.      */
  47.     public function convertToPHPValue($value, AbstractPlatform $platform)
  48.     {
  49.         if ($value === null || $value instanceof DateTimeImmutable) {
  50.             return $value;
  51.         }
  53.         $dateTime = DateTimeImmutable::createFromFormat($platform->getDateTimeFormatString(), $value);
  55.         if ($dateTime === false) {
  56.             $dateTime = date_create_immutable($value);
  57.         }
  59.         if ($dateTime === false) {
  60.             throw ConversionException::conversionFailedFormat(
  61.                 $value,
  62.                 $this->getName(),
  63.                 $platform->getDateTimeFormatString(),
  64.             );
  65.         }
  67.         return $dateTime;
  68.     }
  70.     /**
  71.      * {@inheritdoc}
  72.      *
  73.      * @deprecated
  74.      */
  75.     public function requiresSQLCommentHint(AbstractPlatform $platform)
  76.     {
  77.         Deprecation::triggerIfCalledFromOutside(
  78.             'doctrine/dbal',
  79.             'https://github.com/doctrine/dbal/pull/5509',
  80.             '%s is deprecated.',
  81.             __METHOD__,
  82.         );
  84.         return true;
  85.     }
  86. }