feature #47730 Ban DateTime from the codebase (WebMamba)

This PR was squashed before being merged into the 6.2 branch.

Discussion
----------

Ban DateTime from the codebase

| Q             | A
| ------------- | ---
| Branch?       | 6.2
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | yes
| Tickets       | #47580
| License       | MIT
| Doc PR        | symfony

As discuss in this issue, the purpose of this PR is to remove DateTime from the code base in favor to DateTimeImmutable. I will process it component by component. Feel free to discuss!

Commits
-------

689385a83f Ban DateTime from the codebase

Author: fabpot

Caster/DateCaster.php

@@ -28,7 +28,7 @@ public static function castDateTime(\DateTimeInterface $d, array $a, Stub $stub,
     {
         $prefix = Caster::PREFIX_VIRTUAL;
         $location = $d->getTimezone()->getLocation();
-        $fromNow = (new \DateTime())->diff($d);
+        $fromNow = (new \DateTimeImmutable())->diff($d);
 
         $title = $d->format('l, F j, Y')
             ."\n".self::formatInterval($fromNow).' from now'
@@ -79,7 +79,7 @@ private static function formatInterval(\DateInterval $i): string
     public static function castTimeZone(\DateTimeZone $timeZone, array $a, Stub $stub, bool $isNested, int $filter)
     {
         $location = $timeZone->getLocation();
-        $formatted = (new \DateTime('now', $timeZone))->format($location ? 'e (P)' : 'P');
+        $formatted = (new \DateTimeImmutable('now', $timeZone))->format($location ? 'e (P)' : 'P');
         $title = $location && \extension_loaded('intl') ? \Locale::getDisplayRegion('-'.$location['country_code']) : '';
 
         $z = [Caster::PREFIX_VIRTUAL.'timezone' => new ConstStub($formatted, $title)];

Caster/ResourceCaster.php

@@ -77,7 +77,7 @@ public static function castOpensslX509($h, array $a, Stub $stub, bool $isNested)
         $a += [
             'subject' => new EnumStub(array_intersect_key($info['subject'], ['organizationName' => true, 'commonName' => true])),
             'issuer' => new EnumStub(array_intersect_key($info['issuer'], ['organizationName' => true, 'commonName' => true])),
-            'expiry' => new ConstStub(date(\DateTime::ISO8601, $info['validTo_time_t']), $info['validTo_time_t']),
+            'expiry' => new ConstStub(date(\DateTimeInterface::ISO8601, $info['validTo_time_t']), $info['validTo_time_t']),
             'fingerprint' => new EnumStub([
                 'md5' => new ConstStub(wordwrap(strtoupper(openssl_x509_fingerprint($h, 'md5')), 2, ':', true)),
                 'sha1' => new ConstStub(wordwrap(strtoupper(openssl_x509_fingerprint($h, 'sha1')), 2, ':', true)),

Tests/Caster/DateCasterTest.php

@@ -41,14 +41,30 @@ public function testDumpDateTime($time, $timezone, $xDate, $xTimestamp)
         $this->assertDumpEquals($xDump, $date);
     }
 
+    /**
+     * @dataProvider provideDateTimes
+     */
+    public function testDumpDateTimeImmutable($time, $timezone, $xDate, $xTimestamp)
+    {
+        $date = new \DateTimeImmutable($time, new \DateTimeZone($timezone));
+
+        $xDump = <<<EODUMP
+DateTimeImmutable @$xTimestamp {
+  date: $xDate
+}
+EODUMP;
+
+        $this->assertDumpEquals($xDump, $date);
+    }
+
     /**
      * @dataProvider provideDateTimes
      */
     public function testCastDateTime($time, $timezone, $xDate, $xTimestamp, $xInfos)
     {
         $stub = new Stub();
-        $date = new \DateTime($time, new \DateTimeZone($timezone));
-        $cast = DateCaster::castDateTime($date, Caster::castObject($date, \DateTime::class), $stub, false, 0);
+        $date = new \DateTimeImmutable($time, new \DateTimeZone($timezone));
+        $cast = DateCaster::castDateTime($date, Caster::castObject($date, \DateTimeImmutable::class), $stub, false, 0);
 
         $xDump = <<<EODUMP
 array:1 [
@@ -325,7 +341,7 @@ public function provideTimeZones()
      */
     public function testDumpPeriod($start, $interval, $end, $options, $expected)
     {
-        $p = new \DatePeriod(new \DateTime($start), new \DateInterval($interval), \is_int($end) ? $end : new \DateTime($end), $options);
+        $p = new \DatePeriod(new \DateTimeImmutable($start), new \DateInterval($interval), \is_int($end) ? $end : new \DateTime($end), $options);
 
         $xDump = <<<EODUMP
 DatePeriod {
@@ -341,7 +357,7 @@ public function testDumpPeriod($start, $interval, $end, $options, $expected)
      */
     public function testCastPeriod($start, $interval, $end, $options, $xPeriod, $xDates)
     {
-        $p = new \DatePeriod(new \DateTime($start, new \DateTimeZone('UTC')), new \DateInterval($interval), \is_int($end) ? $end : new \DateTime($end, new \DateTimeZone('UTC')), $options);
+        $p = new \DatePeriod(new \DateTimeImmutable($start, new \DateTimeZone('UTC')), new \DateInterval($interval), \is_int($end) ? $end : new \DateTimeImmutable($end, new \DateTimeZone('UTC')), $options);
         $stub = new Stub();
 
         $cast = DateCaster::castPeriod($p, [], $stub, false, 0);

Tests/Caster/SplCasterTest.php

@@ -159,9 +159,9 @@ public function testCastObjectStorageIsntModified()
     public function testCastObjectStorageDumpsInfo()
     {
         $var = new \SplObjectStorage();
-        $var->attach(new \stdClass(), new \DateTime());
+        $var->attach(new \stdClass(), new \DateTimeImmutable());
 
-        $this->assertDumpMatchesFormat('%ADateTime%A', $var);
+        $this->assertDumpMatchesFormat('%ADateTimeImmutable%A', $var);
     }
 
     public function testCastArrayObject()

Tests/Fixtures/DateTimeChild.php

@@ -2,7 +2,7 @@
 
 namespace Symfony\Component\VarDumper\Tests\Fixtures;
 
-class DateTimeChild extends \DateTime
+class DateTimeChild extends \DateTimeImmutable
 {
     private $addedProperty = 'foo';
 }

Tests/Test/VarDumperTestTraitTest.php

@@ -50,7 +50,7 @@ public function testItCanBeConfigured()
     {
         $this->setUpVarDumper($casters = [
             \DateTimeInterface::class => static function (\DateTimeInterface $date, array $a, Stub $stub): array {
-                $stub->class = 'DateTime';
+                $stub->class = 'DateTimeImmutable';
 
                 return ['date' => $date->format('d/m/Y')];
             },
@@ -63,12 +63,12 @@ public function testItCanBeConfigured()
 [
   1,
   2,
-  DateTime {
+  DateTimeImmutable {
     +date: "09/07/2019"
   }
 ]
 DUMP
-            , [1, 2, new \DateTime('2019-07-09T0:00:00+00:00')]);
+            , [1, 2, new \DateTimeImmutable('2019-07-09T0:00:00+00:00')]);
 
         $this->tearDownVarDumper();