Feature: support for $pathsAsFilePaths

This commit adds support for a `$pathsAsFilePaths` parameter,
introduced as part of doctrine/orm#12106

It adds a minor BC break (as well as was in the case of
`$reportFieldsWhereDeclared` - `8d8579`) - classes,
extending `DoctrineOrmMappingsPass` that override
`createAttributeMappingDriver()` method will face signature mismatch.

Author: rela589n

src/DependencyInjection/Compiler/DoctrineOrmMappingsPass.php

@@ -141,23 +141,25 @@ public static function createAnnotationMappingDriver(array $namespaces, array $d
     }
 
     /**
-     * @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 iterable<string> $paths                     Iterable of source file path names (if {@see $pathsAsFilePaths}),
+     *                                                    or an array of directories where mapping classes can be found.
+     * @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 bool             $pathsAsFilePaths          whether {@see $paths} are paths to files or directories
      *
      * @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, iterable $paths, array $managerParameters = [], $enabledParameter = false, array $aliasMap = [], bool $reportFieldsWhereDeclared = false, bool $pathsAsFilePaths = false): self
     {
-        $driver = new Definition(AttributeDriver::class, [$directories, $reportFieldsWhereDeclared]);
+        $driver = new Definition(AttributeDriver::class, [$paths, $reportFieldsWhereDeclared, $pathsAsFilePaths]);
 
         return new DoctrineOrmMappingsPass($driver, $namespaces, $managerParameters, $enabledParameter, $aliasMap);
     }

src/DependencyInjection/DoctrineExtension.php

@@ -38,6 +38,7 @@
 use Doctrine\ORM\Tools\Console\Command\EnsureProductionSettingsCommand;
 use Doctrine\ORM\Tools\Export\ClassMetadataExporter;
 use Doctrine\ORM\UnitOfWork;
+use Doctrine\Persistence\Mapping\Driver\FilePathNameIterator;
 use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
 use Doctrine\Persistence\Mapping\Driver\PHPDriver;
 use Doctrine\Persistence\Mapping\Driver\StaticPHPDriver;
@@ -61,6 +62,7 @@
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
+use Symfony\Component\Finder\Finder;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Messenger\Bridge\Doctrine\Transport\DoctrineTransportFactory;
 use Symfony\Component\Messenger\MessageBusInterface;
@@ -881,6 +883,12 @@ protected function loadOrmEntityManagerMappingInformation(array $entityManager,
                 $args[2] = $entityManager['report_fields_where_declared'];
             } elseif ($driverType === 'attribute') {
                 $args[1] = $entityManager['report_fields_where_declared'];
+
+                /** @var string[] $directoryPaths */
+                $directoryPaths = $args[0];
+                $filesIterator = $this->registerFilesIteratorService($entityManager['name'] . '_' . $driverType, $container, $directoryPaths);
+
+                $args[0] = new Reference($filesIterator);
             } elseif ($driverType === 'xml') {
                 $args[1] ??= SimplifiedXmlDriver::DEFAULT_FILE_EXTENSION;
                 $args[2]   = $entityManager['validate_xml_mapping'];
@@ -894,6 +902,29 @@ protected function loadOrmEntityManagerMappingInformation(array $entityManager,
         $ormConfigDef->addMethodCall('setEntityNamespaces', [$this->aliasMap]);
     }
 
+    /** @param string[] $dirs */
+    private function registerFilesIteratorService(string $servicePrefix, ContainerBuilder $container, array $dirs): string
+    {
+        $finderService = $this->getObjectManagerElementName($servicePrefix.'_mapping_files_finder');
+
+        if ($container->hasDefinition($finderService)) {
+            $finderDefinition = $container->getDefinition($finderService);
+        } else {
+            $finderDefinition = new Definition(Finder::class, []);
+        }
+
+        $finderDefinition->addMethodCall('files');
+        $finderDefinition->addMethodCall('in', [$dirs]);
+        $finderDefinition->addMethodCall('name', ['*.php']);
+
+        $container->setDefinition($finderService, $finderDefinition);
+
+        $filesIterator = $this->getObjectManagerElementName($servicePrefix.'_mapping_files_iterator');
+        $container->setDefinition($filesIterator, new Definition(FilePathNameIterator::class, [new Reference($finderService)]));
+
+        return $filesIterator;
+    }
+
     /**
      * Loads an ORM second level cache bundle mapping information.
      *