Merge pull request #2769 from takaram/withTestNow_signature

Improve withTestNow() signature
briannesbitt · Feb 22, 2023 · 020e560 · 020e560
2 parents 610db40 + 257e5cf
commit 020e560
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/src/Carbon/CarbonInterface.php b/src/Carbon/CarbonInterface.php
@@ -5120,12 +5120,15 @@ public function weeksInYear($dayOfWeek = null, $dayOfYear = null);
      *
      * /!\ Use this method for unit tests only.
      *
+     * @template T
+     *
      * @param DateTimeInterface|Closure|static|string|false|null $testNow  real or mock Carbon instance
-     * @param Closure|null                                       $callback
+     * @param Closure(): T                                       $callback
      *
      * @return mixed
+     * @phpstan-return T
      */
-    public static function withTestNow($testNow = null, $callback = null);
+    public static function withTestNow($testNow, $callback);
 
     /**
      * Create a Carbon instance for yesterday.

diff --git a/src/Carbon/Factory.php b/src/Carbon/Factory.php
@@ -231,7 +231,7 @@
  *                                                                                                                                                                                                     You should rather use the ->settings() method.
  *                                                                                                                                                                                                     Or you can use method variants: addYearsWithOverflow/addYearsNoOverflow, same variants
  *                                                                                                                                                                                                     are available for quarters, years, decade, centuries, millennia (singular and plural forms).
- * @method mixed                                              withTestNow($testNow = null, $callback = null)                                                                               Temporarily sets a static date to be used within the callback.
+ * @method mixed                                              withTestNow($testNow, $callback)                                                                                             Temporarily sets a static date to be used within the callback.
  *                                                                                                                                                                                         Using setTestNow to set the date, executing the callback, then
  *                                                                                                                                                                                         clearing the test instance.
  *                                                                                                                                                                                         /!\ Use this method for unit tests only.

diff --git a/src/Carbon/FactoryImmutable.php b/src/Carbon/FactoryImmutable.php
@@ -229,7 +229,7 @@
  *                                                                                                                                                                                                     You should rather use the ->settings() method.
  *                                                                                                                                                                                                     Or you can use method variants: addYearsWithOverflow/addYearsNoOverflow, same variants
  *                                                                                                                                                                                                     are available for quarters, years, decade, centuries, millennia (singular and plural forms).
- * @method mixed                                              withTestNow($testNow = null, $callback = null)                                                                               Temporarily sets a static date to be used within the callback.
+ * @method mixed                                              withTestNow($testNow, $callback)                                                                                             Temporarily sets a static date to be used within the callback.
  *                                                                                                                                                                                         Using setTestNow to set the date, executing the callback, then
  *                                                                                                                                                                                         clearing the test instance.
  *                                                                                                                                                                                         /!\ Use this method for unit tests only.

diff --git a/src/Carbon/Traits/Test.php b/src/Carbon/Traits/Test.php
@@ -119,12 +119,15 @@ public static function setTestNowAndTimezone($testNow = null, $tz = null)
      *
      * /!\ Use this method for unit tests only.
      *
+     * @template T
+     *
      * @param DateTimeInterface|Closure|static|string|false|null $testNow  real or mock Carbon instance
-     * @param Closure|null                                       $callback
+     * @param Closure(): T                                       $callback
      *
      * @return mixed
+     * @phpstan-return T
      */
-    public static function withTestNow($testNow = null, $callback = null)
+    public static function withTestNow($testNow, $callback)
     {
         static::setTestNow($testNow);