Merge pull request #2813 from briannesbitt/feature/clock

Implement `Psr\Clock\ClockInterface`
briannesbitt · Jun 23, 2023 · abf63b9 · abf63b9
2 parents 8c01992 + 1167583
commit abf63b9
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 17 deletions.
diff --git a/composer.json b/composer.json
@@ -42,6 +42,7 @@
     "require": {
         "php": "^7.1.8 || ^8.0",
         "ext-json": "*",
+        "psr/clock": "^1.0",
         "symfony/polyfill-mbstring": "^1.0",
         "symfony/polyfill-php80": "^1.16",
         "symfony/translation": "^3.4 || ^4.0 || ^5.0 || ^6.0"
@@ -59,6 +60,9 @@
         "phpunit/phpunit": "^7.5.20 || ^8.5.26 || ^9.5.20",
         "squizlabs/php_codesniffer": "^3.4"
     },
+    "provide": {
+        "psr/clock-implementation": "1.0"
+    },
     "minimum-stability": "dev",
     "prefer-stable": true,
     "autoload": {

diff --git a/phpdoc.php b/phpdoc.php
@@ -12,6 +12,8 @@
 use Carbon\Carbon;
 use Carbon\CarbonImmutable;
 use Carbon\CarbonInterface;
+use Carbon\Factory;
+use Carbon\FactoryImmutable;
 use Symfony\Component\Translation\TranslatorInterface;
 
 $tags = [
@@ -674,22 +676,30 @@ function compileDoc($autoDocLines, $file)
         }
 
         $returnType = str_replace('static|CarbonInterface', 'static', $returnType ?: 'static');
-        $staticMethods[] = [
-            '@method',
-            str_replace('static', 'Carbon', $returnType),
-            "$method($parameters)",
-            $doc[0],
-        ];
-        $staticImmutableMethods[] = [
-            '@method',
-            str_replace('static', 'CarbonImmutable', $returnType),
-            "$method($parameters)",
-            $doc[0],
-        ];
+        if (!method_exists(Factory::class, $method)) {
+            $staticMethods[] = [
+                '@method',
+                str_replace('static', 'Carbon', $returnType),
+                "$method($parameters)",
+                $doc[0],
+            ];
 
-        for ($i = 1; $i < \count($doc); $i++) {
-            $staticMethods[] = ['', '', '', $doc[$i]];
-            $staticImmutableMethods[] = ['', '', '', $doc[$i]];
+            for ($i = 1; $i < \count($doc); $i++) {
+                $staticMethods[] = ['', '', '', $doc[$i]];
+            }
+        }
+
+        if (!method_exists(FactoryImmutable::class, $method)) {
+            $staticImmutableMethods[] = [
+                '@method',
+                str_replace('static', 'CarbonImmutable', $returnType),
+                "$method($parameters)",
+                $doc[0],
+            ];
+
+            for ($i = 1; $i < \count($doc); $i++) {
+                $staticImmutableMethods[] = ['', '', '', $doc[$i]];
+            }
         }
     }
 

diff --git a/src/Carbon/FactoryImmutable.php b/src/Carbon/FactoryImmutable.php
@@ -12,6 +12,9 @@
 namespace Carbon;
 
 use Closure;
+use DateTimeImmutable;
+use DateTimeZone;
+use Psr\Clock\ClockInterface;
 
 /**
  * A factory to generate CarbonImmutable instances with common settings.
@@ -111,7 +114,6 @@
  * @method CarbonImmutable                                    maxValue()                                                                                                                   Create a Carbon instance for the greatest supported date.
  * @method CarbonImmutable                                    minValue()                                                                                                                   Create a Carbon instance for the lowest supported date.
  * @method void                                               mixin($mixin)                                                                                                                Mix another object into the class.
- * @method CarbonImmutable                                    now($tz = null)                                                                                                              Get a Carbon instance for the current date and time.
  * @method CarbonImmutable                                    parse($time = null, $tz = null)                                                                                              Create a carbon instance from a string.
  *                                                                                                                                                                                         This is an alias for the constructor that allows better fluent syntax
  *                                                                                                                                                                                         as it allows you to do Carbon::parse('Monday next week')->fn() rather
@@ -237,7 +239,21 @@
  *
  * </autodoc>
  */
-class FactoryImmutable extends Factory
+class FactoryImmutable extends Factory implements ClockInterface
 {
     protected $className = CarbonImmutable::class;
+
+    /**
+     * Get a Carbon instance for the current date and time.
+     *
+     * @param DateTimeZone|string|int|null $tz
+     *
+     * @return CarbonImmutable
+     */
+    public function now($tz = null): DateTimeImmutable
+    {
+        $className = $this->className;
+
+        return new $className(null, $tz);
+    }
 }
diff --git a/tests/Factory/FactoryTest.php b/tests/Factory/FactoryTest.php
@@ -17,6 +17,8 @@
 use Carbon\CarbonImmutable;
 use Carbon\Factory;
 use Carbon\FactoryImmutable;
+use DateTimeImmutable;
+use Psr\Clock\ClockInterface;
 use Tests\AbstractTestCase;
 use Tests\Carbon\Fixtures\MyCarbon;
 
@@ -146,4 +148,12 @@ public function testFactoryTimezone()
         $date = $factory->make('2021-08-01 08:00:00 Europe/Paris');
         $this->assertSame('2021-08-01T08:00:00+02:00', $date->format('c'));
     }
+
+    public function testPsrClock()
+    {
+        $factory = new FactoryImmutable();
+        $this->assertInstanceOf(ClockInterface::class, $factory);
+        $this->assertInstanceOf(DateTimeImmutable::class, $factory->now());
+        $this->assertInstanceOf(CarbonImmutable::class, $factory->now());
+    }
 }