feat(mapper): Add clock getter (#FRAM-196) (#107)

Author: vincent4vx

CHANGELOG

@@ -1,6 +1,7 @@
 v2.3.0
 ------
 
+* Feat: Add `Bdf\Prime\Mapper\Mapper::clock()` to get the clock instance
 * Feat: Add transaction handling methods on `Bdf\Prime\Connection\TransactionManagerInterface`
 * Change: `EntityRepository::transaction()` do not rely on nested transaction if not enabled on the connection
 * Feat: Add custom criteria system :

src/Mapper/Mapper.php

@@ -5,6 +5,7 @@
 use Bdf\Prime\Behaviors\BehaviorInterface;
 use Bdf\Prime\Cache\CacheInterface;
 use Bdf\Prime\Clock\ClockAwareInterface;
+use Bdf\Prime\Clock\NativeClock;
 use Bdf\Prime\Entity\Criteria;
 use Bdf\Prime\Entity\Hydrator\MapperHydrator;
 use Bdf\Prime\Entity\Hydrator\MapperHydratorInterface;
@@ -480,6 +481,15 @@ final public function setClock(ClockInterface $clock): void
         $this->clock = $clock;
     }
 
+    /**
+     * Get the current clock instance
+     * If no clock has been set using {@see Mapper::setClock()}, the default clock {@see NativeClock::instance()} will be returned
+     */
+    final public function clock(): ClockInterface
+    {
+        return $this->clock ?? NativeClock::instance();
+    }
+
     /**
      * Define the criteria class
      * By default, it is the entity class with "Criteria" suffix if exists, else base Criteria class

tests/Mapper/MapperTest.php

@@ -6,6 +6,7 @@
 use Bdf\Prime\Behaviors\Behavior;
 use Bdf\Prime\Bench\HydratorGeneration;
 use Bdf\Prime\Clock\ClockAwareInterface;
+use Bdf\Prime\Clock\NativeClock;
 use Bdf\Prime\Customer;
 use Bdf\Prime\CustomerCriteria;
 use Bdf\Prime\CustomerMapper;
@@ -16,7 +17,6 @@
 use Bdf\Prime\Entity\Hydrator\MapperHydratorInterface;
 use Bdf\Prime\Exception\DBALException;
 use Bdf\Prime\IdGenerators\AbstractGenerator;
-use Bdf\Prime\IdGenerators\GeneratorInterface;
 use Bdf\Prime\IdGenerators\GuidGenerator;
 use Bdf\Prime\IdGenerators\NullGenerator;
 use Bdf\Prime\IdGenerators\TableGenerator;
@@ -83,8 +83,20 @@ public function test_default()
         $this->assertTrue($mapper->hasSchemaManager());
         $this->assertInstanceOf(MapperHydrator::class, $mapper->hydrator());
         $this->assertNull($mapper->allowUnknownAttribute());
+        $this->assertSame(NativeClock::instance(), $mapper->clock());
     }
-    
+
+    public function test_setClock()
+    {
+        $mapper = new TestEntityMapper(Prime::service(), TestEntity::class);
+        $mapper->build();
+
+        $clock = $this->createMock(ClockInterface::class);
+        $mapper->setClock($clock);
+
+        $this->assertSame($clock, $mapper->clock());
+    }
+
     /**
      * 
      */