Forget about report_fields_where_declared

greg0ire · greg0ire · commit 4117427cd910 · 2025-09-05T09:39:56.000+02:00
With ORM 3, it is a no-op, we no longer need to offer the possibility to
configure it.
diff --git a/UPGRADE-3.0.md b/UPGRADE-3.0.md
@@ -41,6 +41,10 @@ and does not have a replacement.
 Configuration
 -------------
 
+### The `doctrine.orm.entity_managers.some_em.report_fields_where_declared` configuration option has been removed
+
+This option is a no-op when using `doctrine/orm` 3 and has been removed.
+
 ### The `doctrine.dbal.default_table_options.collate` default table option is removed
 
 Use `doctrine.dbal.default_table_options.collation` instead.
diff --git a/config/schema/doctrine-1.0.xsd b/config/schema/doctrine-1.0.xsd
@@ -234,7 +234,6 @@
         <xsd:attribute name="typed-field-mapper" type="xsd:string" />
         <xsd:attribute name="entity-listener-resolver" type="xsd:string" />
         <xsd:attribute name="repository-factory" type="xsd:string" />
-        <xsd:attribute name="report-fields-where-declared" type="xsd:boolean" />
         <xsd:attribute name="validate-xml-mapping" type="xsd:boolean" />
     </xsd:attributeGroup>
 
diff --git a/docs/en/configuration.rst b/docs/en/configuration.rst
@@ -258,8 +258,6 @@ Configuration Reference
                         class_metadata_factory_name:  Doctrine\ORM\Mapping\ClassMetadataFactory
                         default_repository_class:     Doctrine\ORM\EntityRepository
                         auto_mapping:                 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.
                         validate_xml_mapping: false
                         naming_strategy:              doctrine.orm.naming_strategy.default
@@ -513,7 +511,6 @@ Configuration Reference
                         class-metadata-factory-name="Doctrine\ORM\Mapping\ClassMetadataFactory"
                         default-repository-class="Doctrine\ORM\EntityRepository"
                         auto-mapping="false"
-                        report-fields-where-declared="false"
                         naming-strategy="doctrine.orm.naming_strategy.default"
                         quote-strategy="doctrine.orm.quote_strategy.default"
                         typed-field-mapper="doctrine.orm.typed_field_mapper.default"
@@ -671,7 +668,6 @@ the ORM resolves to:
             metadata_cache_driver: ~
             query_cache_driver: ~
             result_cache_driver: ~
-            report_fields_where_declared: false
 
 There are lots of other configuration options that you can use to overwrite
 certain classes, but those are for very advanced use-cases only.
diff --git a/src/DependencyInjection/Compiler/DoctrineOrmMappingsPass.php b/src/DependencyInjection/Compiler/DoctrineOrmMappingsPass.php
@@ -116,23 +116,22 @@ public static function createPhpMappingDriver(array $namespaces, array $managerP
     }
 
     /**
-     * @param string[]     $namespaces                List of namespaces that are handled with attribute mapping
-     * @param string[]     $directories               List of directories to look for classes with attributes
-     * @param string[]     $managerParameters         List of parameters that could which object manager name
-     *                                                your bundle uses. This compiler pass will automatically
-     *                                                append the parameter name for the default entity manager
-     *                                                to this list.
-     * @param string|false $enabledParameter          Service container parameter that must be present to
-     *                                                enable the mapping. Set to false to not do any check,
-     *                                                optional.
-     * @param string[]     $aliasMap                  Map of alias to namespace.
-     * @param bool         $reportFieldsWhereDeclared Will report fields for the classes where they are declared
+     * @param string[]     $namespaces        List of namespaces that are handled with attribute mapping
+     * @param string[]     $directories       List of directories to look for classes with attributes
+     * @param string[]     $managerParameters List of parameters that could which object manager name
+     *                                        your bundle uses. This compiler pass will automatically
+     *                                        append the parameter name for the default entity manager
+     *                                        to this list.
+     * @param string|false $enabledParameter  Service container parameter that must be present to
+     *                                        enable the mapping. Set to false to not do any check,
+     *                                        optional.
+     * @param string[]     $aliasMap          Map of alias to namespace.
      *
      * @return self
      */
-    public static function createAttributeMappingDriver(array $namespaces, array $directories, array $managerParameters = [], $enabledParameter = false, array $aliasMap = [], bool $reportFieldsWhereDeclared = false)
+    public static function createAttributeMappingDriver(array $namespaces, array $directories, array $managerParameters = [], $enabledParameter = false, array $aliasMap = [])
     {
-        $driver = new Definition(AttributeDriver::class, [$directories, $reportFieldsWhereDeclared]);
+        $driver = new Definition(AttributeDriver::class, [$directories]);
 
         return new DoctrineOrmMappingsPass($driver, $namespaces, $managerParameters, $enabledParameter, $aliasMap);
     }
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -670,26 +670,6 @@ private function getOrmEntityManagersNode(): ArrayNodeDefinition
                     ->arrayNode('schema_ignore_classes')
                         ->prototype('scalar')->end()
                     ->end()
-                    ->booleanNode('report_fields_where_declared')
-                        ->beforeNormalization()
-                            ->ifTrue(static fn ($v): bool => isset($v))
-                            ->then(static function ($v) {
-                                Deprecation::trigger(
-                                    'doctrine/doctrine-bundle',
-                                    'https://github.com/doctrine/DoctrineBundle/pull/1962',
-                                    'The "report_fields_where_declared" configuration option is deprecated and will be removed in DoctrineBundle 3.0. When using ORM 3, report_fields_where_declared will always be true.',
-                                );
-
-                                return $v;
-                            })
-                        ->end()
-                        ->defaultValue(true)
-                        ->info('Set to "true" to opt-in to the new mapping driver mode that was added in Doctrine ORM 2.16 and will be mandatory in ORM 3.0. See https://github.com/doctrine/orm/pull/10455.')
-                        ->validate()
-                            ->ifTrue(static fn (bool $v): bool => ! $v)
-                            ->thenInvalid('The setting "report_fields_where_declared" cannot be disabled for ORM 3.')
-                        ->end()
-                    ->end()
                     ->booleanNode('validate_xml_mapping')->defaultFalse()->info('Set to "true" to opt-in to the new mapping driver mode that was added in Doctrine ORM 2.14 and will be mandatory in ORM 3.0. See https://github.com/doctrine/orm/pull/6728.')->end()
                 ->end()
                 ->children()
diff --git a/src/DependencyInjection/DoctrineExtension.php b/src/DependencyInjection/DoctrineExtension.php
@@ -871,15 +871,13 @@ protected function loadOrmEntityManagerMappingInformation(array $entityManager,
             $mappingService   = $this->getObjectManagerElementName($entityManager['name'] . '_' . $driverType . '_metadata_driver');
             $mappingDriverDef = $container->getDefinition($mappingService);
             $args             = $mappingDriverDef->getArguments();
-            if ($driverType === 'attribute') {
-                $args[1] = $entityManager['report_fields_where_declared'];
-            } elseif ($driverType === 'xml') {
-                $args[1] ??= SimplifiedXmlDriver::DEFAULT_FILE_EXTENSION;
-                $args[2]   = $entityManager['validate_xml_mapping'];
-            } else {
+            if ($driverType !== 'xml') {
                 continue;
             }
 
+            $args[1] ??= SimplifiedXmlDriver::DEFAULT_FILE_EXTENSION;
+            $args[2]   = $entityManager['validate_xml_mapping'];
+
             $mappingDriverDef->setArguments($args);
         }
 
diff --git a/tests/DependencyInjection/AbstractDoctrineExtensionTestCase.php b/tests/DependencyInjection/AbstractDoctrineExtensionTestCase.php
@@ -28,7 +28,6 @@
 use Symfony\Bundle\DoctrineBundle\Tests\DependencyInjection\TestHydrator;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Cache\Adapter\PhpArrayAdapter;
-use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\Compiler\ResolveChildDefinitionsPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -562,7 +561,6 @@ public function testSingleEntityManagerMultipleMappingBundleDefinitions(): void
             [
                 __DIR__ . DIRECTORY_SEPARATOR . 'Fixtures' . DIRECTORY_SEPARATOR . 'Bundles' . DIRECTORY_SEPARATOR . 'AttributesBundle' . DIRECTORY_SEPARATOR . 'Entity',
             ],
-            true,
         ]);
 
         $xmlDef = $container->getDefinition('doctrine.orm.default_xml_metadata_driver');
@@ -915,33 +913,6 @@ public function testDisablingLazyGhostOnOrm3Throws(): void
         $this->loadContainer('orm_no_lazy_ghost');
     }
 
-    /** @group legacy */
-    public function testDisablingReportFieldsWhereDeclaredOnOrm3Throws(): void
-    {
-        if (! interface_exists(EntityManagerInterface::class)) {
-            self::markTestSkipped('This test requires ORM');
-        }
-
-        $this->expectException(InvalidConfigurationException::class);
-        $this->expectExceptionMessage('Invalid configuration for path "doctrine.orm.entity_managers.default.report_fields_where_declared": The setting "report_fields_where_declared" cannot be disabled for ORM 3.');
-        $this->loadContainer('orm_no_report_fields');
-    }
-
-    /** @group legacy */
-    public function testEnablingReportFieldsWhereDeclaredOnOrm3IsDeprecated(): void
-    {
-        if (! interface_exists(EntityManagerInterface::class)) {
-            self::markTestSkipped('This test requires ORM');
-        }
-
-        if (class_exists(AnnotationDriver::class)) {
-            self::markTestSkipped('This test requires ORM 3.');
-        }
-
-        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/DoctrineBundle/pull/1962');
-        $this->loadContainer('orm_report_fields');
-    }
-
     public function testResolveTargetEntity(): void
     {
         if (! interface_exists(EntityManagerInterface::class)) {
diff --git a/tests/DependencyInjection/Fixtures/config/xml/orm_no_report_fields.xml b/tests/DependencyInjection/Fixtures/config/xml/orm_no_report_fields.xml
diff --git a/tests/DependencyInjection/Fixtures/config/yml/orm_no_report_fields.yml b/tests/DependencyInjection/Fixtures/config/yml/orm_no_report_fields.yml
