vendor/doctrine/doctrine-bundle/DependencyInjection/Configuration.php line 401

  1. <?php
  3. namespace Doctrine\Bundle\DoctrineBundle\DependencyInjection;
  5. use Doctrine\Common\Proxy\AbstractProxyFactory;
  6. use Doctrine\ORM\EntityManager;
  7. use Doctrine\ORM\EntityRepository;
  8. use Doctrine\ORM\Mapping\ClassMetadataFactory;
  9. use ReflectionClass;
  10. use Symfony\Component\Config\Definition\BaseNode;
  11. use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
  12. use Symfony\Component\Config\Definition\Builder\NodeDefinition;
  13. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  14. use Symfony\Component\Config\Definition\ConfigurationInterface;
  15. use Symfony\Component\DependencyInjection\Exception\LogicException;
  17. use function array_intersect_key;
  18. use function array_key_exists;
  19. use function array_keys;
  20. use function array_pop;
  21. use function assert;
  22. use function class_exists;
  23. use function constant;
  24. use function count;
  25. use function defined;
  26. use function implode;
  27. use function in_array;
  28. use function is_array;
  29. use function is_bool;
  30. use function is_int;
  31. use function is_string;
  32. use function key;
  33. use function method_exists;
  34. use function reset;
  35. use function sprintf;
  36. use function strlen;
  37. use function strpos;
  38. use function strtoupper;
  39. use function substr;
  40. use function trigger_deprecation;
  42. /**
  43.  * This class contains the configuration information for the bundle
  44.  *
  45.  * This information is solely responsible for how the different configuration
  46.  * sections are normalized, and merged.
  47.  */
  48. class Configuration implements ConfigurationInterface
  49. {
  50.     /** @var bool */
  51.     private $debug;
  53.     /** @param bool $debug Whether to use the debug mode */
  54.     public function __construct(bool $debug)
  55.     {
  56.         $this->debug = $debug;
  57.     }
  59.     public function getConfigTreeBuilder(): TreeBuilder
  60.     {
  61.         $treeBuilder = new TreeBuilder('doctrine');
  62.         $rootNode    = $treeBuilder->getRootNode();
  64.         $this->addDbalSection($rootNode);
  65.         $this->addOrmSection($rootNode);
  67.         return $treeBuilder;
  68.     }
  70.     /**
  71.      * Add DBAL section to configuration tree
  72.      */
  73.     private function addDbalSection(ArrayNodeDefinition $node): void
  74.     {
  75.         $node
  76.             ->children()
  77.             ->arrayNode('dbal')
  78.                 ->beforeNormalization()
  79.                     ->ifTrue(static function ($v) {
  80.                         return is_array($v) && ! array_key_exists('connections', $v) && ! array_key_exists('connection', $v);
  81.                     })
  82.                     ->then(static function ($v) {
  83.                         // Key that should not be rewritten to the connection config
  84.                         $excludedKeys = ['default_connection' => true, 'types' => true, 'type' => true];
  85.                         $connection   = [];
  86.                         foreach ($v as $key => $value) {
  87.                             if (isset($excludedKeys[$key])) {
  88.                                 continue;
  89.                             }
  91.                             $connection[$key] = $v[$key];
  92.                             unset($v[$key]);
  93.                         }
  95.                         $v['default_connection'] = isset($v['default_connection']) ? (string) $v['default_connection'] : 'default';
  96.                         $v['connections']        = [$v['default_connection'] => $connection];
  98.                         return $v;
  99.                     })
  100.                 ->end()
  101.                 ->children()
  102.                     ->scalarNode('default_connection')->end()
  103.                 ->end()
  104.                 ->fixXmlConfig('type')
  105.                 ->children()
  106.                     ->arrayNode('types')
  107.                         ->useAttributeAsKey('name')
  108.                         ->prototype('array')
  109.                             ->beforeNormalization()
  110.                                 ->ifString()
  111.                                 ->then(static function ($v) {
  112.                                     return ['class' => $v];
  113.                                 })
  114.                             ->end()
  115.                             ->children()
  116.                                 ->scalarNode('class')->isRequired()->end()
  117.                                 ->booleanNode('commented')
  118.                                     ->setDeprecated(
  119.                                         ...$this->getDeprecationMsg('The doctrine-bundle type commenting features were removed; the corresponding config parameter was deprecated in 2.0 and will be dropped in 3.0.', '2.0')
  120.                                     )
  121.                                 ->end()
  122.                             ->end()
  123.                         ->end()
  124.                     ->end()
  125.                 ->end()
  126.                 ->fixXmlConfig('connection')
  127.                 ->append($this->getDbalConnectionsNode())
  128.             ->end();
  129.     }
  131.     /**
  132.      * Return the dbal connections node
  133.      */
  134.     private function getDbalConnectionsNode(): ArrayNodeDefinition
  135.     {
  136.         $treeBuilder = new TreeBuilder('connections');
  137.         $node        = $treeBuilder->getRootNode();
  139.         $connectionNode = $node
  140.             ->requiresAtLeastOneElement()
  141.             ->useAttributeAsKey('name')
  142.             ->prototype('array');
  143.         assert($connectionNode instanceof ArrayNodeDefinition);
  145.         $this->configureDbalDriverNode($connectionNode);
  147.         $collationKey = defined('Doctrine\DBAL\Connection::PARAM_ASCII_STR_ARRAY')
  148.             ? 'collate'
  149.             : 'collation';
  151.         $connectionNode
  152.             ->fixXmlConfig('option')
  153.             ->fixXmlConfig('mapping_type')
  154.             ->fixXmlConfig('slave')
  155.             ->fixXmlConfig('replica')
  156.             ->fixXmlConfig('shard')
  157.             ->fixXmlConfig('default_table_option')
  158.             ->children()
  159.                 ->scalarNode('driver')->defaultValue('pdo_mysql')->end()
  160.                 ->scalarNode('platform_service')->end()
  161.                 ->booleanNode('auto_commit')->end()
  162.                 ->scalarNode('schema_filter')->end()
  163.                 ->booleanNode('logging')->defaultValue($this->debug)->end()
  164.                 ->booleanNode('profiling')->defaultValue($this->debug)->end()
  165.                 ->booleanNode('profiling_collect_backtrace')
  166.                     ->defaultValue(false)
  167.                     ->info('Enables collecting backtraces when profiling is enabled')
  168.                 ->end()
  169.                 ->booleanNode('profiling_collect_schema_errors')
  170.                     ->defaultValue(true)
  171.                     ->info('Enables collecting schema errors when profiling is enabled')
  172.                 ->end()
  173.                 ->scalarNode('server_version')->end()
  174.                 ->scalarNode('driver_class')->end()
  175.                 ->scalarNode('wrapper_class')->end()
  176.                 ->scalarNode('shard_manager_class')
  177.                     ->setDeprecated(
  178.                         ...$this->getDeprecationMsg('The "shard_manager_class" configuration is deprecated and not supported anymore using DBAL 3.', '2.7')
  179.                     )
  180.                 ->end()
  181.                 ->scalarNode('shard_choser')
  182.                     ->setDeprecated(
  183.                         ...$this->getDeprecationMsg('The "shard_choser" configuration is deprecated and not supported anymore using DBAL 3.', '2.7')
  184.                     )
  185.                 ->end()
  186.                 ->scalarNode('shard_choser_service')
  187.                     ->setDeprecated(
  188.                         ...$this->getDeprecationMsg('The "shard_choser_service" configuration is deprecated and not supported anymore using DBAL 3.', '2.7')
  189.                     )
  190.                 ->end()
  191.                 ->booleanNode('keep_slave')
  192.                     ->setDeprecated(
  193.                         ...$this->getDeprecationMsg('The "keep_slave" configuration key is deprecated since doctrine-bundle 2.2. Use the "keep_replica" configuration key instead.', '2.2')
  194.                     )
  195.                 ->end()
  196.                 ->booleanNode('keep_replica')->end()
  197.                 ->arrayNode('options')
  198.                     ->useAttributeAsKey('key')
  199.                     ->prototype('variable')->end()
  200.                 ->end()
  201.                 ->arrayNode('mapping_types')
  202.                     ->useAttributeAsKey('name')
  203.                     ->prototype('scalar')->end()
  204.                 ->end()
  205.                 ->arrayNode('default_table_options')
  206.                 ->info(sprintf(
  207.                     "This option is used by the schema-tool and affects generated SQL. Possible keys include 'charset','%s', and 'engine'.",
  208.                     $collationKey
  209.                 ))
  210.                     ->useAttributeAsKey('name')
  211.                     ->prototype('scalar')->end()
  212.                 ->end()
  213.             ->end();
  215.         // dbal < 2.11
  216.         $slaveNode = $connectionNode
  217.             ->children()
  218.                 ->arrayNode('slaves')
  219.                     ->setDeprecated(
  220.                         ...$this->getDeprecationMsg('The "slaves" configuration key will be renamed to "replicas" in doctrine-bundle 3.0. "slaves" is deprecated since doctrine-bundle 2.2.', '2.2')
  221.                     )
  222.                     ->useAttributeAsKey('name')
  223.                     ->prototype('array');
  224.         $this->configureDbalDriverNode($slaveNode);
  226.         // dbal >= 2.11
  227.         $replicaNode = $connectionNode
  228.             ->children()
  229.                 ->arrayNode('replicas')
  230.                     ->useAttributeAsKey('name')
  231.                     ->prototype('array');
  232.         $this->configureDbalDriverNode($replicaNode);
  234.         $shardNode = $connectionNode
  235.             ->children()
  236.                 ->arrayNode('shards')
  237.                     ->setDeprecated(
  238.                         ...$this->getDeprecationMsg('The "shards" configuration is deprecated and not supported anymore using DBAL 3.', '2.7')
  239.                     )
  240.                     ->prototype('array');
  242.         $shardNode
  243.             ->children()
  244.                 ->integerNode('id')
  245.                     ->min(1)
  246.                     ->isRequired()
  247.                 ->end()
  248.             ->end();
  249.         $this->configureDbalDriverNode($shardNode);
  251.         return $node;
  252.     }
  254.     /**
  255.      * Adds config keys related to params processed by the DBAL drivers
  256.      *
  257.      * These keys are available for replica configurations too.
  258.      */
  259.     private function configureDbalDriverNode(ArrayNodeDefinition $node): void
  260.     {
  261.         $node
  262.             ->validate()
  263.             ->always(static function (array $values) {
  264.                 if (! isset($values['url'])) {
  265.                     return $values;
  266.                 }
  268.                 $urlConflictingOptions = ['host' => true, 'port' => true, 'user' => true, 'password' => true, 'path' => true, 'dbname' => true, 'unix_socket' => true, 'memory' => true];
  269.                 $urlConflictingValues  = array_keys(array_intersect_key($values, $urlConflictingOptions));
  271.                 if ($urlConflictingValues) {
  272.                     $tail = count($urlConflictingValues) > 1 ? sprintf('or "%s" options', array_pop($urlConflictingValues)) : 'option';
  273.                     trigger_deprecation(
  274.                         'doctrine/doctrine-bundle',
  275.                         '2.4',
  276.                         'Setting the "doctrine.dbal.%s" %s while the "url" one is defined is deprecated',
  277.                         implode('", "', $urlConflictingValues),
  278.                         $tail
  279.                     );
  280.                 }
  282.                 return $values;
  283.             })
  284.             ->end()
  285.             ->children()
  286.                 ->scalarNode('url')->info('A URL with connection information; any parameter value parsed from this string will override explicitly set parameters')->end()
  287.                 ->scalarNode('dbname')->end()
  288.                 ->scalarNode('host')->info('Defaults to "localhost" at runtime.')->end()
  289.                 ->scalarNode('port')->info('Defaults to null at runtime.')->end()
  290.                 ->scalarNode('user')->info('Defaults to "root" at runtime.')->end()
  291.                 ->scalarNode('password')->info('Defaults to null at runtime.')->end()
  292.                 ->booleanNode('override_url')->setDeprecated(...$this->getDeprecationMsg('The "doctrine.dbal.override_url" configuration key is deprecated.', '2.4'))->end()
  293.                 ->scalarNode('dbname_suffix')->end()
  294.                 ->scalarNode('application_name')->end()
  295.                 ->scalarNode('charset')->end()
  296.                 ->scalarNode('path')->end()
  297.                 ->booleanNode('memory')->end()
  298.                 ->scalarNode('unix_socket')->info('The unix socket to use for MySQL')->end()
  299.                 ->booleanNode('persistent')->info('True to use as persistent connection for the ibm_db2 driver')->end()
  300.                 ->scalarNode('protocol')->info('The protocol to use for the ibm_db2 driver (default to TCPIP if omitted)')->end()
  301.                 ->booleanNode('service')
  302.                     ->info('True to use SERVICE_NAME as connection parameter instead of SID for Oracle')
  303.                 ->end()
  304.                 ->scalarNode('servicename')
  305.                     ->info(
  306.                         'Overrules dbname parameter if given and used as SERVICE_NAME or SID connection parameter ' .
  307.                         'for Oracle depending on the service parameter.'
  308.                     )
  309.                 ->end()
  310.                 ->scalarNode('sessionMode')
  311.                     ->info('The session mode to use for the oci8 driver')
  312.                 ->end()
  313.                 ->scalarNode('server')
  314.                     ->info('The name of a running database server to connect to for SQL Anywhere.')
  315.                 ->end()
  316.                 ->scalarNode('default_dbname')
  317.                     ->info(
  318.                         'Override the default database (postgres) to connect to for PostgreSQL connexion.'
  319.                     )
  320.                 ->end()
  321.                 ->scalarNode('sslmode')
  322.                     ->info(
  323.                         'Determines whether or with what priority a SSL TCP/IP connection will be negotiated with ' .
  324.                         'the server for PostgreSQL.'
  325.                     )
  326.                 ->end()
  327.                 ->scalarNode('sslrootcert')
  328.                     ->info(
  329.                         'The name of a file containing SSL certificate authority (CA) certificate(s). ' .
  330.                         'If the file exists, the server\'s certificate will be verified to be signed by one of these authorities.'
  331.                     )
  332.                 ->end()
  333.                 ->scalarNode('sslcert')
  334.                     ->info(
  335.                         'The path to the SSL client certificate file for PostgreSQL.'
  336.                     )
  337.                 ->end()
  338.                 ->scalarNode('sslkey')
  339.                     ->info(
  340.                         'The path to the SSL client key file for PostgreSQL.'
  341.                     )
  342.                 ->end()
  343.                 ->scalarNode('sslcrl')
  344.                     ->info(
  345.                         'The file name of the SSL certificate revocation list for PostgreSQL.'
  346.                     )
  347.                 ->end()
  348.                 ->booleanNode('pooled')->info('True to use a pooled server with the oci8/pdo_oracle driver')->end()
  349.                 ->booleanNode('MultipleActiveResultSets')->info('Configuring MultipleActiveResultSets for the pdo_sqlsrv driver')->end()
  350.                 ->booleanNode('use_savepoints')->info('Use savepoints for nested transactions')->end()
  351.                 ->scalarNode('instancename')
  352.                 ->info(
  353.                     'Optional parameter, complete whether to add the INSTANCE_NAME parameter in the connection.' .
  354.                     ' It is generally used to connect to an Oracle RAC server to select the name' .
  355.                     ' of a particular instance.'
  356.                 )
  357.                 ->end()
  358.                 ->scalarNode('connectstring')
  359.                 ->info(
  360.                     'Complete Easy Connect connection descriptor, see https://docs.oracle.com/database/121/NETAG/naming.htm.' .
  361.                     'When using this option, you will still need to provide the user and password parameters, but the other ' .
  362.                     'parameters will no longer be used. Note that when using this parameter, the getHost and getPort methods' .
  363.                     ' from Doctrine\DBAL\Connection will no longer function as expected.'
  364.                 )
  365.                 ->end()
  366.             ->end()
  367.             ->beforeNormalization()
  368.                 ->ifTrue(static function ($v) {
  369.                     return ! isset($v['sessionMode']) && isset($v['session_mode']);
  370.                 })
  371.                 ->then(static function ($v) {
  372.                     $v['sessionMode'] = $v['session_mode'];
  373.                     unset($v['session_mode']);
  375.                     return $v;
  376.                 })
  377.             ->end()
  378.             ->beforeNormalization()
  379.                 ->ifTrue(static function ($v) {
  380.                     return ! isset($v['MultipleActiveResultSets']) && isset($v['multiple_active_result_sets']);
  381.                 })
  382.                 ->then(static function ($v) {
  383.                     $v['MultipleActiveResultSets'] = $v['multiple_active_result_sets'];
  384.                     unset($v['multiple_active_result_sets']);
  386.                     return $v;
  387.                 })
  388.             ->end();
  389.     }
  391.     /**
  392.      * Add the ORM section to configuration tree
  393.      */
  394.     private function addOrmSection(ArrayNodeDefinition $node): void
  395.     {
  396.         $node
  397.             ->children()
  398.                 ->arrayNode('orm')
  399.                     ->beforeNormalization()
  400.                         ->ifTrue(static function ($v) {
  401.                             if (! empty($v) && ! class_exists(EntityManager::class)) {
  402.                                 throw new LogicException('The doctrine/orm package is required when the doctrine.orm config is set.');
  403.                             }
  405.                             return $v === null || (is_array($v) && ! array_key_exists('entity_managers', $v) && ! array_key_exists('entity_manager', $v));
  406.                         })
  407.                         ->then(static function ($v) {
  408.                             $v = (array) $v;
  409.                             // Key that should not be rewritten to the connection config
  410.                             $excludedKeys  = [
  411.                                 'default_entity_manager' => true,
  412.                                 'auto_generate_proxy_classes' => true,
  413.                                 'proxy_dir' => true,
  414.                                 'proxy_namespace' => true,
  415.                                 'resolve_target_entities' => true,
  416.                                 'resolve_target_entity' => true,
  417.                             ];
  418.                             $entityManager = [];
  419.                             foreach ($v as $key => $value) {
  420.                                 if (isset($excludedKeys[$key])) {
  421.                                     continue;
  422.                                 }
  424.                                 $entityManager[$key] = $v[$key];
  425.                                 unset($v[$key]);
  426.                             }
  428.                             $v['default_entity_manager'] = isset($v['default_entity_manager']) ? (string) $v['default_entity_manager'] : 'default';
  429.                             $v['entity_managers']        = [$v['default_entity_manager'] => $entityManager];
  431.                             return $v;
  432.                         })
  433.                     ->end()
  434.                     ->children()
  435.                         ->scalarNode('default_entity_manager')->end()
  436.                         ->scalarNode('auto_generate_proxy_classes')->defaultValue(false)
  437.                             ->info('Auto generate mode possible values are: "NEVER", "ALWAYS", "FILE_NOT_EXISTS", "EVAL", "FILE_NOT_EXISTS_OR_CHANGED"')
  438.                             ->validate()
  439.                                 ->ifTrue(function ($v) {
  440.                                     $generationModes = $this->getAutoGenerateModes();
  442.                                     if (is_int($v) && in_array($v, $generationModes['values']/*array(0, 1, 2, 3)*/)) {
  443.                                         return false;
  444.                                     }
  446.                                     if (is_bool($v)) {
  447.                                         return false;
  448.                                     }
  450.                                     if (is_string($v)) {
  451.                                         if (in_array(strtoupper($v), $generationModes['names']/*array('NEVER', 'ALWAYS', 'FILE_NOT_EXISTS', 'EVAL', 'FILE_NOT_EXISTS_OR_CHANGED')*/)) {
  452.                                             return false;
  453.                                         }
  454.                                     }
  456.                                     return true;
  457.                                 })
  458.                                 ->thenInvalid('Invalid auto generate mode value %s')
  459.                             ->end()
  460.                             ->validate()
  461.                                 ->ifString()
  462.                                 ->then(static function ($v) {
  463.                                     return constant('Doctrine\Common\Proxy\AbstractProxyFactory::AUTOGENERATE_' . strtoupper($v));
  464.                                 })
  465.                             ->end()
  466.                         ->end()
  467.                         ->scalarNode('proxy_dir')->defaultValue('%kernel.cache_dir%/doctrine/orm/Proxies')->end()
  468.                         ->scalarNode('proxy_namespace')->defaultValue('Proxies')->end()
  469.                     ->end()
  470.                     ->fixXmlConfig('entity_manager')
  471.                     ->append($this->getOrmEntityManagersNode())
  472.                     ->fixXmlConfig('resolve_target_entity', 'resolve_target_entities')
  473.                     ->append($this->getOrmTargetEntityResolverNode())
  474.                 ->end()
  475.             ->end();
  476.     }
  478.     /**
  479.      * Return ORM target entity resolver node
  480.      */
  481.     private function getOrmTargetEntityResolverNode(): NodeDefinition
  482.     {
  483.         $treeBuilder = new TreeBuilder('resolve_target_entities');
  484.         $node        = $treeBuilder->getRootNode();
  486.         $node
  487.             ->useAttributeAsKey('interface')
  488.             ->prototype('scalar')
  489.                 ->cannotBeEmpty()
  490.             ->end();
  492.         return $node;
  493.     }
  495.     /**
  496.      * Return ORM entity listener node
  497.      */
  498.     private function getOrmEntityListenersNode(): NodeDefinition
  499.     {
  500.         $treeBuilder = new TreeBuilder('entity_listeners');
  501.         $node        = $treeBuilder->getRootNode();
  503.         $normalizer = static function ($mappings) {
  504.             $entities = [];
  506.             foreach ($mappings as $entityClass => $mapping) {
  507.                 $listeners = [];
  509.                 foreach ($mapping as $listenerClass => $listenerEvent) {
  510.                     $events = [];
  512.                     foreach ($listenerEvent as $eventType => $eventMapping) {
  513.                         if ($eventMapping === null) {
  514.                             $eventMapping = [null];
  515.                         }
  517.                         foreach ($eventMapping as $method) {
  518.                             $events[] = [
  519.                                 'type' => $eventType,
  520.                                 'method' => $method,
  521.                             ];
  522.                         }
  523.                     }
  525.                     $listeners[] = [
  526.                         'class' => $listenerClass,
  527.                         'event' => $events,
  528.                     ];
  529.                 }
  531.                 $entities[] = [
  532.                     'class' => $entityClass,
  533.                     'listener' => $listeners,
  534.                 ];
  535.             }
  537.             return ['entities' => $entities];
  538.         };
  540.         $node
  541.             ->beforeNormalization()
  542.                 // Yaml normalization
  543.                 ->ifTrue(static function ($v) {
  544.                     return is_array(reset($v)) && is_string(key(reset($v)));
  545.                 })
  546.                 ->then($normalizer)
  547.             ->end()
  548.             ->fixXmlConfig('entity', 'entities')
  549.             ->children()
  550.                 ->arrayNode('entities')
  551.                     ->useAttributeAsKey('class')
  552.                     ->prototype('array')
  553.                         ->fixXmlConfig('listener')
  554.                         ->children()
  555.                             ->arrayNode('listeners')
  556.                                 ->useAttributeAsKey('class')
  557.                                 ->prototype('array')
  558.                                     ->fixXmlConfig('event')
  559.                                     ->children()
  560.                                         ->arrayNode('events')
  561.                                             ->prototype('array')
  562.                                                 ->children()
  563.                                                     ->scalarNode('type')->end()
  564.                                                     ->scalarNode('method')->defaultNull()->end()
  565.                                                 ->end()
  566.                                             ->end()
  567.                                         ->end()
  568.                                     ->end()
  569.                                 ->end()
  570.                             ->end()
  571.                         ->end()
  572.                     ->end()
  573.                 ->end()
  574.             ->end();
  576.         return $node;
  577.     }
  579.     /**
  580.      * Return ORM entity manager node
  581.      */
  582.     private function getOrmEntityManagersNode(): ArrayNodeDefinition
  583.     {
  584.         $treeBuilder = new TreeBuilder('entity_managers');
  585.         $node        = $treeBuilder->getRootNode();
  587.         $node
  588.             ->requiresAtLeastOneElement()
  589.             ->useAttributeAsKey('name')
  590.             ->prototype('array')
  591.                 ->addDefaultsIfNotSet()
  592.                 ->append($this->getOrmCacheDriverNode('query_cache_driver'))
  593.                 ->append($this->getOrmCacheDriverNode('metadata_cache_driver'))
  594.                 ->append($this->getOrmCacheDriverNode('result_cache_driver'))
  595.                 ->append($this->getOrmEntityListenersNode())
  596.                 ->fixXmlConfig('schema_ignore_class', 'schema_ignore_classes')
  597.                 ->children()
  598.                     ->scalarNode('connection')->end()
  599.                     ->scalarNode('class_metadata_factory_name')->defaultValue(ClassMetadataFactory::class)->end()
  600.                     ->scalarNode('default_repository_class')->defaultValue(EntityRepository::class)->end()
  601.                     ->scalarNode('auto_mapping')->defaultFalse()->end()
  602.                     ->scalarNode('naming_strategy')->defaultValue('doctrine.orm.naming_strategy.default')->end()
  603.                     ->scalarNode('quote_strategy')->defaultValue('doctrine.orm.quote_strategy.default')->end()
  604.                     ->scalarNode('entity_listener_resolver')->defaultNull()->end()
  605.                     ->scalarNode('repository_factory')->defaultValue('doctrine.orm.container_repository_factory')->end()
  606.                     ->arrayNode('schema_ignore_classes')
  607.                         ->prototype('scalar')->end()
  608.                     ->end()
  609.                 ->end()
  610.                 ->children()
  611.                     ->arrayNode('second_level_cache')
  612.                         ->children()
  613.                             ->append($this->getOrmCacheDriverNode('region_cache_driver'))
  614.                             ->scalarNode('region_lock_lifetime')->defaultValue(60)->end()
  615.                             ->booleanNode('log_enabled')->defaultValue($this->debug)->end()
  616.                             ->scalarNode('region_lifetime')->defaultValue(3600)->end()
  617.                             ->booleanNode('enabled')->defaultValue(true)->end()
  618.                             ->scalarNode('factory')->end()
  619.                         ->end()
  620.                         ->fixXmlConfig('region')
  621.                         ->children()
  622.                             ->arrayNode('regions')
  623.                                 ->useAttributeAsKey('name')
  624.                                 ->prototype('array')
  625.                                     ->children()
  626.                                         ->append($this->getOrmCacheDriverNode('cache_driver'))
  627.                                         ->scalarNode('lock_path')->defaultValue('%kernel.cache_dir%/doctrine/orm/slc/filelock')->end()
  628.                                         ->scalarNode('lock_lifetime')->defaultValue(60)->end()
  629.                                         ->scalarNode('type')->defaultValue('default')->end()
  630.                                         ->scalarNode('lifetime')->defaultValue(0)->end()
  631.                                         ->scalarNode('service')->end()
  632.                                         ->scalarNode('name')->end()
  633.                                     ->end()
  634.                                 ->end()
  635.                             ->end()
  636.                         ->end()
  637.                         ->fixXmlConfig('logger')
  638.                         ->children()
  639.                             ->arrayNode('loggers')
  640.                                 ->useAttributeAsKey('name')
  641.                                 ->prototype('array')
  642.                                     ->children()
  643.                                         ->scalarNode('name')->end()
  644.                                         ->scalarNode('service')->end()
  645.                                     ->end()
  646.                                 ->end()
  647.                             ->end()
  648.                         ->end()
  649.                     ->end()
  650.                 ->end()
  651.                 ->fixXmlConfig('hydrator')
  652.                 ->children()
  653.                     ->arrayNode('hydrators')
  654.                         ->useAttributeAsKey('name')
  655.                         ->prototype('scalar')->end()
  656.                     ->end()
  657.                 ->end()
  658.                 ->fixXmlConfig('mapping')
  659.                 ->children()
  660.                     ->arrayNode('mappings')
  661.                         ->useAttributeAsKey('name')
  662.                         ->prototype('array')
  663.                             ->beforeNormalization()
  664.                                 ->ifString()
  665.                                 ->then(static function ($v) {
  666.                                     return ['type' => $v];
  667.                                 })
  668.                             ->end()
  669.                             ->treatNullLike([])
  670.                             ->treatFalseLike(['mapping' => false])
  671.                             ->performNoDeepMerging()
  672.                             ->children()
  673.                                 ->scalarNode('mapping')->defaultValue(true)->end()
  674.                                 ->scalarNode('type')->end()
  675.                                 ->scalarNode('dir')->end()
  676.                                 ->scalarNode('alias')->end()
  677.                                 ->scalarNode('prefix')->end()
  678.                                 ->booleanNode('is_bundle')->end()
  679.                             ->end()
  680.                         ->end()
  681.                     ->end()
  682.                     ->arrayNode('dql')
  683.                         ->fixXmlConfig('string_function')
  684.                         ->fixXmlConfig('numeric_function')
  685.                         ->fixXmlConfig('datetime_function')
  686.                         ->children()
  687.                             ->arrayNode('string_functions')
  688.                                 ->useAttributeAsKey('name')
  689.                                 ->prototype('scalar')->end()
  690.                             ->end()
  691.                             ->arrayNode('numeric_functions')
  692.                                 ->useAttributeAsKey('name')
  693.                                 ->prototype('scalar')->end()
  694.                             ->end()
  695.                             ->arrayNode('datetime_functions')
  696.                                 ->useAttributeAsKey('name')
  697.                                 ->prototype('scalar')->end()
  698.                             ->end()
  699.                         ->end()
  700.                     ->end()
  701.                 ->end()
  702.                 ->fixXmlConfig('filter')
  703.                 ->children()
  704.                     ->arrayNode('filters')
  705.                         ->info('Register SQL Filters in the entity manager')
  706.                         ->useAttributeAsKey('name')
  707.                         ->prototype('array')
  708.                             ->beforeNormalization()
  709.                                 ->ifString()
  710.                                 ->then(static function ($v) {
  711.                                     return ['class' => $v];
  712.                                 })
  713.                             ->end()
  714.                             ->beforeNormalization()
  715.                                 // The content of the XML node is returned as the "value" key so we need to rename it
  716.                                 ->ifTrue(static function ($v) {
  717.                                     return is_array($v) && isset($v['value']);
  718.                                 })
  719.                                 ->then(static function ($v) {
  720.                                     $v['class'] = $v['value'];
  721.                                     unset($v['value']);
  723.                                     return $v;
  724.                                 })
  725.                             ->end()
  726.                             ->fixXmlConfig('parameter')
  727.                             ->children()
  728.                                 ->scalarNode('class')->isRequired()->end()
  729.                                 ->booleanNode('enabled')->defaultFalse()->end()
  730.                                 ->arrayNode('parameters')
  731.                                     ->useAttributeAsKey('name')
  732.                                     ->prototype('variable')->end()
  733.                                 ->end()
  734.                             ->end()
  735.                         ->end()
  736.                     ->end()
  737.                 ->end()
  738.             ->end();
  740.         return $node;
  741.     }
  743.     /**
  744.      * Return a ORM cache driver node for an given entity manager
  745.      */
  746.     private function getOrmCacheDriverNode(string $name): ArrayNodeDefinition
  747.     {
  748.         $treeBuilder = new TreeBuilder($name);
  749.         $node        = $treeBuilder->getRootNode();
  751.         $node
  752.             ->beforeNormalization()
  753.                 ->ifString()
  754.                 ->then(static function ($v): array {
  755.                     return ['type' => $v];
  756.                 })
  757.             ->end()
  758.             ->children()
  759.                 ->scalarNode('type')->defaultNull()->end()
  760.                 ->scalarNode('id')->end()
  761.                 ->scalarNode('pool')->end()
  762.             ->end();
  764.         if ($name !== 'metadata_cache_driver') {
  765.             $node->addDefaultsIfNotSet();
  766.         }
  768.         return $node;
  769.     }
  771.     /**
  772.      * Find proxy auto generate modes for their names and int values
  773.      *
  774.      * @return array{names: list<string>, values: list<int>}
  775.      */
  776.     private function getAutoGenerateModes(): array
  777.     {
  778.         $constPrefix = 'AUTOGENERATE_';
  779.         $prefixLen   = strlen($constPrefix);
  780.         $refClass    = new ReflectionClass(AbstractProxyFactory::class);
  781.         $constsArray = $refClass->getConstants();
  782.         $namesArray  = [];
  783.         $valuesArray = [];
  785.         foreach ($constsArray as $key => $value) {
  786.             if (strpos($key, $constPrefix) !== 0) {
  787.                 continue;
  788.             }
  790.             $namesArray[]  = substr($key, $prefixLen);
  791.             $valuesArray[] = (int) $value;
  792.         }
  794.         return [
  795.             'names' => $namesArray,
  796.             'values' => $valuesArray,
  797.         ];
  798.     }
  800.     /**
  801.      * Returns the correct deprecation param's as an array for setDeprecated.
  802.      *
  803.      * Symfony/Config v5.1 introduces a deprecation notice when calling
  804.      * setDeprecation() with less than 3 args and the getDeprecation method was
  805.      * introduced at the same time. By checking if getDeprecation() exists,
  806.      * we can determine the correct param count to use when calling setDeprecated.
  807.      *
  808.      * @return list<string>|array{0:string, 1: numeric-string, string}
  809.      */
  810.     private function getDeprecationMsg(string $message, string $version): array
  811.     {
  812.         if (method_exists(BaseNode::class, 'getDeprecation')) {
  813.             return [
  814.                 'doctrine/doctrine-bundle',
  815.                 $version,
  816.                 $message,
  817.             ];
  818.         }
  820.         return [$message];
  821.     }
  822. }