add service factories

doctrine · May 11, 2020 · 5435638 · 5435638
1 parent 7376b1c
commit 5435638
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 0 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -68,6 +68,21 @@ public function getConfigTreeBuilder() : TreeBuilder
                     ->prototype('scalar')->end()
                 ->end()
 
+                ->arrayNode('factories')
+                    ->info('A set of callables to pass to the underlying doctrine/migrations library as services, allowing to change its behaviour.')
+                    ->useAttributeAsKey('factory')
+                    ->defaultValue([])
+                    ->validate()
+                        ->ifTrue(static function ($v) {
+                            return count(array_filter(array_keys($v), static function (string $doctrineService) : bool {
+                                return strpos($doctrineService, 'Doctrine\Migrations\\') !==0;
+                            }));
+                        })
+                        ->thenInvalid('Valid callables for the DoctrineMigrationsBundle must be in the "Doctrine\Migrations" namespace.')
+                    ->end()
+                    ->prototype('scalar')->end()
+                ->end()
+
                 ->arrayNode('storage')
                     ->addDefaultsIfNotSet()
                     ->info('Storage to use for migration status metadata.')

diff --git a/DependencyInjection/DoctrineMigrationsExtension.php b/DependencyInjection/DoctrineMigrationsExtension.php
@@ -71,6 +71,10 @@ public function load(array $configs, ContainerBuilder $container) : void
             $diDefinition->addMethodCall('setDefinition', [$doctrineId, new ServiceClosureArgument(new Reference($symfonyId))]);
         }
 
+        foreach ($config['factories'] as $doctrineId => $symfonyId) {
+            $diDefinition->addMethodCall('setDefinition', [$doctrineId, new Reference($symfonyId)]);
+        }
+
         if (! isset($config['services'][MetadataStorage::class])) {
             $storageConfiguration = $config['storage']['table_storage'];
 

diff --git a/Resources/doc/index.rst b/Resources/doc/index.rst
@@ -88,6 +88,21 @@ application:
             # Custom migration classes factory
             'Doctrine\Migrations\Version\MigrationFactory': ~
 
+        factories:
+            # Custom migration sorting service id via callables (MyCallableFactory must be a callable)
+            'Doctrine\Migrations\Version\Comparator': 'MyCallableFactory'
+
+
+
+
+- The ``services`` node allows you to provide custom services to the underlying ``DependencyFactory`` part
+of ``doctrine/migrations``.
+
+- The node ``factories`` is similar to ``services``, with the difference that it accepts only callables.
+The provided callable must return the service to be passed to the ``DependencyFactory``.
+The callable will receive as first argument the ``DependencyFactory`` itself,
+allowing you to fetch other dependencies from the factory while instantiating your custom dependencies.
+
 Usage
 -----
 

diff --git a/Tests/DependencyInjection/DoctrineMigrationsExtensionTest.php b/Tests/DependencyInjection/DoctrineMigrationsExtensionTest.php
@@ -205,6 +205,41 @@ public function __invoke() : void
         self::assertInstanceOf(DependencyFactory::class, $di);
     }
 
+    public function testServiceFactory() : void
+    {
+        $mockComparator = $this->createMock(Comparator::class);
+        $config         = [
+            'factories' => [Comparator::class => 'my_sorter'],
+        ];
+
+        $container = $this->getContainer($config);
+
+        $conn = $this->createMock(Connection::class);
+        $container->set('doctrine.dbal.default_connection', $conn);
+
+        $sorterFactory = new class($mockComparator) {
+            /** @var Comparator */
+            private $comparator;
+
+            public function __construct(Comparator $comparator)
+            {
+                $this->comparator = $comparator;
+            }
+
+            public function __invoke(DependencyFactory $di) : Comparator
+            {
+                return $this->comparator;
+            }
+        };
+        $container->set('my_sorter', $sorterFactory);
+
+        $container->compile();
+
+        $di = $container->get('doctrine.migrations.dependency_factory');
+        self::assertInstanceOf(DependencyFactory::class, $di);
+        self::assertSame($mockComparator, $di->getVersionComparator());
+    }
+
     public function testCustomConnection() : void
     {
         $config    = [