Add support for providing a PSR-20 clock to event adapters which create new DateTimeInterface objects

Author: mbabker

CHANGELOG.md

@@ -21,6 +21,8 @@ a release.
 ### Added
 - SoftDeleteable: `Gedmo\SoftDeleteable\Event\PreSoftDeleteEventArgs` and
   `Gedmo\SoftDeleteable\Event\PostSoftDeleteEventArgs` classes.
+- Add support for injecting a `psr/clock` implementation into event adapters
+  that create new `DateTimeInterface` objects (SoftDeleteable and Timestampable)
 
 ### Changed
 - Make doctrine/annotations an optional dependency.

composer.json

@@ -48,6 +48,7 @@
         "doctrine/event-manager": "^1.2 || ^2.0",
         "doctrine/persistence": "^2.2 || ^3.0",
         "psr/cache": "^1 || ^2 || ^3",
+        "psr/clock": "^1",
         "symfony/cache": "^5.4 || ^6.0 || ^7.0"
     },
     "require-dev": {

src/Mapping/Event/ClockAwareAdapterInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the Doctrine Behavioral Extensions package.
+ * (c) Gediminas Morkevicius <[email protected]> http://www.gediminasm.org
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gedmo\Mapping\Event;
+
+use Psr\Clock\ClockInterface;
+
+/**
+ * Doctrine event adapter supporting a PSR-20 {@see ClockInterface}.
+ */
+interface ClockAwareAdapterInterface
+{
+    public function setClock(ClockInterface $clock): void;
+}

src/Mapping/MappedEventSubscriber.php

@@ -26,10 +26,12 @@
 use Gedmo\Exception\InvalidArgumentException;
 use Gedmo\Mapping\Driver\AttributeReader;
 use Gedmo\Mapping\Event\AdapterInterface;
+use Gedmo\Mapping\Event\ClockAwareAdapterInterface;
 use Gedmo\ReferenceIntegrity\Mapping\Validator as ReferenceIntegrityValidator;
 use Gedmo\Uploadable\FilenameGenerator\FilenameGeneratorInterface;
 use Gedmo\Uploadable\Mapping\Validator as MappingValidator;
 use Psr\Cache\CacheItemPoolInterface;
+use Psr\Clock\ClockInterface;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 
 /**
@@ -95,6 +97,8 @@ abstract class MappedEventSubscriber implements EventSubscriber
      */
     private $cacheItemPool;
 
+    private ?ClockInterface $clock = null;
+
     public function __construct()
     {
         $parts = explode('\\', $this->getNamespace());
@@ -224,6 +228,11 @@ final public function setCacheItemPool(CacheItemPoolInterface $cacheItemPool): v
         $this->cacheItemPool = $cacheItemPool;
     }
 
+    final public function setClock(ClockInterface $clock): void
+    {
+        $this->clock = $clock;
+    }
+
     /**
      * Scans the objects for extended annotations
      * event subscribers must subscribe to loadClassMetadata event
@@ -267,6 +276,10 @@ protected function getEventAdapter(EventArgs $args)
                     $adapterClass = 'Gedmo\\Mapping\\Event\\Adapter\\'.$m[1];
                 }
                 $this->adapters[$m[1]] = new $adapterClass();
+
+                if ($this->adapters[$m[1]] instanceof ClockAwareAdapterInterface && $this->clock instanceof ClockInterface) {
+                    $this->adapters[$m[1]]->setClock($this->clock);
+                }
             }
             $this->adapters[$m[1]]->setEventArgs($args);
 

src/SoftDeleteable/Mapping/Event/Adapter/ODM.php

@@ -11,22 +11,34 @@
 
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Gedmo\Mapping\Event\Adapter\ODM as BaseAdapterODM;
+use Gedmo\Mapping\Event\ClockAwareAdapterInterface;
 use Gedmo\SoftDeleteable\Mapping\Event\SoftDeleteableAdapter;
+use Psr\Clock\ClockInterface;
 
 /**
  * Doctrine event adapter for ORM adapted
  * for SoftDeleteable behavior.
  *
  * @author David Buchmann <[email protected]>
  */
-final class ODM extends BaseAdapterODM implements SoftDeleteableAdapter
+final class ODM extends BaseAdapterODM implements SoftDeleteableAdapter, ClockAwareAdapterInterface
 {
+    /**
+     * @var ClockInterface|null
+     */
+    private ?ClockInterface $clock = null;
+
+    public function setClock(ClockInterface $clock): void
+    {
+        $this->clock = $clock;
+    }
+
     /**
      * @param ClassMetadata $meta
      */
     public function getDateValue($meta, $field)
     {
-        $datetime = new \DateTime();
+        $datetime = $this->clock instanceof ClockInterface ? $this->clock->now() : new \DateTimeImmutable();
         $mapping = $meta->getFieldMapping($field);
         $type = $mapping['type'] ?? null;
 
@@ -35,9 +47,9 @@ public function getDateValue($meta, $field)
         }
 
         if (in_array($type, ['date_immutable', 'time_immutable', 'datetime_immutable', 'datetimetz_immutable'], true)) {
-            return \DateTimeImmutable::createFromMutable($datetime);
+            return $datetime;
         }
 
-        return $datetime;
+        return \DateTime::createFromImmutable($datetime);
     }
 }

src/SoftDeleteable/Mapping/Event/Adapter/ORM.php

@@ -13,16 +13,28 @@
 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Gedmo\Mapping\Event\Adapter\ORM as BaseAdapterORM;
+use Gedmo\Mapping\Event\ClockAwareAdapterInterface;
 use Gedmo\SoftDeleteable\Mapping\Event\SoftDeleteableAdapter;
+use Psr\Clock\ClockInterface;
 
 /**
  * Doctrine event adapter for ORM adapted
  * for SoftDeleteable behavior.
  *
  * @author David Buchmann <[email protected]>
  */
-final class ORM extends BaseAdapterORM implements SoftDeleteableAdapter
+final class ORM extends BaseAdapterORM implements SoftDeleteableAdapter, ClockAwareAdapterInterface
 {
+    /**
+     * @var ClockInterface|null
+     */
+    private ?ClockInterface $clock = null;
+
+    public function setClock(ClockInterface $clock): void
+    {
+        $this->clock = $clock;
+    }
+
     /**
      * @param ClassMetadata $meta
      */
@@ -44,17 +56,17 @@ public function getDateValue($meta, $field)
      */
     private function getRawDateValue(array $mapping)
     {
-        $datetime = new \DateTime();
+        $datetime = $this->clock instanceof ClockInterface ? $this->clock->now() : new \DateTimeImmutable();
         $type = $mapping['type'] ?? null;
 
         if ('integer' === $type) {
             return (int) $datetime->format('U');
         }
 
         if (in_array($type, ['date_immutable', 'time_immutable', 'datetime_immutable', 'datetimetz_immutable'], true)) {
-            return \DateTimeImmutable::createFromMutable($datetime);
+            return $datetime;
         }
 
-        return $datetime;
+        return \DateTime::createFromImmutable($datetime);
     }
 }

src/Timestampable/Mapping/Event/Adapter/ODM.php

@@ -11,22 +11,34 @@
 
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Gedmo\Mapping\Event\Adapter\ODM as BaseAdapterODM;
+use Gedmo\Mapping\Event\ClockAwareAdapterInterface;
 use Gedmo\Timestampable\Mapping\Event\TimestampableAdapter;
+use Psr\Clock\ClockInterface;
 
 /**
  * Doctrine event adapter for ODM adapted
  * for Timestampable behavior
  *
  * @author Gediminas Morkevicius <[email protected]>
  */
-final class ODM extends BaseAdapterODM implements TimestampableAdapter
+final class ODM extends BaseAdapterODM implements TimestampableAdapter, ClockAwareAdapterInterface
 {
+    /**
+     * @var ClockInterface|null
+     */
+    private ?ClockInterface $clock = null;
+
+    public function setClock(ClockInterface $clock): void
+    {
+        $this->clock = $clock;
+    }
+
     /**
      * @param ClassMetadata $meta
      */
     public function getDateValue($meta, $field)
     {
-        $datetime = new \DateTime();
+        $datetime = $this->clock instanceof ClockInterface ? $this->clock->now() : new \DateTimeImmutable();
         $mapping = $meta->getFieldMapping($field);
         $type = $mapping['type'] ?? null;
 
@@ -35,9 +47,9 @@ public function getDateValue($meta, $field)
         }
 
         if (in_array($type, ['date_immutable', 'time_immutable', 'datetime_immutable', 'datetimetz_immutable'], true)) {
-            return \DateTimeImmutable::createFromMutable($datetime);
+            return $datetime;
         }
 
-        return $datetime;
+        return \DateTime::createFromImmutable($datetime);
     }
 }

src/Timestampable/Mapping/Event/Adapter/ORM.php

@@ -13,16 +13,28 @@
 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Gedmo\Mapping\Event\Adapter\ORM as BaseAdapterORM;
+use Gedmo\Mapping\Event\ClockAwareAdapterInterface;
 use Gedmo\Timestampable\Mapping\Event\TimestampableAdapter;
+use Psr\Clock\ClockInterface;
 
 /**
  * Doctrine event adapter for ORM adapted
  * for Timestampable behavior
  *
  * @author Gediminas Morkevicius <[email protected]>
  */
-final class ORM extends BaseAdapterORM implements TimestampableAdapter
+final class ORM extends BaseAdapterORM implements TimestampableAdapter, ClockAwareAdapterInterface
 {
+    /**
+     * @var ClockInterface|null
+     */
+    private ?ClockInterface $clock = null;
+
+    public function setClock(ClockInterface $clock): void
+    {
+        $this->clock = $clock;
+    }
+
     /**
      * @param ClassMetadata $meta
      */
@@ -44,17 +56,17 @@ public function getDateValue($meta, $field)
      */
     private function getRawDateValue(array $mapping)
     {
-        $datetime = new \DateTime();
+        $datetime = $this->clock instanceof ClockInterface ? $this->clock->now() : new \DateTimeImmutable();
         $type = $mapping['type'] ?? null;
 
         if ('integer' === $type) {
             return (int) $datetime->format('U');
         }
 
         if (in_array($type, ['date_immutable', 'time_immutable', 'datetime_immutable', 'datetimetz_immutable'], true)) {
-            return \DateTimeImmutable::createFromMutable($datetime);
+            return $datetime;
         }
 
-        return $datetime;
+        return \DateTime::createFromImmutable($datetime);
     }
 }

tests/Gedmo/Clock.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Doctrine Behavioral Extensions package.
+ * (c) Gediminas Morkevicius <[email protected]> http://www.gediminasm.org
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gedmo\Tests;
+
+use Psr\Clock\ClockInterface;
+
+final class Clock implements ClockInterface
+{
+    public function now(): \DateTimeImmutable
+    {
+        return new \DateTimeImmutable();
+    }
+}

tests/Gedmo/SoftDeleteable/SoftDeleteableEntityTest.php

@@ -17,6 +17,7 @@
 use Gedmo\SoftDeleteable\Filter\SoftDeleteableFilter;
 use Gedmo\SoftDeleteable\Query\TreeWalker\SoftDeleteableWalker;
 use Gedmo\SoftDeleteable\SoftDeleteableListener;
+use Gedmo\Tests\Clock;
 use Gedmo\Tests\SoftDeleteable\Fixture\Entity\Article;
 use Gedmo\Tests\SoftDeleteable\Fixture\Entity\Child;
 use Gedmo\Tests\SoftDeleteable\Fixture\Entity\Comment;
@@ -62,6 +63,7 @@ protected function setUp(): void
 
         $evm = new EventManager();
         $this->softDeleteableListener = new SoftDeleteableListener();
+        $this->softDeleteableListener->setClock(new Clock());
         $evm->addEventSubscriber($this->softDeleteableListener);
         $config = $this->getDefaultConfiguration();
         $config->addFilter(self::SOFT_DELETEABLE_FILTER_NAME, SoftDeleteableFilter::class);

tests/Gedmo/Timestampable/TimestampableTest.php

@@ -13,6 +13,7 @@
 
 use Doctrine\Common\EventManager;
 use Doctrine\Persistence\Proxy;
+use Gedmo\Tests\Clock;
 use Gedmo\Tests\Timestampable\Fixture\Article;
 use Gedmo\Tests\Timestampable\Fixture\Author;
 use Gedmo\Tests\Timestampable\Fixture\Comment;
@@ -35,8 +36,11 @@ protected function setUp(): void
     {
         parent::setUp();
 
+        $listener = new TimestampableListener();
+        $listener->setClock(new Clock());
+
         $evm = new EventManager();
-        $evm->addEventSubscriber(new TimestampableListener());
+        $evm->addEventSubscriber($listener);
 
         $this->getDefaultMockSqliteEntityManager($evm);
     }