[Form] Support DateTimeImmutable in transform() #14895
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -72,14 +72,15 @@ public function transform($dateTime) | |||
| ), array_flip($this->fields)); | |||
| } | |||
|
|
|||
| if (!$dateTime instanceof \DateTime) { | |||
| throw new TransformationFailedException('Expected a \DateTime.'); | |||
| // DateTimeInterface was introduced in PHP 5.5.0. | |||
There was a problem hiding this comment.
@Tobion The comment explains why we have to check for both DateTime and DateTimeInterface. DateTime implements DateTimeInterface, so one would think that checking for DateTimeInterface is enough. Don't you think this deserves a comment? Or are you just suggesting that I only add it in one (which?) of the five classes?
There was a problem hiding this comment.
it doesn't deserve a comment because we already have this logic in many other places without a comment.
c960657
force-pushed
the
transformer-datetimeimmutable-2.3
branch
from
bc5ef34
to
2d1b43b
Compare
| } | ||
|
|
||
| $dateTime = clone $dateTime; | ||
| if ($this->inputTimezone !== $this->outputTimezone) { | ||
| try { | ||
| $dateTime->setTimezone(new \DateTimeZone($this->outputTimezone)); | ||
| $dateTime = $dateTime->setTimezone(new \DateTimeZone($this->outputTimezone)); |
There was a problem hiding this comment.
no, it just ensures that immutable datetime works the same as the mutable one (i.e. we want to explicitly set the timezone).
c960657
force-pushed
the
transformer-datetimeimmutable-2.3
branch
from
2d1b43b
to
17346c5
Compare
|
👍 |
|
Thank you @c960657. |
fabpot
added a commit
that referenced
this pull request
Jun 8, 2015
This PR was merged into the 2.3 branch.
Discussion
----------
[Form] Support DateTimeImmutable in transform()
| Q | A
| ------------- | ---
| Bug fix? | yes
| New feature? | yes
| BC breaks? | no
| Deprecations? | no
| Tests pass? | yes
| Fixed tickets |
| License | MIT
| Doc PR |
When passing a DateTimeImmutable instance to DateTimeToLocalizedStringTransformer::transform($dateTime), it throws an exception, `TransformationFailedException('Expected a \DateTime.')`.
The method just converts a date-time object into a string, so there is no reason that it should not support all DateTimeInterface implementations.
DateTimeInterface was added in PHP 5.5, so in order to support earlier versions, we need to do instanceof checks for both DateTime and DateTimeInterface. When Symfony requires PHP 5.5 or larger, we can remove the DateTime check and only check for DateTimeInterface.
This was originally submitted as a PR against the 2.7 branch in #14676.
Commits
-------
17346c5 [Form] Support DateTimeImmutable in transform()
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When passing a DateTimeImmutable instance to DateTimeToLocalizedStringTransformer::transform($dateTime), it throws an exception,
TransformationFailedException('Expected a \DateTime.').The method just converts a date-time object into a string, so there is no reason that it should not support all DateTimeInterface implementations.
DateTimeInterface was added in PHP 5.5, so in order to support earlier versions, we need to do instanceof checks for both DateTime and DateTimeInterface. When Symfony requires PHP 5.5 or larger, we can remove the DateTime check and only check for DateTimeInterface.
This was originally submitted as a PR against the 2.7 branch in #14676.