vendor/symfony/form/Extension/Core/DataTransformer/DateTimeToLocalizedStringTransformer.php line 129

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Symfony\Component\Form\Extension\Core\DataTransformer;
  14. use Symfony\Component\Form\Exception\TransformationFailedException;
  15. use Symfony\Component\Form\Exception\UnexpectedTypeException;
  17. /**
  18. * Transforms between a normalized time and a localized time string.
  19. *
  20. * @author Bernhard Schussek <bschussek@gmail.com>
  21. * @author Florian Eckerstorfer <florian@eckerstorfer.org>
  22. */
  23. class DateTimeToLocalizedStringTransformer extends BaseDateTimeTransformer
  24. {
  25. private $dateFormat;
  26. private $timeFormat;
  27. private $pattern;
  28. private $calendar;
  30. /**
  31. * @see BaseDateTimeTransformer::formats for available format options
  32. *
  33. * @param string|null $inputTimezone The name of the input timezone
  34. * @param string|null $outputTimezone The name of the output timezone
  35. * @param int|null $dateFormat The date format
  36. * @param int|null $timeFormat The time format
  37. * @param int $calendar One of the \IntlDateFormatter calendar constants
  38. * @param string|null $pattern A pattern to pass to \IntlDateFormatter
  39. *
  40. * @throws UnexpectedTypeException If a format is not supported or if a timezone is not a string
  41. */
  42. public function __construct(?string $inputTimezone = null, ?string $outputTimezone = null, ?int $dateFormat = null, ?int $timeFormat = null, int $calendar = \IntlDateFormatter::GREGORIAN, ?string $pattern = null)
  43. {
  44. parent::__construct($inputTimezone, $outputTimezone);
  46. if (null === $dateFormat) {
  47. $dateFormat = \IntlDateFormatter::MEDIUM;
  48. }
  50. if (null === $timeFormat) {
  51. $timeFormat = \IntlDateFormatter::SHORT;
  52. }
  54. if (!\in_array($dateFormat, self::$formats, true)) {
  55. throw new UnexpectedTypeException($dateFormat, implode('", "', self::$formats));
  56. }
  58. if (!\in_array($timeFormat, self::$formats, true)) {
  59. throw new UnexpectedTypeException($timeFormat, implode('", "', self::$formats));
  60. }
  62. $this->dateFormat = $dateFormat;
  63. $this->timeFormat = $timeFormat;
  64. $this->calendar = $calendar;
  65. $this->pattern = $pattern;
  66. }
  68. /**
  69. * Transforms a normalized date into a localized date string/array.
  70. *
  71. * @param \DateTimeInterface $dateTime A DateTimeInterface object
  72. *
  73. * @return string
  74. *
  75. * @throws TransformationFailedException if the given value is not a \DateTimeInterface
  76. * or if the date could not be transformed
  77. */
  78. public function transform($dateTime)
  79. {
  80. if (null === $dateTime) {
  81. return '';
  82. }
  84. if (!$dateTime instanceof \DateTimeInterface) {
  85. throw new TransformationFailedException('Expected a \DateTimeInterface.');
  86. }
  88. $value = $this->getIntlDateFormatter()->format($dateTime->getTimestamp());
  90. if (0 != intl_get_error_code()) {
  91. throw new TransformationFailedException(intl_get_error_message());
  92. }
  94. return $value;
  95. }
  97. /**
  98. * Transforms a localized date string/array into a normalized date.
  99. *
  100. * @param string|array $value Localized date string/array
  101. *
  102. * @return \DateTime|null
  103. *
  104. * @throws TransformationFailedException if the given value is not a string,
  105. * if the date could not be parsed
  106. */
  107. public function reverseTransform($value)
  108. {
  109. if (!\is_string($value)) {
  110. throw new TransformationFailedException('Expected a string.');
  111. }
  113. if ('' === $value) {
  114. return null;
  115. }
  117. // date-only patterns require parsing to be done in UTC, as midnight might not exist in the local timezone due
  118. // to DST changes
  119. $dateOnly = $this->isPatternDateOnly();
  120. $dateFormatter = $this->getIntlDateFormatter($dateOnly);
  122. try {
  123. $timestamp = @$dateFormatter->parse($value);
  124. } catch (\IntlException $e) {
  125. throw new TransformationFailedException($e->getMessage(), $e->getCode(), $e);
  126. }
  128. if (0 != intl_get_error_code()) {
  129. throw new TransformationFailedException(intl_get_error_message(), intl_get_error_code());
  130. } elseif ($timestamp > 253402214400) {
  131. // This timestamp represents UTC midnight of 9999-12-31 to prevent 5+ digit years
  132. throw new TransformationFailedException('Years beyond 9999 are not supported.');
  133. } elseif (false === $timestamp) {
  134. // the value couldn't be parsed but the Intl extension didn't report an error code, this
  135. // could be the case when the Intl polyfill is used which always returns 0 as the error code
  136. throw new TransformationFailedException(sprintf('"%s" could not be parsed as a date.', $value));
  137. }
  139. try {
  140. if ($dateOnly) {
  141. // we only care about year-month-date, which has been delivered as a timestamp pointing to UTC midnight
  142. $dateTime = new \DateTime(gmdate('Y-m-d', $timestamp), new \DateTimeZone($this->outputTimezone));
  143. } else {
  144. // read timestamp into DateTime object - the formatter delivers a timestamp
  145. $dateTime = new \DateTime(sprintf('@%s', $timestamp));
  146. }
  147. // set timezone separately, as it would be ignored if set via the constructor,
  148. // see https://php.net/datetime.construct
  149. $dateTime->setTimezone(new \DateTimeZone($this->outputTimezone));
  150. } catch (\Exception $e) {
  151. throw new TransformationFailedException($e->getMessage(), $e->getCode(), $e);
  152. }
  154. if ($this->outputTimezone !== $this->inputTimezone) {
  155. $dateTime->setTimezone(new \DateTimeZone($this->inputTimezone));
  156. }
  158. return $dateTime;
  159. }
  161. /**
  162. * Returns a preconfigured IntlDateFormatter instance.
  163. *
  164. * @param bool $ignoreTimezone Use UTC regardless of the configured timezone
  165. *
  166. * @return \IntlDateFormatter
  167. *
  168. * @throws TransformationFailedException in case the date formatter cannot be constructed
  169. */
  170. protected function getIntlDateFormatter(bool $ignoreTimezone = false)
  171. {
  172. $dateFormat = $this->dateFormat;
  173. $timeFormat = $this->timeFormat;
  174. $timezone = new \DateTimeZone($ignoreTimezone ? 'UTC' : $this->outputTimezone);
  176. $calendar = $this->calendar;
  177. $pattern = $this->pattern;
  179. $intlDateFormatter = new \IntlDateFormatter(\Locale::getDefault(), $dateFormat, $timeFormat, $timezone, $calendar, $pattern ?? '');
  181. // new \intlDateFormatter may return null instead of false in case of failure, see https://bugs.php.net/66323
  182. if (!$intlDateFormatter) {
  183. throw new TransformationFailedException(intl_get_error_message(), intl_get_error_code());
  184. }
  186. $intlDateFormatter->setLenient(false);
  188. return $intlDateFormatter;
  189. }
  191. /**
  192. * Checks if the pattern contains only a date.
  193. *
  194. * @return bool
  195. */
  196. protected function isPatternDateOnly()
  197. {
  198. if (null === $this->pattern) {
  199. return false;
  200. }
  202. // strip escaped text
  203. $pattern = preg_replace("#'(.*?)'#", '', $this->pattern);
  205. // check for the absence of time-related placeholders
  206. return 0 === preg_match('#[ahHkKmsSAzZOvVxX]#', $pattern);
  207. }
  208. }