annotate vendor/symfony/serializer/Normalizer/DateTimeNormalizer.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Serializer\Normalizer;
Chris@0 13
Chris@0 14 use Symfony\Component\Serializer\Exception\InvalidArgumentException;
Chris@14 15 use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
Chris@0 16
Chris@0 17 /**
Chris@0 18 * Normalizes an object implementing the {@see \DateTimeInterface} to a date string.
Chris@0 19 * Denormalizes a date string to an instance of {@see \DateTime} or {@see \DateTimeImmutable}.
Chris@0 20 *
Chris@0 21 * @author Kévin Dunglas <dunglas@gmail.com>
Chris@0 22 */
Chris@0 23 class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface
Chris@0 24 {
Chris@0 25 const FORMAT_KEY = 'datetime_format';
Chris@14 26 const TIMEZONE_KEY = 'datetime_timezone';
Chris@14 27
Chris@14 28 private $format;
Chris@14 29 private $timezone;
Chris@14 30
Chris@17 31 private static $supportedTypes = [
Chris@14 32 \DateTimeInterface::class => true,
Chris@14 33 \DateTimeImmutable::class => true,
Chris@14 34 \DateTime::class => true,
Chris@17 35 ];
Chris@0 36
Chris@0 37 /**
Chris@14 38 * @param string $format
Chris@14 39 * @param \DateTimeZone|null $timezone
Chris@0 40 */
Chris@14 41 public function __construct($format = \DateTime::RFC3339, \DateTimeZone $timezone = null)
Chris@0 42 {
Chris@0 43 $this->format = $format;
Chris@14 44 $this->timezone = $timezone;
Chris@0 45 }
Chris@0 46
Chris@0 47 /**
Chris@0 48 * {@inheritdoc}
Chris@0 49 *
Chris@0 50 * @throws InvalidArgumentException
Chris@0 51 */
Chris@17 52 public function normalize($object, $format = null, array $context = [])
Chris@0 53 {
Chris@0 54 if (!$object instanceof \DateTimeInterface) {
Chris@0 55 throw new InvalidArgumentException('The object must implement the "\DateTimeInterface".');
Chris@0 56 }
Chris@0 57
Chris@0 58 $format = isset($context[self::FORMAT_KEY]) ? $context[self::FORMAT_KEY] : $this->format;
Chris@14 59 $timezone = $this->getTimezone($context);
Chris@14 60
Chris@14 61 if (null !== $timezone) {
Chris@17 62 $object = clone $object;
Chris@17 63 $object = $object->setTimezone($timezone);
Chris@14 64 }
Chris@0 65
Chris@0 66 return $object->format($format);
Chris@0 67 }
Chris@0 68
Chris@0 69 /**
Chris@0 70 * {@inheritdoc}
Chris@0 71 */
Chris@0 72 public function supportsNormalization($data, $format = null)
Chris@0 73 {
Chris@0 74 return $data instanceof \DateTimeInterface;
Chris@0 75 }
Chris@0 76
Chris@0 77 /**
Chris@0 78 * {@inheritdoc}
Chris@0 79 *
Chris@14 80 * @throws NotNormalizableValueException
Chris@0 81 */
Chris@17 82 public function denormalize($data, $class, $format = null, array $context = [])
Chris@0 83 {
Chris@0 84 $dateTimeFormat = isset($context[self::FORMAT_KEY]) ? $context[self::FORMAT_KEY] : null;
Chris@14 85 $timezone = $this->getTimezone($context);
Chris@14 86
Chris@14 87 if ('' === $data || null === $data) {
Chris@14 88 throw new NotNormalizableValueException('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.');
Chris@14 89 }
Chris@0 90
Chris@0 91 if (null !== $dateTimeFormat) {
Chris@17 92 if (null === $timezone && \PHP_VERSION_ID < 70000) {
Chris@14 93 // https://bugs.php.net/bug.php?id=68669
Chris@14 94 $object = \DateTime::class === $class ? \DateTime::createFromFormat($dateTimeFormat, $data) : \DateTimeImmutable::createFromFormat($dateTimeFormat, $data);
Chris@14 95 } else {
Chris@14 96 $object = \DateTime::class === $class ? \DateTime::createFromFormat($dateTimeFormat, $data, $timezone) : \DateTimeImmutable::createFromFormat($dateTimeFormat, $data, $timezone);
Chris@14 97 }
Chris@0 98
Chris@0 99 if (false !== $object) {
Chris@0 100 return $object;
Chris@0 101 }
Chris@0 102
Chris@0 103 $dateTimeErrors = \DateTime::class === $class ? \DateTime::getLastErrors() : \DateTimeImmutable::getLastErrors();
Chris@0 104
Chris@14 105 throw new NotNormalizableValueException(sprintf(
Chris@0 106 'Parsing datetime string "%s" using format "%s" resulted in %d errors:'."\n".'%s',
Chris@0 107 $data,
Chris@0 108 $dateTimeFormat,
Chris@0 109 $dateTimeErrors['error_count'],
Chris@0 110 implode("\n", $this->formatDateTimeErrors($dateTimeErrors['errors']))
Chris@0 111 ));
Chris@0 112 }
Chris@0 113
Chris@0 114 try {
Chris@14 115 return \DateTime::class === $class ? new \DateTime($data, $timezone) : new \DateTimeImmutable($data, $timezone);
Chris@0 116 } catch (\Exception $e) {
Chris@14 117 throw new NotNormalizableValueException($e->getMessage(), $e->getCode(), $e);
Chris@0 118 }
Chris@0 119 }
Chris@0 120
Chris@0 121 /**
Chris@0 122 * {@inheritdoc}
Chris@0 123 */
Chris@0 124 public function supportsDenormalization($data, $type, $format = null)
Chris@0 125 {
Chris@14 126 return isset(self::$supportedTypes[$type]);
Chris@0 127 }
Chris@0 128
Chris@0 129 /**
Chris@0 130 * Formats datetime errors.
Chris@0 131 *
Chris@0 132 * @return string[]
Chris@0 133 */
Chris@0 134 private function formatDateTimeErrors(array $errors)
Chris@0 135 {
Chris@17 136 $formattedErrors = [];
Chris@0 137
Chris@0 138 foreach ($errors as $pos => $message) {
Chris@0 139 $formattedErrors[] = sprintf('at position %d: %s', $pos, $message);
Chris@0 140 }
Chris@0 141
Chris@0 142 return $formattedErrors;
Chris@0 143 }
Chris@14 144
Chris@14 145 private function getTimezone(array $context)
Chris@14 146 {
Chris@18 147 $dateTimeZone = \array_key_exists(self::TIMEZONE_KEY, $context) ? $context[self::TIMEZONE_KEY] : $this->timezone;
Chris@14 148
Chris@14 149 if (null === $dateTimeZone) {
Chris@14 150 return null;
Chris@14 151 }
Chris@14 152
Chris@14 153 return $dateTimeZone instanceof \DateTimeZone ? $dateTimeZone : new \DateTimeZone($dateTimeZone);
Chris@14 154 }
Chris@0 155 }