The start of something beautiful

vendor/doctrine/doctrine-migrations-bundle/DependencyInjection/DoctrineMigrationsExtension.php

@@ -0,0 +1,201 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\MigrationsBundle\DependencyInjection;
+
+use Doctrine\Bundle\MigrationsBundle\Collector\MigrationsCollector;
+use Doctrine\Bundle\MigrationsBundle\Collector\MigrationsFlattener;
+use Doctrine\Migrations\Metadata\Storage\MetadataStorage;
+use Doctrine\Migrations\Metadata\Storage\TableMetadataStorageConfiguration;
+use Doctrine\Migrations\Version\MigrationFactory;
+use InvalidArgumentException;
+use RuntimeException;
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
+use Symfony\Component\DependencyInjection\ContainerAwareInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Extension\Extension;
+use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
+use Symfony\Component\DependencyInjection\Reference;
+
+use function array_keys;
+use function assert;
+use function explode;
+use function implode;
+use function interface_exists;
+use function is_array;
+use function sprintf;
+use function strlen;
+use function substr;
+
+class DoctrineMigrationsExtension extends Extension
+{
+    /**
+     * Responds to the migrations configuration parameter.
+     *
+     * {@inheritDoc}
+     */
+    public function load(array $configs, ContainerBuilder $container): void
+    {
+        $configuration = new Configuration();
+
+        $config = $this->processConfiguration($configuration, $configs);
+
+        $locator = new FileLocator(__DIR__ . '/../Resources/config/');
+        $loader  = new XmlFileLoader($container, $locator);
+
+        $loader->load('services.xml');
+
+        $configurationDefinition = $container->getDefinition('doctrine.migrations.configuration');
+
+        foreach ($config['migrations_paths'] as $ns => $path) {
+            $path = $this->checkIfBundleRelativePath($path, $container);
+            $configurationDefinition->addMethodCall('addMigrationsDirectory', [$ns, $path]);
+        }
+
+        foreach ($config['migrations'] as $migrationClass) {
+            $configurationDefinition->addMethodCall('addMigrationClass', [$migrationClass]);
+        }
+
+        if ($config['organize_migrations'] !== false) {
+            $configurationDefinition->addMethodCall('setMigrationOrganization', [$config['organize_migrations']]);
+        }
+
+        if ($config['custom_template'] !== null) {
+            $configurationDefinition->addMethodCall('setCustomTemplate', [$config['custom_template']]);
+        }
+
+        $configurationDefinition->addMethodCall('setAllOrNothing', [$config['all_or_nothing']]);
+        $configurationDefinition->addMethodCall('setCheckDatabasePlatform', [$config['check_database_platform']]);
+
+        if ($config['enable_profiler']) {
+            $this->registerCollector($container);
+        }
+
+        $configurationDefinition->addMethodCall('setTransactional', [$config['transactional']]);
+
+        $diDefinition = $container->getDefinition('doctrine.migrations.dependency_factory');
+
+        if (! isset($config['services'][MigrationFactory::class])) {
+            $config['services'][MigrationFactory::class] = 'doctrine.migrations.migrations_factory';
+        }
+
+        foreach ($config['services'] as $doctrineId => $symfonyId) {
+            $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'];
+
+            $storageDefinition = new Definition(TableMetadataStorageConfiguration::class);
+            $container->setDefinition('doctrine.migrations.storage.table_storage', $storageDefinition);
+            $container->setAlias('doctrine.migrations.metadata_storage', 'doctrine.migrations.storage.table_storage');
+
+            if ($storageConfiguration['table_name'] !== null) {
+                $storageDefinition->addMethodCall('setTableName', [$storageConfiguration['table_name']]);
+            }
+
+            if ($storageConfiguration['version_column_name'] !== null) {
+                $storageDefinition->addMethodCall('setVersionColumnName', [$storageConfiguration['version_column_name']]);
+            }
+
+            if ($storageConfiguration['version_column_length'] !== null) {
+                $storageDefinition->addMethodCall('setVersionColumnLength', [$storageConfiguration['version_column_length']]);
+            }
+
+            if ($storageConfiguration['executed_at_column_name'] !== null) {
+                $storageDefinition->addMethodCall('setExecutedAtColumnName', [$storageConfiguration['executed_at_column_name']]);
+            }
+
+            if ($storageConfiguration['execution_time_column_name'] !== null) {
+                $storageDefinition->addMethodCall('setExecutionTimeColumnName', [$storageConfiguration['execution_time_column_name']]);
+            }
+
+            $configurationDefinition->addMethodCall('setMetadataStorageConfiguration', [new Reference('doctrine.migrations.storage.table_storage')]);
+        }
+
+        if ($config['em'] !== null && $config['connection'] !== null) {
+            throw new InvalidArgumentException(
+                'You cannot specify both "connection" and "em" in the DoctrineMigrationsBundle configurations.'
+            );
+        }
+
+        $container->setParameter('doctrine.migrations.preferred_em', $config['em']);
+        $container->setParameter('doctrine.migrations.preferred_connection', $config['connection']);
+
+        if (interface_exists(ContainerAwareInterface::class)) {
+            return;
+        }
+
+        $container->removeDefinition('doctrine.migrations.container_aware_migrations_factory');
+    }
+
+    private function checkIfBundleRelativePath(string $path, ContainerBuilder $container): string
+    {
+        if (isset($path[0]) && $path[0] === '@') {
+            $pathParts  = explode('/', $path);
+            $bundleName = substr($pathParts[0], 1);
+
+            $bundlePath = $this->getBundlePath($bundleName, $container);
+
+            return $bundlePath . substr($path, strlen('@' . $bundleName));
+        }
+
+        return $path;
+    }
+
+    private function getBundlePath(string $bundleName, ContainerBuilder $container): string
+    {
+        $bundleMetadata = $container->getParameter('kernel.bundles_metadata');
+        assert(is_array($bundleMetadata));
+
+        if (! isset($bundleMetadata[$bundleName])) {
+            throw new RuntimeException(sprintf(
+                'The bundle "%s" has not been registered, available bundles: %s',
+                $bundleName,
+                implode(', ', array_keys($bundleMetadata))
+            ));
+        }
+
+        return $bundleMetadata[$bundleName]['path'];
+    }
+
+    private function registerCollector(ContainerBuilder $container): void
+    {
+        $flattenerDefinition = new Definition(MigrationsFlattener::class);
+        $container->setDefinition('doctrine_migrations.migrations_flattener', $flattenerDefinition);
+
+        $collectorDefinition = new Definition(MigrationsCollector::class, [
+            new Reference('doctrine.migrations.dependency_factory'),
+            new Reference('doctrine_migrations.migrations_flattener'),
+        ]);
+        $collectorDefinition
+            ->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.
+     *
+     * @return string The XSD base path
+     */
+    public function getXsdValidationBasePath(): string
+    {
+        return __DIR__ . '/../Resources/config/schema';
+    }
+
+    public function getNamespace(): string
+    {
+        return 'http://symfony.com/schema/dic/doctrine/migrations/3.0';
+    }
+}