feat: enable auto-refresh at factory level (#970)

nikophil · web-flow · commit a83c24970520 · 2025-09-01T18:09:09.000+02:00
diff --git a/src/Persistence/PersistentObjectFactory.php b/src/Persistence/PersistentObjectFactory.php
@@ -51,6 +51,15 @@ abstract class PersistentObjectFactory extends ObjectFactory
 
     private bool $isRootFactory = true;
 
+    private bool $autorefreshEnabled = false;
+
+    public function __construct()
+    {
+        parent::__construct();
+
+        $this->autorefreshEnabled = Configuration::autoRefreshWithLazyObjectsIsEnabled();
+    }
+
     /**
      * @phpstan-param mixed|Parameters $criteriaOrId
      *
@@ -232,7 +241,7 @@ public function create(callable|array $attributes = []): object
         $configuration = Configuration::instance();
 
         if ($configuration->inADataProvider()
-            && Configuration::autoRefreshWithLazyObjectsIsEnabled()
+            && \PHP_VERSION_ID >= 80400
             && $this->isPersisting()
             && !$this instanceof PersistentProxyObjectFactory
         ) {
@@ -282,6 +291,30 @@ final public function withoutPersisting(): static
         return $clone;
     }
 
+    final public function withAutorefresh(): static
+    {
+        if (\PHP_VERSION_ID < 80400) {
+            throw new \LogicException('Auto-refresh requires PHP 8.4 or higher.');
+        }
+
+        $clone = clone $this;
+        $clone->autorefreshEnabled = true;
+
+        return $clone;
+    }
+
+    final public function withoutAutorefresh(): static
+    {
+        if (\PHP_VERSION_ID < 80400) {
+            throw new \LogicException('Auto-refresh requires PHP 8.4 or higher.');
+        }
+
+        $clone = clone $this;
+        $clone->autorefreshEnabled = false;
+
+        return $clone;
+    }
+
     /**
      * @internal
      */
@@ -492,7 +525,7 @@ static function(object $object, array $parameters, PersistentObjectFactory $fact
                     }
 
                     if (
-                        Configuration::autoRefreshWithLazyObjectsIsEnabled()
+                        $factoryUsed->autorefreshEnabled
                         && !$factoryUsed instanceof PersistentProxyObjectFactory
                     ) {
                         Configuration::instance()->persistedObjectsTracker?->add($object);
diff --git a/src/Persistence/functions.php b/src/Persistence/functions.php
@@ -152,13 +152,13 @@ function refresh(object &$object): object
  */
 function refresh_all(): void
 {
-    $objectsTracker = Configuration::instance()->persistedObjectsTracker;
-
     if (\PHP_VERSION_ID < 80400) {
         throw new \BadMethodCallException('Cannot use refresh_all() before PHP 8.4.');
     }
 
-    if (!Configuration::autoRefreshWithLazyObjectsIsEnabled() || null === $objectsTracker) {
+    $objectsTracker = Configuration::instance()->persistedObjectsTracker;
+
+    if (null === $objectsTracker) {
         throw new \BadMethodCallException('Cannot use refresh_all() if auto refresh with lazy objects is not enabled.');
     }
 
diff --git a/tests/Integration/Persistence/AutoRefreshTestCase.php b/tests/Integration/Persistence/AutoRefreshTestCase.php
@@ -291,6 +291,36 @@ public function it_can_refresh_lazy_object(): void
         self::assertSame('foo', $object->getProp1());
     }
 
+    #[Test]
+    public function it_can_disable_autorefresh(): void
+    {
+        $object = $this->factory()->withoutAutorefresh()->create();
+        $objectId = $object->id;
+
+        self::getContainer()->get('services_resetter')->reset(); // @phpstan-ignore method.notFound
+        self::assertFalse((new \ReflectionClass($object))->isUninitializedLazyObject($object));
+
+        $this->updateObject($objectId);
+
+        self::assertSame('default1', $object->getProp1());
+    }
+
+    #[Test]
+    public function it_can_enable_autorefresh_when_disabled_globally(): void
+    {
+        self::bootKernel(['disable_auto_refresh' => true]);
+
+        $object = $this->factory()->withAutorefresh()->create();
+        $objectId = $object->id;
+
+        self::getContainer()->get('services_resetter')->reset(); // @phpstan-ignore method.notFound
+        self::assertTrue((new \ReflectionClass($object))->isUninitializedLazyObject($object));
+
+        $this->updateObject($objectId);
+
+        self::assertSame('foo', $object->getProp1());
+    }
+
     /**
      * @return PersistentObjectFactory<GenericModel>
      */
@@ -304,6 +334,10 @@ abstract protected function objectManager(): ObjectManager;
 
     protected static function createKernel(array $options = []): KernelInterface
     {
+        if (true === ($options['disable_auto_refresh'] ?? false)) {
+            return parent::createKernel($options);
+        }
+
         return new TestKernel('enable_auto_refresh_with_lazy_objects', debug: true);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -152,13 +152,13 @@ function refresh(object &$object): object`
`152`	`152`	`*/`
`153`	`153`	`function refresh_all(): void`
`154`	`154`	`{`
`155`		`- $objectsTracker = Configuration::instance()->persistedObjectsTracker;`
`156`		`-`
`157`	`155`	`if (\PHP_VERSION_ID < 80400) {`
`158`	`156`	`throw new \BadMethodCallException('Cannot use refresh_all() before PHP 8.4.');`
`159`	`157`	`}`
`160`	`158`
`161`		`- if (!Configuration::autoRefreshWithLazyObjectsIsEnabled() \|\| null === $objectsTracker) {`
	`159`	`+ $objectsTracker = Configuration::instance()->persistedObjectsTracker;`
	`160`	`+`
	`161`	`+ if (null === $objectsTracker) {`
`162`	`162`	`throw new \BadMethodCallException('Cannot use refresh_all() if auto refresh with lazy objects is not enabled.');`
`163`	`163`	`}`
`164`	`164`