Merge pull request #4633 from MGatner/time-instance

Expand Time for interface

Author: MGatner

system/I18n/Time.php

@@ -14,6 +14,8 @@
 use CodeIgniter\I18n\Exceptions\I18nException;
 use DateInterval;
 use DateTime;
+use DateTimeImmutable;
+use DateTimeInterface;
 use DateTimeZone;
 use Exception;
 use IntlCalendar;
@@ -57,7 +59,7 @@ class Time extends DateTime
 	protected static $relativePattern = '/this|next|last|tomorrow|yesterday|midnight|today|[+-]|first|last|ago/i';
 
 	/**
-	 * @var \CodeIgniter\I18n\Time|DateTime|null
+	 * @var static|DateTimeInterface|null
 	 */
 	protected static $testNow;
 
@@ -301,15 +303,15 @@ public static function createFromTimestamp(int $timestamp, $timezone = null, str
 	//--------------------------------------------------------------------
 
 	/**
-	 * Takes an instance of DateTime and returns an instance of Time with it's same values.
+	 * Takes an instance of DateTimeInterface and returns an instance of Time with it's same values.
 	 *
-	 * @param DateTime    $dateTime
-	 * @param string|null $locale
+	 * @param DateTimeInterface $dateTime
+	 * @param string|null       $locale
 	 *
 	 * @return Time
 	 * @throws Exception
 	 */
-	public static function instance(DateTime $dateTime, string $locale = null)
+	public static function createFromInstance(DateTimeInterface $dateTime, string $locale = null)
 	{
 		$date     = $dateTime->format('Y-m-d H:i:s');
 		$timezone = $dateTime->getTimezone();
@@ -319,6 +321,25 @@ public static function instance(DateTime $dateTime, string $locale = null)
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * Takes an instance of DateTime and returns an instance of Time with it's same values.
+	 *
+	 * @param DateTime    $dateTime
+	 * @param string|null $locale
+	 *
+	 * @return Time
+	 * @throws Exception
+	 *
+	 * @deprecated         Use createFromInstance() instead
+	 * @codeCoverageIgnore
+	 */
+	public static function instance(DateTime $dateTime, string $locale = null)
+	{
+		return self::createFromInstance($dateTime, $locale);
+	}
+
+	//--------------------------------------------------------------------
+
 	/**
 	 * Converts the current instance to a mutable DateTime object.
 	 *
@@ -341,9 +362,9 @@ public function toDateTime()
 	 * Creates an instance of Time that will be returned during testing
 	 * when calling 'Time::now' instead of the current time.
 	 *
-	 * @param Time|DateTime|string|null $datetime
-	 * @param DateTimeZone|string|null  $timezone
-	 * @param string|null               $locale
+	 * @param Time|DateTimeInterface|string|null $datetime
+	 * @param DateTimeZone|string|null           $timezone
+	 * @param string|null                        $locale
 	 *
 	 * @throws Exception
 	 */
@@ -361,7 +382,7 @@ public static function setTestNow($datetime = null, $timezone = null, string $lo
 		{
 			$datetime = new Time($datetime, $timezone, $locale);
 		}
-		elseif ($datetime instanceof DateTime && ! $datetime instanceof Time)
+		elseif ($datetime instanceof DateTimeInterface && ! $datetime instanceof Time)
 		{
 			$datetime = new Time($datetime->format('Y-m-d H:i:s'), $timezone);
 		}
@@ -1038,8 +1059,8 @@ public function toLocalizedString(string $format = null)
 	 * and are not required to be in the same timezone, as both times are
 	 * converted to UTC and compared that way.
 	 *
-	 * @param Time|DateTime|string $testTime
-	 * @param string|null          $timezone
+	 * @param Time|DateTimeInterface|string $testTime
+	 * @param string|null                   $timezone
 	 *
 	 * @return boolean
 	 * @throws Exception
@@ -1060,15 +1081,15 @@ public function equals($testTime, string $timezone = null): bool
 	/**
 	 * Ensures that the times are identical, taking timezone into account.
 	 *
-	 * @param Time|DateTime|string $testTime
-	 * @param string|null          $timezone
+	 * @param Time|DateTimeInterface|string $testTime
+	 * @param string|null                   $timezone
 	 *
 	 * @return boolean
 	 * @throws Exception
 	 */
 	public function sameAs($testTime, string $timezone = null): bool
 	{
-		if ($testTime instanceof DateTime)
+		if ($testTime instanceof DateTimeInterface)
 		{
 			$testTime = $testTime->format('Y-m-d H:i:s');
 		}
@@ -1232,19 +1253,18 @@ public function getUTCObject($time, string $timezone = null)
 	{
 		if ($time instanceof Time)
 		{
-			$time = $time->toDateTime()
-					->setTimezone(new DateTimeZone('UTC'));
-		}
-		elseif ($time instanceof DateTime)
-		{
-			$time = $time->setTimezone(new DateTimeZone('UTC'));
+			$time = $time->toDateTime();
 		}
 		elseif (is_string($time))
 		{
 			$timezone = $timezone ?: $this->timezone;
 			$timezone = $timezone instanceof DateTimeZone ? $timezone : new DateTimeZone($timezone);
 			$time     = new DateTime($time, $timezone);
-			$time     = $time->setTimezone(new DateTimeZone('UTC'));
+		}
+
+		if ($time instanceof DateTime || $time instanceof DateTimeImmutable)
+		{
+			$time = $time->setTimezone(new DateTimeZone('UTC'));
 		}
 
 		return $time;

tests/system/I18n/TimeTest.php

@@ -1004,12 +1004,11 @@ public function testSetTimezoneDate()
 	}
 
 	//--------------------------------------------------------------------
-	// Missing tests
 
-	public function testInstance()
+	public function testCreateFromInstance()
 	{
 		$datetime = new DateTime();
-		$time     = Time::instance($datetime);
+		$time     = Time::createFromInstance($datetime);
 		$this->assertTrue($time instanceof Time);
 		$this->assertTrue($time->sameAs($datetime));
 	}

user_guide_src/source/changelogs/v4.1.2.rst

@@ -39,6 +39,7 @@ Deprecations:
 - Deprecated ``FeatureTestCase`` to use the ``FeatureTestTrait`` instead.
 - Deprecated ``ControllerTester`` to use the ``ControllerTestTrait`` instead.
 - Consolidated and deprecated ``ControllerResponse`` and ``FeatureResponse`` in favor of ``TestResponse``.
+- Deprecated ``Time::instance()``, use ``Time::createFromInstance()`` instead (now accepts ``DateTimeInterface``).
 
 Bugs Fixed: