Add toISOString() methods (same as __toString()).

brick · Oct 2, 2023 · 8109088 · 8109088
1 parent 1640dac
commit 8109088
Show file tree

Hide file tree

Showing 28 changed files with 420 additions and 47 deletions.
diff --git a/src/Duration.php b/src/Duration.php
@@ -761,6 +761,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     /**
      * Returns an ISO-8601 string representation of this duration.
      *

diff --git a/src/Instant.php b/src/Instant.php
@@ -373,6 +373,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     public function __toString(): string
     {
         return (string) ZonedDateTime::ofInstant($this, TimeZone::utc());

diff --git a/src/Interval.php b/src/Interval.php
@@ -145,6 +145,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     public function __toString(): string
     {
         return $this->start . '/' . $this->end;

diff --git a/src/LocalDate.php b/src/LocalDate.php
@@ -754,6 +754,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     /**
      * Returns the ISO 8601 representation of this LocalDate.
      */

diff --git a/src/LocalDateRange.php b/src/LocalDateRange.php
@@ -259,6 +259,14 @@ public function toNativeDatePeriod(): DatePeriod
         return new DatePeriod($start, $interval, $end);
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     /**
      * Returns an ISO 8601 string representation of this date range.
      */

diff --git a/src/LocalDateTime.php b/src/LocalDateTime.php
@@ -723,6 +723,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     public function __toString(): string
     {
         return $this->date . 'T' . $this->time;

diff --git a/src/LocalTime.php b/src/LocalTime.php
@@ -647,6 +647,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     /**
      * Returns this time as a string, such as 10:15.
      *

diff --git a/src/MonthDay.php b/src/MonthDay.php
@@ -233,6 +233,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     public function __toString(): string
     {
         return sprintf('--%02d-%02d', $this->month, $this->day);

diff --git a/src/Period.php b/src/Period.php
@@ -384,6 +384,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     public function __toString(): string
     {
         if ($this->isZero()) {

diff --git a/src/Year.php b/src/Year.php
@@ -243,6 +243,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     public function __toString(): string
     {
         return (string) $this->year;

diff --git a/src/YearMonth.php b/src/YearMonth.php
@@ -295,6 +295,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     /**
      * Returns the ISO 8601 representation of this YearMonth.
      */

diff --git a/src/YearMonthRange.php b/src/YearMonthRange.php
@@ -187,6 +187,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     /**
      * Returns a string representation of this year-month range.
      *

diff --git a/src/YearWeek.php b/src/YearWeek.php
@@ -269,6 +269,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     public function __toString(): string
     {
         $pattern = ($this->year < 0 ? '%05d' : '%04d') . '-W%02d';

diff --git a/src/ZonedDateTime.php b/src/ZonedDateTime.php
@@ -717,6 +717,14 @@ public function jsonSerialize(): string
         return (string) $this;
     }
 
+    /**
+     * {@see __toString()}.
+     */
+    public function toISOString(): string
+    {
+        return (string) $this;
+    }
+
     public function __toString(): string
     {
         $string = $this->localDateTime . $this->timeZoneOffset;

diff --git a/tests/DurationTest.php b/tests/DurationTest.php
@@ -1282,6 +1282,14 @@ public function testJsonSerialize(int $seconds, int $nanos, string $expected): v
         self::assertSame(json_encode($expected), json_encode(Duration::ofSeconds($seconds, $nanos)));
     }
 
+    /**
+     * @dataProvider providerToString
+     */
+    public function testToISOString(int $seconds, int $nanos, string $expected): void
+    {
+        self::assertSame($expected, Duration::ofSeconds($seconds, $nanos)->toISOString());
+    }
+
     /**
      * @dataProvider providerToString
      */

diff --git a/tests/InstantTest.php b/tests/InstantTest.php
@@ -645,6 +645,18 @@ public function testJsonSerialize(int $epochSecond, int $nano, string $expectedS
         self::assertSame(json_encode($expectedString), json_encode(Instant::of($epochSecond, $nano)));
     }
 
+    /**
+     * @dataProvider providerToString
+     *
+     * @param int    $epochSecond    The epoch second to test.
+     * @param int    $nano           The nano adjustment to the epoch second.
+     * @param string $expectedString The expected string output.
+     */
+    public function testToISOString(int $epochSecond, int $nano, string $expectedString): void
+    {
+        self::assertSame($expectedString, Instant::of($epochSecond, $nano)->toISOString());
+    }
+
     /**
      * @dataProvider providerToString
      *

diff --git a/tests/IntervalTest.php b/tests/IntervalTest.php
@@ -260,23 +260,44 @@ public function providerIsEqualTo(): array
         ];
     }
 
-    public function testJsonSerialize(): void
+    /** @dataProvider providerToString */
+    public function testJsonSerialize(int $epochSecondStart, int $epochSecondEnd, string $expectedString): void
     {
         $interval = Interval::of(
-            Instant::of(1000000000),
-            Instant::of(2000000000)
+            Instant::of($epochSecondStart),
+            Instant::of($epochSecondEnd)
         );
 
-        self::assertSame(json_encode('2001-09-09T01:46:40Z/2033-05-18T03:33:20Z'), json_encode($interval));
+        self::assertSame(json_encode($expectedString), json_encode($interval));
     }
 
-    public function testToString(): void
+    /** @dataProvider providerToString */
+    public function testToISOString(int $epochSecondStart, int $epochSecondEnd, string $expectedString): void
     {
         $interval = Interval::of(
-            Instant::of(1000000000),
-            Instant::of(2000000000)
+            Instant::of($epochSecondStart),
+            Instant::of($epochSecondEnd)
         );
 
-        self::assertSame('2001-09-09T01:46:40Z/2033-05-18T03:33:20Z', (string) $interval);
+        self::assertSame($expectedString, $interval->toISOString());
+    }
+
+    /** @dataProvider providerToString */
+    public function testToString(int $epochSecondStart, int $epochSecondEnd, string $expectedString): void
+    {
+        $interval = Interval::of(
+            Instant::of($epochSecondStart),
+            Instant::of($epochSecondEnd)
+        );
+
+        self::assertSame($expectedString, (string) $interval);
+    }
+
+    public function providerToString(): array
+    {
+        return [
+            [1000000000, 1000000000, '2001-09-09T01:46:40Z/2001-09-09T01:46:40Z'],
+            [1000000000, 2000000000, '2001-09-09T01:46:40Z/2033-05-18T03:33:20Z'],
+        ];
     }
 }
diff --git a/tests/LocalDateRangeTest.php b/tests/LocalDateRangeTest.php
@@ -189,20 +189,66 @@ public function providerCount(): array
         ];
     }
 
-    public function testJsonSerialize(): void
-    {
-        self::assertSame(json_encode('2008-12-31/2011-01-01'), json_encode(LocalDateRange::of(
-            LocalDate::of(2008, 12, 31),
-            LocalDate::of(2011, 1, 1)
-        )));
+    /** @dataProvider providerToString */
+    public function testJsonSerialize(
+        int $yearStart,
+        int $monthStart,
+        int $dayStart,
+        int $yearEnd,
+        int $monthEnd,
+        int $dayEnd,
+        string $expectedString
+    ): void {
+        $dateRange = LocalDateRange::of(
+            LocalDate::of($yearStart, $monthStart, $dayStart),
+            LocalDate::of($yearEnd, $monthEnd, $dayEnd)
+        );
+
+        self::assertSame(json_encode($expectedString), json_encode($dateRange));
+    }
+
+    /** @dataProvider providerToString */
+    public function testToISOString(
+        int $yearStart,
+        int $monthStart,
+        int $dayStart,
+        int $yearEnd,
+        int $monthEnd,
+        int $dayEnd,
+        string $expectedString
+    ): void {
+        $dateRange = LocalDateRange::of(
+            LocalDate::of($yearStart, $monthStart, $dayStart),
+            LocalDate::of($yearEnd, $monthEnd, $dayEnd)
+        );
+
+        self::assertSame($expectedString, $dateRange->toISOString());
     }
 
-    public function testToString(): void
+    /** @dataProvider providerToString */
+    public function testToString(
+        int $yearStart,
+        int $monthStart,
+        int $dayStart,
+        int $yearEnd,
+        int $monthEnd,
+        int $dayEnd,
+        string $expectedString
+    ): void {
+        $dateRange = LocalDateRange::of(
+            LocalDate::of($yearStart, $monthStart, $dayStart),
+            LocalDate::of($yearEnd, $monthEnd, $dayEnd)
+        );
+
+        self::assertSame($expectedString, (string) $dateRange);
+    }
+
+    public function providerToString(): array
     {
-        self::assertSame('2008-12-31/2011-01-01', (string) LocalDateRange::of(
-            LocalDate::of(2008, 12, 31),
-            LocalDate::of(2011, 1, 1)
-        ));
+        return [
+            [2008, 12, 31, 2008, 12, 31, '2008-12-31/2008-12-31'],
+            [2008, 12, 31, 2011, 1, 1, '2008-12-31/2011-01-01'],
+        ];
     }
 
     /**

diff --git a/tests/LocalDateTest.php b/tests/LocalDateTest.php
@@ -1373,6 +1373,19 @@ public function testJsonSerialize(int $year, int $month, int $day, string $expec
         self::assertSame(json_encode($expected), json_encode(LocalDate::of($year, $month, $day)));
     }
 
+    /**
+     * @dataProvider providerToString
+     *
+     * @param int    $year     The year.
+     * @param int    $month    The month.
+     * @param int    $day      The day-of-month.
+     * @param string $expected The expected result string.
+     */
+    public function testToISOString(int $year, int $month, int $day, string $expected): void
+    {
+        self::assertSame($expected, LocalDate::of($year, $month, $day)->toISOString());
+    }
+
     /**
      * @dataProvider providerToString
      *