Merge pull request #229 from Kharhamel/DatePeriodBug

added a test to document the bug and methods to work around it

Author: Kharhamel

generator/tests/DateTimeImmutableTest.php

@@ -165,4 +165,35 @@ public function testEquals(): void
         $this->assertEquals($phpDateTime, $safeDateTime2);
         $this->assertEquals($safeDateTime1, $safeDateTime2);
     }
+
+    //DatePeriod corrupts our DateTimeImmutable by setting their inner to null.
+    //This bug cannot be solved without editing DatePeriod itself.
+    public function testDatePeriodBug(): void
+    {
+        $start = new \Safe\DateTimeImmutable('2020-01-01');
+        $end = (new \Safe\DateTimeImmutable('2020-01-03'))->modify('+1 day');
+        $datePeriod = new \DatePeriod($start, new \DateInterval('P1D'), $end);
+
+        /** @var DateTimeImmutable $date */
+        foreach ($datePeriod as $date) {
+            $this->expectException(\TypeError::class);
+            $this->assertNull($date->getInnerDateTime());
+        }
+        
+    }
+    
+    public function testSwitchBetweenRegularAndSafe(): void
+    {
+        $d = new \DateTimeImmutable('2019-01-01');
+        $d2 = \Safe\DateTimeImmutable::createFromRegular($d);
+        $d3 = $d2->getInnerDateTime();
+        $this->assertSame($d->format('Y-m-d H:i:s.u'), $d3->format('Y-m-d H:i:s.u'));
+    }
+
+    public function testSwitchBetweenRegularAndSafe2(): void
+    {
+        $d = new \Safe\DateTimeImmutable('2019-01-01');
+        $d2 = \Safe\DateTimeImmutable::createFromRegular($d->getInnerDateTime());
+        $this->assertSame($d->format('Y-m-d H:i:s.u'), $d2->format('Y-m-d H:i:s.u'));
+    }
 }

lib/DateTimeImmutable.php

@@ -32,14 +32,20 @@ public function __construct($time = 'now', $timezone = null)
         $this->innerDateTime = new parent($time, $timezone);
     }
 
-    //switch from regular datetime to safe version
-    private static function createFromRegular(\DateTimeImmutable $datetime): self
+    //switch between regular datetime and safe version
+    public static function createFromRegular(\DateTimeImmutable $datetime): self
     {
         $safeDatetime = new self($datetime->format('Y-m-d H:i:s.u'), $datetime->getTimezone()); //we need to also update the wrapper to not break the operators '<' and '>'
-        $safeDatetime->innerDateTime = $datetime;
+        $safeDatetime->innerDateTime = $datetime; //to make sure we don't lose information because of the format().
         return $safeDatetime;
     }
 
+    //usefull if you need to switch back to regular DateTimeImmutable (for example when using DatePeriod)
+    public function getInnerDateTime(): \DateTimeImmutable
+    {
+        return $this->innerDateTime;
+    }
+
     /////////////////////////////////////////////////////////////////////////////
     // overload functions with false errors