Add toDateTimeImmutable() methods

brick · Oct 29, 2018 · 91a0c9c · 91a0c9c
1 parent 588553c
commit 91a0c9c
Show file tree

Hide file tree

Showing 8 changed files with 92 additions and 0 deletions.
diff --git a/src/LocalDate.php b/src/LocalDate.php
@@ -802,6 +802,14 @@ public function toDateTime() : \DateTime
         return $this->atTime(LocalTime::midnight())->toDateTime();
     }
 
+    /**
+     * @return \DateTimeImmutable
+     */
+    public function toDateTimeImmutable() : \DateTimeImmutable
+    {
+        return \DateTimeImmutable::createFromMutable($this->toDateTime());
+    }
+
     /**
      * Returns the ISO 8601 representation of this LocalDate.
      *

diff --git a/src/LocalDateTime.php b/src/LocalDateTime.php
@@ -911,6 +911,14 @@ public function toDateTime() : \DateTime
         return $this->atTimeZone(TimeZone::utc())->toDateTime();
     }
 
+    /**
+     * @return \DateTimeImmutable
+     */
+    public function toDateTimeImmutable() : \DateTimeImmutable
+    {
+        return \DateTimeImmutable::createFromMutable($this->toDateTime());
+    }
+
     /**
      * @return string
      */

diff --git a/src/LocalTime.php b/src/LocalTime.php
@@ -698,6 +698,14 @@ public function toDateTime() : \DateTime
         return $this->atDate(LocalDate::of(0, 1, 1))->toDateTime();
     }
 
+    /**
+     * @return \DateTimeImmutable
+     */
+    public function toDateTimeImmutable() : \DateTimeImmutable
+    {
+        return \DateTimeImmutable::createFromMutable($this->toDateTime());
+    }
+
     /**
      * Returns this time as a string, such as 10:15.
      *

diff --git a/src/ZonedDateTime.php b/src/ZonedDateTime.php
@@ -911,6 +911,14 @@ public function toDateTime() : \DateTime
         return \DateTime::createFromFormat($format, $dateTime, $dateTimeZone);
     }
 
+    /**
+     * @return \DateTimeImmutable
+     */
+    public function toDateTimeImmutable() : \DateTimeImmutable
+    {
+        return \DateTimeImmutable::createFromMutable($this->toDateTime());
+    }
+
     /**
      * @return string
      */

diff --git a/tests/LocalDateTest.php b/tests/LocalDateTest.php
@@ -1298,6 +1298,21 @@ public function testToDateTime(string $dateTime, string $expected)
         $this->assertSame($expected, $dateTime->format('Y-m-d\TH:i:s.uO'));
     }
 
+    /**
+     * @dataProvider providerToDateTime
+     *
+     * @param string $dateTime The date-time string that will be parse()d by LocalDate.
+     * @param string $expected The expected output from the native DateTime object.
+     */
+    public function testToDateTimeImmutable(string $dateTime, string $expected)
+    {
+        $zonedDateTime = LocalDate::parse($dateTime);
+        $dateTime = $zonedDateTime->toDateTimeImmutable();
+
+        $this->assertInstanceOf(\DateTimeImmutable::class, $dateTime);
+        $this->assertSame($expected, $dateTime->format('Y-m-d\TH:i:s.uO'));
+    }
+
     /**
      * @return array
      */

diff --git a/tests/LocalDateTimeTest.php b/tests/LocalDateTimeTest.php
@@ -1272,6 +1272,21 @@ public function testToDateTime(string $dateTime, string $expected)
         $this->assertSame($expected, $dateTime->format('Y-m-d\TH:i:s.uO'));
     }
 
+    /**
+     * @dataProvider providerToDateTime
+     *
+     * @param string $dateTime The date-time string that will be parse()d by LocalDateTime.
+     * @param string $expected The expected output from the native DateTime object.
+     */
+    public function testToDateTimeImmutable(string $dateTime, string $expected)
+    {
+        $zonedDateTime = LocalDateTime::parse($dateTime);
+        $dateTime = $zonedDateTime->toDateTimeImmutable();
+
+        $this->assertInstanceOf(\DateTimeImmutable::class, $dateTime);
+        $this->assertSame($expected, $dateTime->format('Y-m-d\TH:i:s.uO'));
+    }
+
     /**
      * @return array
      */

diff --git a/tests/LocalTimeTest.php b/tests/LocalTimeTest.php
@@ -1174,6 +1174,21 @@ public function testToDateTime(string $dateTime, string $expected)
         $this->assertSame($expected, $dateTime->format('Y-m-d\TH:i:s.uO'));
     }
 
+    /**
+     * @dataProvider providerToDateTime
+     *
+     * @param string $dateTime The date-time string that will be parse()d by LocalTime.
+     * @param string $expected The expected output from the native DateTime object.
+     */
+    public function testToDateTimeImmutable(string $dateTime, string $expected)
+    {
+        $zonedDateTime = LocalTime::parse($dateTime);
+        $dateTime = $zonedDateTime->toDateTimeImmutable();
+
+        $this->assertInstanceOf(\DateTimeImmutable::class, $dateTime);
+        $this->assertSame($expected, $dateTime->format('Y-m-d\TH:i:s.uO'));
+    }
+
     /**
      * @return array
      */

diff --git a/tests/ZonedDateTimeTest.php b/tests/ZonedDateTimeTest.php
@@ -795,6 +795,21 @@ public function testToDateTime(string $dateTime, string $expected)
         $this->assertSame($expected, $dateTime->format('Y-m-d\TH:i:s.uO'));
     }
 
+    /**
+     * @dataProvider providerToDateTime
+     *
+     * @param string $dateTime The date-time string that will be parse()d by ZonedDateTime.
+     * @param string $expected The expected output from the native DateTime object.
+     */
+    public function testToDateTimeImmutable(string $dateTime, string $expected)
+    {
+        $zonedDateTime = ZonedDateTime::parse($dateTime);
+        $dateTime = $zonedDateTime->toDateTimeImmutable();
+
+        $this->assertInstanceOf(\DateTimeImmutable::class, $dateTime);
+        $this->assertSame($expected, $dateTime->format('Y-m-d\TH:i:s.uO'));
+    }
+
     /**
      * @return array
      */