add configuration for php native lazy object

Author: eltharin

config/schema/doctrine-1.0.xsd

@@ -150,6 +150,7 @@
         <xsd:attribute name="proxy-namespace" type="xsd:string" />
         <xsd:attribute name="auto-generate-proxy-classes" type="xsd:string" default="false" />
         <xsd:attribute name="enable-lazy-ghost-objects" type="xsd:boolean" />
+        <xsd:attribute name="enable-native-lazy-objects" type="xsd:boolean" />
         <xsd:attributeGroup ref="entity-manager-config" />
     </xsd:complexType>
 

docs/en/configuration.rst

@@ -254,6 +254,8 @@ Configuration Reference
                         class_metadata_factory_name:  Doctrine\ORM\Mapping\ClassMetadataFactory
                         default_repository_class:     Doctrine\ORM\EntityRepository
                         auto_mapping:                 false
+                        # Opt-in to PHP native lazy objects
+                        enable_native_lazy_objects:   false
                         # Opt-in to new mapping driver mode as of Doctrine ORM 2.16, https://github.com/doctrine/orm/pull/10455
                         report_fields_where_declared: false
                         # 0pt-in to the new mapping driver mode as of Doctrine ORM 2.14. See https://github.com/doctrine/orm/pull/6728.

src/DependencyInjection/Configuration.php

@@ -652,6 +652,10 @@ private function getOrmEntityManagersNode(): ArrayNodeDefinition
                     ->scalarNode('class_metadata_factory_name')->defaultValue(ClassMetadataFactory::class)->end()
                     ->scalarNode('default_repository_class')->defaultValue(EntityRepository::class)->end()
                     ->scalarNode('auto_mapping')->defaultFalse()->end()
+                    ->booleanNode('enable_native_lazy_objects')
+                        ->defaultFalse()
+                        ->info('Enables the new native implementation of PHP lazy objects instead of generated proxies')
+                    ->end()
                     ->scalarNode('naming_strategy')->defaultValue('doctrine.orm.naming_strategy.default')->end()
                     ->scalarNode('quote_strategy')->defaultValue('doctrine.orm.quote_strategy.default')->end()
                     ->scalarNode('typed_field_mapper')->defaultValue('doctrine.orm.typed_field_mapper.default')->end()

src/DependencyInjection/DoctrineExtension.php

@@ -29,6 +29,7 @@
 use Doctrine\ORM\Mapping\Driver\StaticPHPDriver as LegacyStaticPHPDriver;
 use Doctrine\ORM\Mapping\Embeddable;
 use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\LegacyReflectionFields;
 use Doctrine\ORM\Mapping\MappedSuperclass;
 use Doctrine\ORM\Proxy\Autoloader;
 use Doctrine\ORM\Proxy\ProxyFactory;
@@ -78,6 +79,8 @@
 use function str_replace;
 use function trigger_deprecation;
 
+use const PHP_VERSION_ID;
+
 /**
  * DoctrineExtension is an extension for the Doctrine DBAL and ORM library.
  *
@@ -698,6 +701,10 @@ protected function loadOrmEntityManager(array $entityManager, ContainerBuilder $
             'setIdentityGenerationPreferences' => $entityManager['identity_generation_preferences'],
         ];
 
+        if (PHP_VERSION_ID >= 80400 && class_exists(LegacyReflectionFields::class)) {
+            $methods['enableNativeLazyObjects'] = $entityManager['enable_native_lazy_objects'];
+        }
+
         if (isset($entityManager['fetch_mode_subselect_batch_size'])) {
             $methods['setEagerFetchBatchSize'] = $entityManager['fetch_mode_subselect_batch_size'];
         }

tests/DependencyInjection/AbstractDoctrineExtensionTestCase.php

@@ -20,6 +20,7 @@
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
 use Doctrine\ORM\Mapping\Driver\SimplifiedXmlDriver;
+use Doctrine\ORM\Mapping\LegacyReflectionFields;
 use Doctrine\ORM\Proxy\ProxyFactory;
 use Generator;
 use InvalidArgumentException;
@@ -55,6 +56,7 @@
 use function uniqid;
 
 use const DIRECTORY_SEPARATOR;
+use const PHP_VERSION_ID;
 
 abstract class AbstractDoctrineExtensionTestCase extends TestCase
 {
@@ -1433,6 +1435,86 @@ public function testDisableSchemaValidation(): void
         $this->assertFalse($collectorDefinition->getArguments()[1]);
     }
 
+    public function testNativeLazyObjectsWithoutConfig(): void
+    {
+        if (! interface_exists(EntityManagerInterface::class)) {
+            self::markTestSkipped('This test requires ORM');
+        }
+
+        if (! class_exists(LegacyReflectionFields::class)) {
+            self::markTestSkipped('This test requires ORM 3.4+');
+        }
+
+        if (PHP_VERSION_ID < 80400) {
+            self::markTestSkipped('This test requires PHP 8.4+');
+        }
+
+        $container     = $this->loadContainer('orm_filters');
+        $entityManager = $container->get('doctrine.orm.entity_manager');
+
+        $this->assertFalse($entityManager->getConfiguration()->isNativeLazyObjectsEnabled());
+    }
+
+    public function testNativeLazyObjectsWithConfigTrue(): void
+    {
+        if (! interface_exists(EntityManagerInterface::class)) {
+            self::markTestSkipped('This test requires ORM');
+        }
+
+        if (! class_exists(LegacyReflectionFields::class)) {
+            self::markTestSkipped('This test requires ORM 3.4+');
+        }
+
+        if (PHP_VERSION_ID < 80400) {
+            self::markTestSkipped('This test requires PHP 8.4+');
+        }
+
+        $container     = $this->loadContainer('orm_native_lazy_objects_enable');
+        $entityManager = $container->get('doctrine.orm.entity_manager');
+
+        $this->assertTrue($entityManager->getConfiguration()->isNativeLazyObjectsEnabled());
+    }
+
+    public function testNativeLazyObjectsWithConfigFalse(): void
+    {
+        if (! interface_exists(EntityManagerInterface::class)) {
+            self::markTestSkipped('This test requires ORM');
+        }
+
+        if (! class_exists(LegacyReflectionFields::class)) {
+            self::markTestSkipped('This test requires ORM 3.4+');
+        }
+
+        if (PHP_VERSION_ID < 80400) {
+            self::markTestSkipped('This test requires PHP 8.4+');
+        }
+
+        $container     = $this->loadContainer('orm_native_lazy_objects_disable');
+        $entityManager = $container->get('doctrine.orm.entity_manager');
+
+        $this->assertFalse($entityManager->getConfiguration()->isNativeLazyObjectsEnabled());
+    }
+
+    public function testNativeLazyObjectsWithBadPHP(): void
+    {
+        if (! interface_exists(EntityManagerInterface::class)) {
+            self::markTestSkipped('This test requires ORM');
+        }
+
+        if (! class_exists(LegacyReflectionFields::class)) {
+            self::markTestSkipped('This test requires ORM 3.4+');
+        }
+
+        if (PHP_VERSION_ID >= 80400) {
+            self::markTestSkipped('This test requires PHP 8.3 or less');
+        }
+
+        $container     = $this->loadContainer('orm_native_lazy_objects_enable');
+        $entityManager = $container->get('doctrine.orm.entity_manager');
+
+        $this->assertFalse($entityManager->getConfiguration()->isNativeLazyObjectsEnabled());
+    }
+
     /** @param list<string> $bundles */
     private function loadContainer(
         string $fixture,

tests/DependencyInjection/Fixtures/config/xml/orm_native_lazy_objects_disable.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" ?>
+
+<srv:container xmlns="http://symfony.com/schema/dic/doctrine"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:srv="http://symfony.com/schema/dic/services"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
+                        http://symfony.com/schema/dic/doctrine http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd">
+
+    <config>
+        <dbal default-connection="default">
+            <connection name="default" dbname="db" server-version="8.0.31" />
+        </dbal>
+
+        <orm enable-native-lazy-objects="false">
+        </orm>
+    </config>
+</srv:container>

tests/DependencyInjection/Fixtures/config/xml/orm_native_lazy_objects_enable.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" ?>
+
+<srv:container xmlns="http://symfony.com/schema/dic/doctrine"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:srv="http://symfony.com/schema/dic/services"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
+                        http://symfony.com/schema/dic/doctrine http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd">
+
+    <config>
+        <dbal default-connection="default">
+            <connection name="default" dbname="db" server-version="8.0.31" />
+        </dbal>
+
+        <orm enable-native-lazy-objects="true">
+        </orm>
+    </config>
+</srv:container>

tests/DependencyInjection/Fixtures/config/yml/orm_native_lazy_objects_disable.yml

@@ -0,0 +1,9 @@
+doctrine:
+    dbal:
+        default_connection: default
+        connections:
+            default:
+                dbname: db
+
+    orm:
+        enable_native_lazy_objects: false

tests/DependencyInjection/Fixtures/config/yml/orm_native_lazy_objects_enable.yml

@@ -0,0 +1,9 @@
+doctrine:
+    dbal:
+        default_connection: default
+        connections:
+            default:
+                dbname: db
+
+    orm:
+        enable_native_lazy_objects: true