<?php 
 
/* 
 * This file is part of the Symfony package. 
 * 
 * (c) Fabien Potencier <fabien@symfony.com> 
 * 
 * For the full copyright and license information, please view the LICENSE 
 * file that was distributed with this source code. 
 */ 
 
namespace Symfony\Component\Serializer\Normalizer; 
 
use Symfony\Component\PropertyInfo\Type; 
use Symfony\Component\Serializer\Exception\InvalidArgumentException; 
use Symfony\Component\Serializer\Exception\NotNormalizableValueException; 
 
/** 
 * Normalizes an object implementing the {@see \DateTimeInterface} to a date string. 
 * Denormalizes a date string to an instance of {@see \DateTime} or {@see \DateTimeImmutable}. 
 * 
 * @author Kévin Dunglas <dunglas@gmail.com> 
 */ 
class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface 
{ 
    public const FORMAT_KEY = 'datetime_format'; 
    public const TIMEZONE_KEY = 'datetime_timezone'; 
 
    private $defaultContext = [ 
        self::FORMAT_KEY => \DateTime::RFC3339, 
        self::TIMEZONE_KEY => null, 
    ]; 
 
    private const SUPPORTED_TYPES = [ 
        \DateTimeInterface::class => true, 
        \DateTimeImmutable::class => true, 
        \DateTime::class => true, 
    ]; 
 
    public function __construct(array $defaultContext = []) 
    { 
        $this->setDefaultContext($defaultContext); 
    } 
 
    public function setDefaultContext(array $defaultContext): void 
    { 
        $this->defaultContext = array_merge($this->defaultContext, $defaultContext); 
    } 
 
    /** 
     * {@inheritdoc} 
     * 
     * @throws InvalidArgumentException 
     */ 
    public function normalize(mixed $object, string $format = null, array $context = []): string 
    { 
        if (!$object instanceof \DateTimeInterface) { 
            throw new InvalidArgumentException('The object must implement the "\DateTimeInterface".'); 
        } 
 
        $dateTimeFormat = $context[self::FORMAT_KEY] ?? $this->defaultContext[self::FORMAT_KEY]; 
        $timezone = $this->getTimezone($context); 
 
        if (null !== $timezone) { 
            $object = clone $object; 
            $object = $object->setTimezone($timezone); 
        } 
 
        return $object->format($dateTimeFormat); 
    } 
 
    /** 
     * {@inheritdoc} 
     * 
     * @param array $context 
     */ 
    public function supportsNormalization(mixed $data, string $format = null /* , array $context = [] */): bool 
    { 
        return $data instanceof \DateTimeInterface; 
    } 
 
    /** 
     * {@inheritdoc} 
     * 
     * @throws NotNormalizableValueException 
     */ 
    public function denormalize(mixed $data, string $type, string $format = null, array $context = []): \DateTimeInterface 
    { 
        $dateTimeFormat = $context[self::FORMAT_KEY] ?? null; 
        $timezone = $this->getTimezone($context); 
 
        if (null === $data || (\is_string($data) && '' === trim($data))) { 
            throw NotNormalizableValueException::createForUnexpectedDataType('The data is either an empty string or null, you should pass a string that can be parsed with the passed format or a valid DateTime string.', $data, [Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true); 
        } 
 
        if (null !== $dateTimeFormat) { 
            $object = \DateTime::class === $type ? \DateTime::createFromFormat($dateTimeFormat, $data, $timezone) : \DateTimeImmutable::createFromFormat($dateTimeFormat, $data, $timezone); 
 
            if (false !== $object) { 
                return $object; 
            } 
 
            $dateTimeErrors = \DateTime::class === $type ? \DateTime::getLastErrors() : \DateTimeImmutable::getLastErrors(); 
 
            throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('Parsing datetime string "%s" using format "%s" resulted in %d errors: ', $data, $dateTimeFormat, $dateTimeErrors['error_count'])."\n".implode("\n", $this->formatDateTimeErrors($dateTimeErrors['errors'])), $data, [Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true); 
        } 
 
        $defaultDateTimeFormat = $this->defaultContext[self::FORMAT_KEY] ?? null; 
 
        if (null !== $defaultDateTimeFormat) { 
            $object = \DateTime::class === $type ? \DateTime::createFromFormat($defaultDateTimeFormat, $data, $timezone) : \DateTimeImmutable::createFromFormat($defaultDateTimeFormat, $data, $timezone); 
 
            if (false !== $object) { 
                return $object; 
            } 
        } 
 
        try { 
            return \DateTime::class === $type ? new \DateTime($data, $timezone) : new \DateTimeImmutable($data, $timezone); 
        } catch (\Exception $e) { 
            throw NotNormalizableValueException::createForUnexpectedDataType($e->getMessage(), $data, [Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, false, $e->getCode(), $e); 
        } 
    } 
 
    /** 
     * {@inheritdoc} 
     * 
     * @param array $context 
     */ 
    public function supportsDenormalization(mixed $data, string $type, string $format = null /* , array $context = [] */): bool 
    { 
        return isset(self::SUPPORTED_TYPES[$type]); 
    } 
 
    /** 
     * {@inheritdoc} 
     */ 
    public function hasCacheableSupportsMethod(): bool 
    { 
        return __CLASS__ === static::class; 
    } 
 
    /** 
     * Formats datetime errors. 
     * 
     * @return string[] 
     */ 
    private function formatDateTimeErrors(array $errors): array 
    { 
        $formattedErrors = []; 
 
        foreach ($errors as $pos => $message) { 
            $formattedErrors[] = sprintf('at position %d: %s', $pos, $message); 
        } 
 
        return $formattedErrors; 
    } 
 
    private function getTimezone(array $context): ?\DateTimeZone 
    { 
        $dateTimeZone = $context[self::TIMEZONE_KEY] ?? $this->defaultContext[self::TIMEZONE_KEY]; 
 
        if (null === $dateTimeZone) { 
            return null; 
        } 
 
        return $dateTimeZone instanceof \DateTimeZone ? $dateTimeZone : new \DateTimeZone($dateTimeZone); 
    } 
}