introduce config flag to enable/disable collector

Author: chr-hertel

DependencyInjection/Configuration.php

@@ -147,6 +147,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                             })
                     ->end()
                 ->end()
+                ->booleanNode('enable_profiler')
+                    ->info('Use profiler to calculate and visualize migration status.')
+                    ->defaultTrue()
+                ->end()
             ->end();
 
         return $treeBuilder;

DependencyInjection/DoctrineMigrationsExtension.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\Bundle\MigrationsBundle\DependencyInjection;
 
+use Doctrine\Bundle\MigrationsBundle\Collector\MigrationsCollector;
 use Doctrine\Migrations\Metadata\Storage\MetadataStorage;
 use Doctrine\Migrations\Metadata\Storage\TableMetadataStorageConfiguration;
 use Doctrine\Migrations\Version\MigrationFactory;
@@ -71,6 +72,10 @@ public function load(array $configs, ContainerBuilder $container): void
         $configurationDefinition->addMethodCall('setAllOrNothing', [$config['all_or_nothing']]);
         $configurationDefinition->addMethodCall('setCheckDatabasePlatform', [$config['check_database_platform']]);
 
+        if ($config['enable_profiler']) {
+            $this->registerCollector($container);
+        }
+
         $diDefinition = $container->getDefinition('doctrine.migrations.dependency_factory');
 
         if (! isset($config['services'][MigrationFactory::class])) {
@@ -155,6 +160,19 @@ private function getBundlePath(string $bundleName, ContainerBuilder $container):
         return $bundleMetadata[$bundleName]['path'];
     }
 
+    private function registerCollector(ContainerBuilder $container): void
+    {
+        $collectorDefinition = new Definition(MigrationsCollector::class);
+        $collectorDefinition
+            ->addArgument(new Reference('doctrine.migrations.dependency_factory'))
+            ->addTag('data_collector', [
+                'template' => '@DoctrineMigrations/Collector/migrations.html.twig',
+                'id' => 'doctrine_migrations',
+                'priority' => '249',
+            ]);
+        $container->setDefinition('doctrine_migrations.migrations_collector', $collectorDefinition);
+    }
+
     /**
      * Returns the base path for the XSD files.
      *

Resources/config/services.xml

@@ -141,11 +141,6 @@
             <tag name="console.command" command="doctrine:migrations:version" />
         </service>
 
-        <service id="doctrine_migrations.migrations_collector" class="Doctrine\Bundle\MigrationsBundle\Collector\MigrationsCollector">
-            <argument type="service" id="doctrine.migrations.dependency_factory"/>
-            <tag name="data_collector" template="@DoctrineMigrations/Collector/migrations.html.twig" id="doctrine_migrations" priority="249" />
-        </service>
-
     </services>
 
 </container>