vendor/doctrine/doctrine-migrations-bundle/DependencyInjection/Configuration.php line 46

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\Bundle\MigrationsBundle\DependencyInjection;
  7. use ReflectionClass;
  8. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  9. use Symfony\Component\Config\Definition\ConfigurationInterface;
  10. use function constant;
  11. use function count;
  12. use function in_array;
  13. use function is_string;
  14. use function method_exists;
  15. use function strlen;
  16. use function strpos;
  17. use function strtoupper;
  18. use function substr;
  20. /**
  21.  * DoctrineMigrationsExtension configuration structure.
  22.  */
  23. class Configuration implements ConfigurationInterface
  24. {
  25.     /**
  26.      * Generates the configuration tree.
  27.      *
  28.      * @return TreeBuilder The config tree builder
  29.      */
  30.     public function getConfigTreeBuilder() : TreeBuilder
  31.     {
  32.         $treeBuilder = new TreeBuilder('doctrine_migrations');
  34.         if (method_exists($treeBuilder, 'getRootNode')) {
  35.             $rootNode = $treeBuilder->getRootNode();
  36.         } else {
  37.             // BC layer for symfony/config 4.1 and older
  38.             $rootNode = $treeBuilder->root('doctrine_migrations', 'array');
  39.         }
  41.         $organizeMigrationModes = $this->getOrganizeMigrationsModes();
  43.         $rootNode
  44.             ->children()
  45.                 ->scalarNode('name')
  46.                     ->setDeprecated('The "%node%" option is deprecated.')
  47.                     ->defaultValue('Application Migrations')
  48.                 ->end()
  50.                 // 3.x forward compatibility layer
  51.                 ->arrayNode('migrations_paths')
  52.                     ->info('A list of pairs namespace/path where to look for migrations.')
  53.                     ->useAttributeAsKey('name')
  54.                     ->defaultValue([])
  55.                     ->prototype('scalar')->end()
  56.                     ->validate()
  57.                         ->ifTrue(static function ($v) : bool {
  58.                             return count($v) === 0;
  59.                         })
  60.                         ->thenInvalid('At least one migration path must be specified.')
  62.                         ->ifTrue(static function ($v) : bool {
  63.                             return count($v) >  1;
  64.                         })
  65.                         ->thenInvalid('Maximum one migration path can be specified with the 2.x version.')
  66.                     ->end()
  67.                 ->end()
  69.                 ->arrayNode('storage')
  70.                     ->info('Storage to use for migration status metadata.')
  71.                     ->children()
  72.                         ->arrayNode('table_storage')
  73.                             ->info('The default metadata storage, implemented as database table.')
  74.                             ->children()
  75.                                 ->scalarNode('table_name')->defaultValue(null)->cannotBeEmpty()->end()
  76.                                 ->scalarNode('version_column_name')->defaultValue(null)->end()
  77.                                 ->scalarNode('version_column_length')
  78.                                     ->defaultValue(null)
  79.                                     ->validate()
  80.                                         ->ifTrue(static function ($v) : bool {
  81.                                             return $v < 1024;
  82.                                         })
  83.                                         ->thenInvalid('The minimum length for the version column is 1024.')
  84.                                     ->end()
  85.                                 ->end()
  86.                                 ->scalarNode('executed_at_column_name')->defaultValue(null)->end()
  87.                             ->end()
  88.                         ->end()
  89.                     ->end()
  90.                 ->end()
  92.                 ->scalarNode('dir_name')
  93.                     ->defaultValue('%kernel.root_dir%/DoctrineMigrations')->cannotBeEmpty()
  94.                     ->setDeprecated('The "%node%" option is deprecated. Use "migrations_paths" instead.')
  95.                 ->end()
  96.                 ->scalarNode('namespace')
  97.                     ->defaultValue('Application\Migrations')->cannotBeEmpty()
  98.                     ->setDeprecated('The "%node%" option is deprecated. Use "migrations_paths" instead.')
  99.                 ->end()
  100.                 ->scalarNode('table_name')
  101.                     ->defaultValue('migration_versions')->cannotBeEmpty()
  102.                     ->setDeprecated('The "%node%" option is deprecated. Use "storage.table_storage.table_name" instead.')
  103.                 ->end()
  104.                 ->scalarNode('column_name')
  105.                     ->defaultValue('version')
  106.                     ->setDeprecated('The "%node%" option is deprecated. Use "storage.table_storage.version_column_name" instead.')
  107.                 ->end()
  108.                 ->scalarNode('column_length')
  109.                     ->defaultValue(14)
  110.                     ->setDeprecated('The "%node%" option is deprecated. Use "storage.table_storage.version_column_length" instead.')
  111.                 ->end()
  112.                 ->scalarNode('executed_at_column_name')
  113.                     ->defaultValue('executed_at')
  114.                     ->setDeprecated('The "%node%" option is deprecated. Use "storage.table_storage.executed_at_column_name" instead.')
  115.                 ->end()
  116.                 ->scalarNode('all_or_nothing')->defaultValue(false)->end()
  117.                 ->scalarNode('custom_template')->defaultValue(null)->end()
  118.                 ->scalarNode('organize_migrations')->defaultValue(false)
  119.                     ->info('Organize migrations mode. Possible values are: "BY_YEAR", "BY_YEAR_AND_MONTH", false')
  120.                     ->validate()
  121.                         ->ifTrue(static function ($v) use ($organizeMigrationModes) {
  122.                             if ($v === false) {
  123.                                 return false;
  124.                             }
  126.                             if (is_string($v) && in_array(strtoupper($v), $organizeMigrationModes)) {
  127.                                 return false;
  128.                             }
  130.                             return true;
  131.                         })
  132.                         ->thenInvalid('Invalid organize migrations mode value %s')
  133.                     ->end()
  134.                     ->validate()
  135.                         ->ifString()
  136.                             ->then(static function ($v) {
  137.                                 return constant('Doctrine\Migrations\Configuration\Configuration::VERSIONS_ORGANIZATION_' . strtoupper($v));
  138.                             })
  139.                     ->end()
  140.                 ->end()
  141.             ->end();
  143.         return $treeBuilder;
  144.     }
  147.     /**
  148.      * Find organize migrations modes for their names
  149.      *
  150.      * @return string[]
  151.      */
  152.     private function getOrganizeMigrationsModes() : array
  153.     {
  154.         $constPrefix = 'VERSIONS_ORGANIZATION_';
  155.         $prefixLen   = strlen($constPrefix);
  156.         $refClass    = new ReflectionClass('Doctrine\Migrations\Configuration\Configuration');
  157.         $constsArray = $refClass->getConstants();
  158.         $namesArray  = [];
  160.         foreach ($constsArray as $key => $value) {
  161.             if (strpos($key, $constPrefix) !== 0) {
  162.                 continue;
  163.             }
  165.             $namesArray[] = substr($key, $prefixLen);
  166.         }
  168.         return $namesArray;
  169.     }
  170. }