vendor/symfony/form/Extension/Core/DataTransformer/DateTimeToStringTransformer.php line 111

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;
  16. /**
  17. * Transforms between a date string and a DateTime object.
  18. *
  19. * @author Bernhard Schussek <bschussek@gmail.com>
  20. * @author Florian Eckerstorfer <florian@eckerstorfer.org>
  21. */
  22. class DateTimeToStringTransformer extends BaseDateTimeTransformer
  23. {
  24. /**
  25. * Format used for generating strings.
  26. *
  27. * @var string
  28. */
  29. private $generateFormat;
  31. /**
  32. * Format used for parsing strings.
  33. *
  34. * Different than the {@link $generateFormat} because formats for parsing
  35. * support additional characters in PHP that are not supported for
  36. * generating strings.
  37. *
  38. * @var string
  39. */
  40. private $parseFormat;
  42. /**
  43. * Transforms a \DateTime instance to a string.
  44. *
  45. * @see \DateTime::format() for supported formats
  46. *
  47. * @param string|null $inputTimezone The name of the input timezone
  48. * @param string|null $outputTimezone The name of the output timezone
  49. * @param string $format The date format
  50. * @param string|null $parseFormat The parse format when different from $format
  51. */
  52. public function __construct(?string $inputTimezone = null, ?string $outputTimezone = null, string $format = 'Y-m-d H:i:s', ?string $parseFormat = null)
  53. {
  54. parent::__construct($inputTimezone, $outputTimezone);
  56. $this->generateFormat = $format;
  57. $this->parseFormat = $parseFormat ?? $format;
  59. // See https://php.net/datetime.createfromformat
  60. // The character "|" in the format makes sure that the parts of a date
  61. // that are *not* specified in the format are reset to the corresponding
  62. // values from 1970-01-01 00:00:00 instead of the current time.
  63. // Without "|" and "Y-m-d", "2010-02-03" becomes "2010-02-03 12:32:47",
  64. // where the time corresponds to the current server time.
  65. // With "|" and "Y-m-d", "2010-02-03" becomes "2010-02-03 00:00:00",
  66. // which is at least deterministic and thus used here.
  67. if (!str_contains($this->parseFormat, '|')) {
  68. $this->parseFormat .= '|';
  69. }
  70. }
  72. /**
  73. * Transforms a DateTime object into a date string with the configured format
  74. * and timezone.
  75. *
  76. * @param \DateTimeInterface $dateTime A DateTimeInterface object
  77. *
  78. * @return string
  79. *
  80. * @throws TransformationFailedException If the given value is not a \DateTimeInterface
  81. */
  82. public function transform($dateTime)
  83. {
  84. if (null === $dateTime) {
  85. return '';
  86. }
  88. if (!$dateTime instanceof \DateTimeInterface) {
  89. throw new TransformationFailedException('Expected a \DateTimeInterface.');
  90. }
  92. if (!$dateTime instanceof \DateTimeImmutable) {
  93. $dateTime = clone $dateTime;
  94. }
  96. $dateTime = $dateTime->setTimezone(new \DateTimeZone($this->outputTimezone));
  98. return $dateTime->format($this->generateFormat);
  99. }
  101. /**
  102. * Transforms a date string in the configured timezone into a DateTime object.
  103. *
  104. * @param string $value A value as produced by PHP's date() function
  105. *
  106. * @return \DateTime|null
  107. *
  108. * @throws TransformationFailedException If the given value is not a string,
  109. * or could not be transformed
  110. */
  111. public function reverseTransform($value)
  112. {
  113. if (empty($value)) {
  114. return null;
  115. }
  117. if (!\is_string($value)) {
  118. throw new TransformationFailedException('Expected a string.');
  119. }
  121. if (str_contains($value, "\0")) {
  122. throw new TransformationFailedException('Null bytes not allowed');
  123. }
  125. $outputTz = new \DateTimeZone($this->outputTimezone);
  126. $dateTime = \DateTime::createFromFormat($this->parseFormat, $value, $outputTz);
  128. $lastErrors = \DateTime::getLastErrors() ?: ['error_count' => 0, 'warning_count' => 0];
  130. if (0 < $lastErrors['warning_count'] || 0 < $lastErrors['error_count']) {
  131. throw new TransformationFailedException(implode(', ', array_merge(array_values($lastErrors['warnings']), array_values($lastErrors['errors']))));
  132. }
  134. try {
  135. if ($this->inputTimezone !== $this->outputTimezone) {
  136. $dateTime->setTimezone(new \DateTimeZone($this->inputTimezone));
  137. }
  138. } catch (\Exception $e) {
  139. throw new TransformationFailedException($e->getMessage(), $e->getCode(), $e);
  140. }
  142. return $dateTime;
  143. }
  144. }