[Serializer] Add a new DateTime normalizer #17411

dunglas · 2016-01-17T12:23:15Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	n/a
License	MIT
Doc PR	todo

This PR add support for dates and times to the Normalizer component. It supports all date and time formats supported by PHP. Dates and times are normalized in the RFC 3339 format by default. The output format can be customized using the $context parameter. The default format can be changed using a constructor parameter.

Usage:

use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
use Symfony\Component\Serializer\Serializer;

$serializer = new Serializer(array(new DateTimeNormalizer()));

echo $serializer->normalize(new \DateTimeImmutable('2016/01/01'));
// 2016-01-01T00:00:00+00:00

echo $serializer->normalize(new \DateTime('2016/01/01'));
// 2016-01-01T00:00:00+00:00

echo $serializer->normalize(new \DateTime('2016/01/01'), null, array(DateTimeNormalizer::FORMAT_KEY => 'Y'))
// 2016

var_dump($serializer->denormalize('2016-01-01T00:00:00+00:00', \DateTimeInterface::class));
// class DateTimeImmutable#1 (3) {
//   public $date =>
//   string(26) "2016-01-01 00:00:00.000000"
//   public $timezone_type =>
//   int(1)
//   public $timezone =>
//   string(6) "+00:00"
// }

var_dump($serializer->denormalize('2016-01-01T00:00:00+00:00', \DateTime::class));
// class DateTime#1 (3) {
//   public $date =>
//   string(26) "2016-01-01 00:00:00.000000"
//   public $timezone_type =>
//   int(1)
//   public $timezone =>
//   string(6) "+00:00"
// }

Toflar · 2016-01-18T12:58:34Z

src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php

+    public function normalize($object, $format = null, array $context = array())
+    {
+        if (!$object instanceof \DateTimeInterface) {
+            throw new InvalidArgumentException('The object must implements the "\DateTimeInterface".');


[...] implement [...] :-)

GuilhemN · 2016-01-19T21:06:47Z

Amazing! 👍

fabpot · 2016-01-20T11:59:57Z

👍

derrabus · 2016-01-20T14:57:43Z

❤️

stof · 2016-01-20T15:01:45Z

👍

dosten · 2016-01-20T15:53:13Z

src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php

+    {
+        try {
+            return \DateTime::class === $class ? new \DateTime($data) : new \DateTimeImmutable($data);
+        } catch (\Exception $exception) {


You should rename this to $e following this PR #14937

👍 I'll do it before the merge

Ok, I let you manage this.

xabbuh · 2016-01-21T23:51:20Z

👍

Status: Reviewed

This PR was merged into the 3.1-dev branch. Discussion ---------- [Serializer] Add a new DateTime normalizer | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | todo This PR add support for dates and times to the Normalizer component. It supports all date and time formats supported by PHP. Dates and times are normalized in the RFC 3339 format by default. The output format can be customized using the `$context` parameter. The default format can be changed using a constructor parameter. Usage: ```php use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer; use Symfony\Component\Serializer\Serializer; $serializer = new Serializer(array(new DateTimeNormalizer())); echo $serializer->normalize(new \DateTimeImmutable('2016/01/01')); // 2016-01-01T00:00:00+00:00 echo $serializer->normalize(new \DateTime('2016/01/01')); // 2016-01-01T00:00:00+00:00 echo $serializer->normalize(new \DateTime('2016/01/01'), null, array(DateTimeNormalizer::FORMAT_KEY => 'Y')) // 2016 var_dump($serializer->denormalize('2016-01-01T00:00:00+00:00', \DateTimeInterface::class)); // class DateTimeImmutable#1 (3) { // public $date => // string(26) "2016-01-01 00:00:00.000000" // public $timezone_type => // int(1) // public $timezone => // string(6) "+00:00" // } var_dump($serializer->denormalize('2016-01-01T00:00:00+00:00', \DateTime::class)); // class DateTime#1 (3) { // public $date => // string(26) "2016-01-01 00:00:00.000000" // public $timezone_type => // int(1) // public $timezone => // string(6) "+00:00" // } ``` Commits ------- 6749a70 [Serializer] Add a new DateTime normalizer

weaverryan · 2016-02-21T22:17:39Z

src/Symfony/Component/Serializer/Tests/Normalizer/DateTimeNormalizerTest.php

+
+    public function testDenormalize()
+    {
+        $this->assertEquals(new \DateTimeImmutable('2016/01/01'), $this->normalizer->denormalize('2016-01-01T00:00:00+00:00', \DateTimeInterface::class));


So only this one format is supported for denormalize? It feels weird - since normalize allows you to specify a different format. But I personally don't denormalize often

No, denormalize can parse any format supported by \DateTime::__construct(): http://php.net/manual/en/datetime.formats.php

This PR was squashed before being merged into the master branch (closes #6314). Discussion ---------- New normalizers | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes symfony/symfony#17603 symfony/symfony#17411 symfony/symfony#16164 | Applies to | 3.1 | Fixed tickets | Commits ------- 4ff3a28 New normalizers

carsonbot added the Status: Needs Review label Jan 17, 2016

dunglas added the Serializer label Jan 17, 2016

Toflar reviewed Jan 18, 2016
View reviewed changes

dosten reviewed Jan 20, 2016
View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Jan 21, 2016

[Serializer] Add a new DateTime normalizer

6749a70

dunglas force-pushed the normalizer_datetime branch from f49fbc3 to 6749a70 Compare January 22, 2016 07:14

dunglas merged commit 6749a70 into symfony:master Jan 22, 2016

dunglas deleted the normalizer_datetime branch January 22, 2016 07:41

weaverryan reviewed Feb 21, 2016
View reviewed changes

dunglas mentioned this pull request Feb 23, 2016

Use the built-in Symfony DateTimeNormalizer api-platform/core#422

Merged

mcfedr mentioned this pull request Mar 1, 2016

New normalizers symfony/symfony-docs#6314

Closed

fabpot mentioned this pull request May 13, 2016

Release v3.1.0-BETA1 #18776

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] Add a new DateTime normalizer #17411

[Serializer] Add a new DateTime normalizer #17411

dunglas commented Jan 17, 2016

Toflar Jan 18, 2016

GuilhemN commented Jan 19, 2016

fabpot commented Jan 20, 2016

derrabus commented Jan 20, 2016

stof commented Jan 20, 2016

dosten Jan 20, 2016

fabpot Jan 21, 2016

dunglas Jan 21, 2016

fabpot Jan 22, 2016

xabbuh commented Jan 21, 2016

weaverryan Feb 21, 2016

dunglas Feb 22, 2016

[Serializer] Add a new DateTime normalizer #17411

[Serializer] Add a new DateTime normalizer #17411

Conversation

dunglas commented Jan 17, 2016

Toflar Jan 18, 2016

Choose a reason for hiding this comment

GuilhemN commented Jan 19, 2016

fabpot commented Jan 20, 2016

derrabus commented Jan 20, 2016

stof commented Jan 20, 2016

dosten Jan 20, 2016

Choose a reason for hiding this comment

fabpot Jan 21, 2016

Choose a reason for hiding this comment

dunglas Jan 21, 2016

Choose a reason for hiding this comment

fabpot Jan 22, 2016

Choose a reason for hiding this comment

xabbuh commented Jan 21, 2016

weaverryan Feb 21, 2016

Choose a reason for hiding this comment

dunglas Feb 22, 2016

Choose a reason for hiding this comment