Support DateTimeInterface in IntlDateFormatter::format

pierredup · pierredup · commit 73044d6a3afb · 2019-08-05T12:19:56.000+02:00
diff --git a/src/Symfony/Component/Intl/DateFormatter/IntlDateFormatter.php b/src/Symfony/Component/Intl/DateFormatter/IntlDateFormatter.php
@@ -176,7 +176,7 @@ public static function create($locale, $datetype, $timetype, $timezone = null, $
     /**
      * Format the date/time value (timestamp) as a string.
      *
-     * @param int|\DateTime $timestamp The timestamp to format
+     * @param int|\DateTimeInterface $timestamp The timestamp to format
      *
      * @return string|bool The formatted value or false if formatting failed
      *
@@ -195,7 +195,7 @@ public function format($timestamp)
 
         // behave like the intl extension
         $argumentError = null;
-        if (!\is_int($timestamp) && !$timestamp instanceof \DateTime) {
+        if (!\is_int($timestamp) && !$timestamp instanceof \DateTimeInterface) {
             $argumentError = sprintf('datefmt_format: string \'%s\' is not numeric, which would be required for it to be a valid date', $timestamp);
         }
 
@@ -207,7 +207,7 @@ public function format($timestamp)
             return false;
         }
 
-        if ($timestamp instanceof \DateTime) {
+        if ($timestamp instanceof \DateTimeInterface) {
             $timestamp = $timestamp->getTimestamp();
         }
 
diff --git a/src/Symfony/Component/Intl/Tests/DateFormatter/AbstractIntlDateFormatterTest.php b/src/Symfony/Component/Intl/Tests/DateFormatter/AbstractIntlDateFormatterTest.php
@@ -76,6 +76,7 @@ public function testFormat($pattern, $timestamp, $expected)
     public function formatProvider()
     {
         $dateTime = new \DateTime('@0');
+        $dateTimeImmutable = new \DateTimeImmutable('@0');
 
         $formatData = [
             /* general */
@@ -250,6 +251,12 @@ public function formatProvider()
         $formatData[] = ['h:mm a', $dateTime, '12:00 AM'];
         $formatData[] = ['yyyyy.MMMM.dd hh:mm aaa', $dateTime, '01970.January.01 12:00 AM'];
 
+        /* general, DateTimeImmutable */
+        $formatData[] = ['y-M-d', $dateTimeImmutable, '1970-1-1'];
+        $formatData[] = ["EEE, MMM d, ''yy", $dateTimeImmutable, "Thu, Jan 1, '70"];
+        $formatData[] = ['h:mm a', $dateTimeImmutable, '12:00 AM'];
+        $formatData[] = ['yyyyy.MMMM.dd hh:mm aaa', $dateTimeImmutable, '01970.January.01 12:00 AM'];
+
         if (IcuVersion::compare(Intl::getIcuVersion(), '59.1', '>=', 1)) {
             // Before ICU 59.1 GMT was used instead of UTC
             $formatData[] = ["yyyy.MM.dd 'at' HH:mm:ss zzz", 0, '1970.01.01 at 00:00:00 UTC'];
@@ -269,6 +276,8 @@ public function testFormatUtcAndGmtAreSplit()
 
         $this->assertSame('1970.01.01 at 00:00:00 GMT', $gmtFormatter->format(new \DateTime('@0')));
         $this->assertSame('1970.01.01 at 00:00:00 UTC', $utcFormatter->format(new \DateTime('@0')));
+        $this->assertSame('1970.01.01 at 00:00:00 GMT', $gmtFormatter->format(new \DateTimeImmutable('@0')));
+        $this->assertSame('1970.01.01 at 00:00:00 UTC', $utcFormatter->format(new \DateTimeImmutable('@0')));
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -176,7 +176,7 @@ public static function create($locale, $datetype, $timetype, $timezone = null, $`
`176`	`176`	`/**`
`177`	`177`	`* Format the date/time value (timestamp) as a string.`
`178`	`178`	`*`
`179`		`- * @param int\|\DateTime $timestamp The timestamp to format`
	`179`	`+ * @param int\|\DateTimeInterface $timestamp The timestamp to format`
`180`	`180`	`*`
`181`	`181`	`* @return string\|bool The formatted value or false if formatting failed`
`182`	`182`	`*`
`@@ -195,7 +195,7 @@ public function format($timestamp)`
`195`	`195`
`196`	`196`	`// behave like the intl extension`
`197`	`197`	`$argumentError = null;`
`198`		`- if (!\is_int($timestamp) && !$timestamp instanceof \DateTime) {`
	`198`	`+ if (!\is_int($timestamp) && !$timestamp instanceof \DateTimeInterface) {`
`199`	`199`	`$argumentError = sprintf('datefmt_format: string \'%s\' is not numeric, which would be required for it to be a valid date', $timestamp);`
`200`	`200`	`}`
`201`	`201`
`@@ -207,7 +207,7 @@ public function format($timestamp)`
`207`	`207`	`return false;`
`208`	`208`	`}`
`209`	`209`
`210`		`- if ($timestamp instanceof \DateTime) {`
	`210`	`+ if ($timestamp instanceof \DateTimeInterface) {`
`211`	`211`	`$timestamp = $timestamp->getTimestamp();`
`212`	`212`	`}`
`213`	`213`