Merge pull request #87 from gnutix/add-tostring-methods

Add toISOString() methods

src/Duration.php

@@ -754,15 +754,15 @@ public function toNanosPart(): int
     }
 
     /**
-     * Serializes as a string using {@see Duration::__toString()}.
+     * Serializes as a string using {@see Duration::toISOString()}.
      */
     public function jsonSerialize(): string
     {
-        return (string) $this;
+        return $this->toISOString();
     }
 
     /**
-     * Returns an ISO-8601 string representation of this duration.
+     * Returns the ISO 8601 representation of this duration.
      *
      * The format of the returned string will be PTnHnMn.nS, where n is
      * the relevant hours, minutes, seconds or nanoseconds part of the duration.
@@ -772,7 +772,7 @@ public function jsonSerialize(): string
      *
      * Note that multiples of 24 hours are not output as days to avoid confusion with Period.
      */
-    public function __toString(): string
+    public function toISOString(): string
     {
         $seconds = $this->seconds;
         $nanos = $this->nanos;
@@ -813,4 +813,12 @@ public function __toString(): string
 
         return $string . 'S';
     }
+
+    /**
+     * {@see Duration::toISOString()}.
+     */
+    public function __toString(): string
+    {
+        return $this->toISOString();
+    }
 }

src/Instant.php

@@ -366,15 +366,26 @@ public function toDecimal(): string
     }
 
     /**
-     * Serializes as a string using {@see Instant::__toString()}.
+     * Serializes as a string using {@see Instant::toISOString()}.
      */
     public function jsonSerialize(): string
     {
-        return (string) $this;
+        return $this->toISOString();
     }
 
-    public function __toString(): string
+    /**
+     * Returns the ISO 8601 representation of this instant.
+     */
+    public function toISOString(): string
     {
         return (string) ZonedDateTime::ofInstant($this, TimeZone::utc());
     }
+
+    /**
+     * {@see Instant::toISOString()}.
+     */
+    public function __toString(): string
+    {
+        return $this->toISOString();
+    }
 }

src/Interval.php

@@ -138,15 +138,26 @@ public function isEqualTo(Interval $that): bool
     }
 
     /**
-     * Serializes as a string using {@see Interval::__toString()}.
+     * Serializes as a string using {@see Interval::toISOString()}.
      */
     public function jsonSerialize(): string
     {
-        return (string) $this;
+        return $this->toISOString();
     }
 
-    public function __toString(): string
+    /**
+     * Returns the ISO 8601 representation of this interval.
+     */
+    public function toISOString(): string
     {
         return $this->start . '/' . $this->end;
     }
+
+    /**
+     * {@see Interval::toISOString()}.
+     */
+    public function __toString(): string
+    {
+        return $this->toISOString();
+    }
 }

src/LocalDate.php

@@ -747,23 +747,31 @@ public function toNativeDateTimeImmutable(): DateTimeImmutable
     }
 
     /**
-     * Serializes as a string using {@see LocalDate::__toString()}.
+     * Serializes as a string using {@see LocalDate::toISOString()}.
      */
     public function jsonSerialize(): string
     {
-        return (string) $this;
+        return $this->toISOString();
     }
 
     /**
-     * Returns the ISO 8601 representation of this LocalDate.
+     * Returns the ISO 8601 representation of this date.
      */
-    public function __toString(): string
+    public function toISOString(): string
     {
         $pattern = ($this->year < 0 ? '%05d' : '%04d') . '-%02d-%02d';
 
         return sprintf($pattern, $this->year, $this->month, $this->day);
     }
 
+    /**
+     * {@see LocalDate::toISOString()}.
+     */
+    public function __toString(): string
+    {
+        return $this->toISOString();
+    }
+
     /**
      * Resolves the date, resolving days past the end of month.
      *

src/LocalDateRange.php

@@ -237,11 +237,11 @@ public function count(): int
     }
 
     /**
-     * Serializes as a string using {@see LocalDateRange::__toString()}.
+     * Serializes as a string using {@see LocalDateRange::toISOString()}.
      */
     public function jsonSerialize(): string
     {
-        return (string) $this;
+        return $this->toISOString();
     }
 
     /**
@@ -260,10 +260,18 @@ public function toNativeDatePeriod(): DatePeriod
     }
 
     /**
-     * Returns an ISO 8601 string representation of this date range.
+     * Returns the ISO 8601 representation of this date range.
      */
-    public function __toString(): string
+    public function toISOString(): string
     {
         return $this->start . '/' . $this->end;
     }
+
+    /**
+     * {@see LocalDateRange::toISOString()}.
+     */
+    public function __toString(): string
+    {
+        return $this->toISOString();
+    }
 }

src/LocalDateTime.php

@@ -716,18 +716,29 @@ public function toNativeDateTimeImmutable(): DateTimeImmutable
     }
 
     /**
-     * Serializes as a string using {@see LocalDateTime::__toString()}.
+     * Serializes as a string using {@see LocalDateTime::toISOString()}.
      */
     public function jsonSerialize(): string
     {
-        return (string) $this;
+        return $this->toISOString();
     }
 
-    public function __toString(): string
+    /**
+     * Returns the ISO 8601 representation of this date time.
+     */
+    public function toISOString(): string
     {
         return $this->date . 'T' . $this->time;
     }
 
+    /**
+     * {@see LocalDateTime::toISOString()}.
+     */
+    public function __toString(): string
+    {
+        return $this->toISOString();
+    }
+
     /**
      * Returns a copy of this `LocalDateTime` with the specified period added.
      *

src/LocalTime.php

@@ -640,17 +640,17 @@ public function toNativeDateTimeImmutable(): DateTimeImmutable
     }
 
     /**
-     * Serializes as a string using {@see LocalTime::__toString()}.
+     * Serializes as a string using {@see LocalTime::toISOString()}.
      */
     public function jsonSerialize(): string
     {
-        return (string) $this;
+        return $this->toISOString();
     }
 
     /**
-     * Returns this time as a string, such as 10:15.
+     * Returns the ISO 8601 representation of this time.
      *
-     * The output will be one of the following ISO-8601 formats:
+     * The output will be one of the following formats:
      *
      * * `HH:mm`
      * * `HH:mm:ss`
@@ -660,7 +660,7 @@ public function jsonSerialize(): string
      * the time where the omitted parts are implied to be zero.
      * The nanoseconds value, if present, can be 0 to 9 digits.
      */
-    public function __toString(): string
+    public function toISOString(): string
     {
         if ($this->nano === 0) {
             if ($this->second === 0) {
@@ -674,4 +674,12 @@ public function __toString(): string
 
         return sprintf('%02u:%02u:%02u.%s', $this->hour, $this->minute, $this->second, $nanos);
     }
+
+    /**
+     * {@see LocalTime::toISOString()}.
+     */
+    public function __toString(): string
+    {
+        return $this->toISOString();
+    }
 }

src/MonthDay.php

@@ -226,15 +226,26 @@ public function atYear(int $year): LocalDate
     }
 
     /**
-     * Serializes as a string using {@see MonthDay::__toString()}.
+     * Serializes as a string using {@see MonthDay::toISOString()}.
      */
     public function jsonSerialize(): string
     {
-        return (string) $this;
+        return $this->toISOString();
     }
 
-    public function __toString(): string
+    /**
+     * Returns the ISO 8601 representation of this month-day.
+     */
+    public function toISOString(): string
     {
         return sprintf('--%02d-%02d', $this->month, $this->day);
     }
+
+    /**
+     * {@see MonthDay::toISOString()}.
+     */
+    public function __toString(): string
+    {
+        return $this->toISOString();
+    }
 }

src/Period.php

@@ -377,14 +377,17 @@ public function toNativeDateInterval(): DateInterval
     }
 
     /**
-     * Serializes as a string using {@see Period::__toString()}.
+     * Serializes as a string using {@see Period::toISOString()}.
      */
     public function jsonSerialize(): string
     {
-        return (string) $this;
+        return $this->toISOString();
     }
 
-    public function __toString(): string
+    /**
+     * Returns the ISO 8601 representation of this period.
+     */
+    public function toISOString(): string
     {
         if ($this->isZero()) {
             return 'P0D';
@@ -404,4 +407,12 @@ public function __toString(): string
 
         return $string;
     }
+
+    /**
+     * {@see Period::toISOString()}.
+     */
+    public function __toString(): string
+    {
+        return $this->toISOString();
+    }
 }

src/Year.php

@@ -269,15 +269,26 @@ public function toLocalDateRange(): LocalDateRange
     }
 
     /**
-     * Serializes as a string using {@see Year::__toString()}.
+     * Serializes as a string using {@see Year::toISOString()}.
      */
     public function jsonSerialize(): string
     {
-        return (string) $this;
+        return $this->toISOString();
     }
 
-    public function __toString(): string
+    /**
+     * Returns the ISO 8601 representation of this year.
+     */
+    public function toISOString(): string
     {
         return (string) $this->year;
     }
+
+    /**
+     * {@see Year::toISOString()}.
+     */
+    public function __toString(): string
+    {
+        return $this->toISOString();
+    }
 }

src/YearMonth.php

@@ -288,18 +288,28 @@ public function toLocalDateRange(): LocalDateRange
     }
 
     /**
-     * Serializes as a string using {@see YearMonth::__toString()}.
+     * Serializes as a string using {@see YearMonth::toISOString()}.
      */
     public function jsonSerialize(): string
     {
-        return (string) $this;
+        return $this->toISOString();
     }
 
     /**
-     * Returns the ISO 8601 representation of this YearMonth.
+     * Returns the ISO 8601 representation of this year-month.
+     */
+    public function toISOString(): string
+    {
+        $pattern = ($this->year < 0 ? '%05d' : '%04d') . '-%02d';
+
+        return sprintf($pattern, $this->year, $this->month);
+    }
+
+    /**
+     * {@see YearMonth::toISOString()}.
      */
     public function __toString(): string
     {
-        return sprintf('%02u-%02u', $this->year, $this->month);
+        return $this->toISOString();
     }
 }