Skip to content

[Serializer] Allow custom timezone in DateTimeNormalizer during denormalization #60153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 6 commits into
base: 7.3
Choose a base branch
from
Open

[Serializer] Allow custom timezone in DateTimeNormalizer during denormalization #60153

wants to merge 6 commits into from

Conversation

frankdekker
Copy link

@frankdekker frankdekker commented Apr 5, 2025 •
edited
Loading

Q A
Branch? 7.3
Bug fix? no
New feature? yes
Deprecations? no
Issues Fix #59807
License MIT

By default the DateTimeNormalizer will denormalize timestamps and date strings that include a timezone to DateTime objects with respective timezone UTC or the timezone from the date string. Even with the context key TIMEZONE_KEY set, the timezone from the input superceeds the context timezone.

This PR allows to set PRESERVE_CONTEXT_TIMEZONE_KEY context to true (default: false), which in combination with TIMEZONE_KEY will set the Timezone of the denormalized DateTimes to the given timezone. The timezone from the input will be overwritten.

Documentation

symfony/symfony-docs#20860

@frankdekker frankdekker requested a review from dunglas as a code owner April 5, 2025 10:01
@carsonbot carsonbot added this to the 7.3 milestone Apr 5, 2025
@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 7.3 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@carsonbot carsonbot changed the title [WIP][Serializer] Allow custom timezone in DateTimeNormalizer during denormalization [Serializer] [WIP] Allow custom timezone in DateTimeNormalizer during denormalization Apr 5, 2025
@frankdekker frankdekker mentioned this pull request Apr 5, 2025
Open
@frankdekker frankdekker changed the title [Serializer] [WIP] Allow custom timezone in DateTimeNormalizer during denormalization [Serializer] Allow custom timezone in DateTimeNormalizer during denormalization Apr 5, 2025
@frankdekker
Copy link
Author

Possibility of lowering complexity:

There are currently 2 similar blocks of code for $dateTimeFormat and $defaultDateTimeFormat. The first with a bit more error handling. These blocks could be combined with using the dateTimeFormat in something like $dateTimeFormat ?? $defaultDateTimeFormat ?? null.

I was hesistant to do this immediately because i have no idea why there is different error handling for the context $dateTimeFormat.

@OskarStark OskarStark changed the title [Serializer] Allow custom timezone in DateTimeNormalizer during denormalization [Serializer] Allow custom timezone in DateTimeNormalizer during denormalization Apr 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mtarld mtarld mtarld left review comments

@dunglas dunglas Awaiting requested review from dunglas dunglas is a code owner

Assignees
No one assigned
Labels
Feature Serializer Status: Needs Review Status: Needs Work
Projects
None yet
Milestone
7.3
Development

Successfully merging this pull request may close these issues.

[Serializer] Allow custom timezone in DateTimeNormalizer during denormalization
3 participants
@frankdekker @carsonbot @mtarld