VarDateTimeImmutableType.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

VarDateTimeImmutableType.php
View Options

	<?php

	namespace Doctrine\DBAL\Types;

	use DateTimeImmutable;
	use Doctrine\DBAL\Platforms\AbstractPlatform;
	use Doctrine\Deprecations\Deprecation;
	use Exception;

	/**
	* Immutable type of {@see VarDateTimeType}.
	*/
	class VarDateTimeImmutableType extends VarDateTimeType
	{
	/**
	* {@inheritDoc}
	*/
	public function getName()
	{
	return Types::DATETIME_IMMUTABLE;
	}

	/**
	* {@inheritDoc}
	*
	* @param T $value
	*
	* @return (T is null ? null : string)
	*
	* @template T
	*/
	public function convertToDatabaseValue($value, AbstractPlatform $platform)
	{
	if ($value === null) {
	return $value;
	}

	if ($value instanceof DateTimeImmutable) {
	return $value->format($platform->getDateTimeFormatString());
	}

	throw ConversionException::conversionFailedInvalidType(
	$value,
	$this->getName(),
	['null', DateTimeImmutable::class],
	);
	}

	/**
	* {@inheritDoc}
	*
	* @param T $value
	*
	* @return (T is null ? null : DateTimeImmutable)
	*
	* @template T
	*/
	public function convertToPHPValue($value, AbstractPlatform $platform)
	{
	if ($value === null \|\| $value instanceof DateTimeImmutable) {
	return $value;
	}

	try {
	$dateTime = new DateTimeImmutable($value);
	} catch (Exception $e) {
	throw ConversionException::conversionFailed($value, $this->getName(), $e);
	}

	return $dateTime;
	}

	/**
	* {@inheritDoc}
	*
	* @deprecated
	*/
	public function requiresSQLCommentHint(AbstractPlatform $platform)
	{
	Deprecation::triggerIfCalledFromOutside(
	'doctrine/dbal',
	'https://github.com/doctrine/dbal/pull/5509',
	'%s is deprecated.',
	__METHOD__,
	);

	return true;
	}
	}