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

Open in your IDE?
  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 entity-manager 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. 'controller_resolver' => true,
  418. ];
  419. $entityManager = [];
  420. foreach ($v as $key => $value) {
  421. if (isset($excludedKeys[$key])) {
  422. continue;
  423. }
  425. $entityManager[$key] = $v[$key];
  426. unset($v[$key]);
  427. }
  429. $v['default_entity_manager'] = isset($v['default_entity_manager']) ? (string) $v['default_entity_manager'] : 'default';
  430. $v['entity_managers'] = [$v['default_entity_manager'] => $entityManager];
  432. return $v;
  433. })
  434. ->end()
  435. ->children()
  436. ->scalarNode('default_entity_manager')->end()
  437. ->scalarNode('auto_generate_proxy_classes')->defaultValue(false)
  438. ->info('Auto generate mode possible values are: "NEVER", "ALWAYS", "FILE_NOT_EXISTS", "EVAL", "FILE_NOT_EXISTS_OR_CHANGED"')
  439. ->validate()
  440. ->ifTrue(function ($v) {
  441. $generationModes = $this->getAutoGenerateModes();
  443. if (is_int($v) && in_array($v, $generationModes['values']/*array(0, 1, 2, 3)*/)) {
  444. return false;
  445. }
  447. if (is_bool($v)) {
  448. return false;
  449. }
  451. if (is_string($v)) {
  452. if (in_array(strtoupper($v), $generationModes['names']/*array('NEVER', 'ALWAYS', 'FILE_NOT_EXISTS', 'EVAL', 'FILE_NOT_EXISTS_OR_CHANGED')*/)) {
  453. return false;
  454. }
  455. }
  457. return true;
  458. })
  459. ->thenInvalid('Invalid auto generate mode value %s')
  460. ->end()
  461. ->validate()
  462. ->ifString()
  463. ->then(static function ($v) {
  464. return constant('Doctrine\Common\Proxy\AbstractProxyFactory::AUTOGENERATE_' . strtoupper($v));
  465. })
  466. ->end()
  467. ->end()
  468. ->scalarNode('proxy_dir')->defaultValue('%kernel.cache_dir%/doctrine/orm/Proxies')->end()
  469. ->scalarNode('proxy_namespace')->defaultValue('Proxies')->end()
  470. ->arrayNode('controller_resolver')
  471. ->canBeDisabled()
  472. ->children()
  473. ->booleanNode('auto_mapping')
  474. ->defaultTrue()
  475. ->info('Set to false to disable using route placeholders as lookup criteria when the primary key doesn\'t match the argument name')
  476. ->end()
  477. ->booleanNode('evict_cache')
  478. ->info('Set to true to fetch the entity from the database instead of using the cache, if any')
  479. ->defaultFalse()
  480. ->end()
  481. ->end()
  482. ->end()
  483. ->end()
  484. ->fixXmlConfig('entity_manager')
  485. ->append($this->getOrmEntityManagersNode())
  486. ->fixXmlConfig('resolve_target_entity', 'resolve_target_entities')
  487. ->append($this->getOrmTargetEntityResolverNode())
  488. ->end()
  489. ->end();
  490. }
  492. /**
  493. * Return ORM target entity resolver node
  494. */
  495. private function getOrmTargetEntityResolverNode(): NodeDefinition
  496. {
  497. $treeBuilder = new TreeBuilder('resolve_target_entities');
  498. $node = $treeBuilder->getRootNode();
  500. $node
  501. ->useAttributeAsKey('interface')
  502. ->prototype('scalar')
  503. ->cannotBeEmpty()
  504. ->end();
  506. return $node;
  507. }
  509. /**
  510. * Return ORM entity listener node
  511. */
  512. private function getOrmEntityListenersNode(): NodeDefinition
  513. {
  514. $treeBuilder = new TreeBuilder('entity_listeners');
  515. $node = $treeBuilder->getRootNode();
  517. $normalizer = static function ($mappings) {
  518. $entities = [];
  520. foreach ($mappings as $entityClass => $mapping) {
  521. $listeners = [];
  523. foreach ($mapping as $listenerClass => $listenerEvent) {
  524. $events = [];
  526. foreach ($listenerEvent as $eventType => $eventMapping) {
  527. if ($eventMapping === null) {
  528. $eventMapping = [null];
  529. }
  531. foreach ($eventMapping as $method) {
  532. $events[] = [
  533. 'type' => $eventType,
  534. 'method' => $method,
  535. ];
  536. }
  537. }
  539. $listeners[] = [
  540. 'class' => $listenerClass,
  541. 'event' => $events,
  542. ];
  543. }
  545. $entities[] = [
  546. 'class' => $entityClass,
  547. 'listener' => $listeners,
  548. ];
  549. }
  551. return ['entities' => $entities];
  552. };
  554. $node
  555. ->beforeNormalization()
  556. // Yaml normalization
  557. ->ifTrue(static function ($v) {
  558. return is_array(reset($v)) && is_string(key(reset($v)));
  559. })
  560. ->then($normalizer)
  561. ->end()
  562. ->fixXmlConfig('entity', 'entities')
  563. ->children()
  564. ->arrayNode('entities')
  565. ->useAttributeAsKey('class')
  566. ->prototype('array')
  567. ->fixXmlConfig('listener')
  568. ->children()
  569. ->arrayNode('listeners')
  570. ->useAttributeAsKey('class')
  571. ->prototype('array')
  572. ->fixXmlConfig('event')
  573. ->children()
  574. ->arrayNode('events')
  575. ->prototype('array')
  576. ->children()
  577. ->scalarNode('type')->end()
  578. ->scalarNode('method')->defaultNull()->end()
  579. ->end()
  580. ->end()
  581. ->end()
  582. ->end()
  583. ->end()
  584. ->end()
  585. ->end()
  586. ->end()
  587. ->end()
  588. ->end();
  590. return $node;
  591. }
  593. /**
  594. * Return ORM entity manager node
  595. */
  596. private function getOrmEntityManagersNode(): ArrayNodeDefinition
  597. {
  598. $treeBuilder = new TreeBuilder('entity_managers');
  599. $node = $treeBuilder->getRootNode();
  601. $node
  602. ->requiresAtLeastOneElement()
  603. ->useAttributeAsKey('name')
  604. ->prototype('array')
  605. ->addDefaultsIfNotSet()
  606. ->append($this->getOrmCacheDriverNode('query_cache_driver'))
  607. ->append($this->getOrmCacheDriverNode('metadata_cache_driver'))
  608. ->append($this->getOrmCacheDriverNode('result_cache_driver'))
  609. ->append($this->getOrmEntityListenersNode())
  610. ->fixXmlConfig('schema_ignore_class', 'schema_ignore_classes')
  611. ->children()
  612. ->scalarNode('connection')->end()
  613. ->scalarNode('class_metadata_factory_name')->defaultValue(ClassMetadataFactory::class)->end()
  614. ->scalarNode('default_repository_class')->defaultValue(EntityRepository::class)->end()
  615. ->scalarNode('auto_mapping')->defaultFalse()->end()
  616. ->scalarNode('naming_strategy')->defaultValue('doctrine.orm.naming_strategy.default')->end()
  617. ->scalarNode('quote_strategy')->defaultValue('doctrine.orm.quote_strategy.default')->end()
  618. ->scalarNode('entity_listener_resolver')->defaultNull()->end()
  619. ->scalarNode('repository_factory')->defaultValue('doctrine.orm.container_repository_factory')->end()
  620. ->arrayNode('schema_ignore_classes')
  621. ->prototype('scalar')->end()
  622. ->end()
  623. ->end()
  624. ->children()
  625. ->arrayNode('second_level_cache')
  626. ->children()
  627. ->append($this->getOrmCacheDriverNode('region_cache_driver'))
  628. ->scalarNode('region_lock_lifetime')->defaultValue(60)->end()
  629. ->booleanNode('log_enabled')->defaultValue($this->debug)->end()
  630. ->scalarNode('region_lifetime')->defaultValue(3600)->end()
  631. ->booleanNode('enabled')->defaultValue(true)->end()
  632. ->scalarNode('factory')->end()
  633. ->end()
  634. ->fixXmlConfig('region')
  635. ->children()
  636. ->arrayNode('regions')
  637. ->useAttributeAsKey('name')
  638. ->prototype('array')
  639. ->children()
  640. ->append($this->getOrmCacheDriverNode('cache_driver'))
  641. ->scalarNode('lock_path')->defaultValue('%kernel.cache_dir%/doctrine/orm/slc/filelock')->end()
  642. ->scalarNode('lock_lifetime')->defaultValue(60)->end()
  643. ->scalarNode('type')->defaultValue('default')->end()
  644. ->scalarNode('lifetime')->defaultValue(0)->end()
  645. ->scalarNode('service')->end()
  646. ->scalarNode('name')->end()
  647. ->end()
  648. ->end()
  649. ->end()
  650. ->end()
  651. ->fixXmlConfig('logger')
  652. ->children()
  653. ->arrayNode('loggers')
  654. ->useAttributeAsKey('name')
  655. ->prototype('array')
  656. ->children()
  657. ->scalarNode('name')->end()
  658. ->scalarNode('service')->end()
  659. ->end()
  660. ->end()
  661. ->end()
  662. ->end()
  663. ->end()
  664. ->end()
  665. ->fixXmlConfig('hydrator')
  666. ->children()
  667. ->arrayNode('hydrators')
  668. ->useAttributeAsKey('name')
  669. ->prototype('scalar')->end()
  670. ->end()
  671. ->end()
  672. ->fixXmlConfig('mapping')
  673. ->children()
  674. ->arrayNode('mappings')
  675. ->useAttributeAsKey('name')
  676. ->prototype('array')
  677. ->beforeNormalization()
  678. ->ifString()
  679. ->then(static function ($v) {
  680. return ['type' => $v];
  681. })
  682. ->end()
  683. ->treatNullLike([])
  684. ->treatFalseLike(['mapping' => false])
  685. ->performNoDeepMerging()
  686. ->children()
  687. ->scalarNode('mapping')->defaultValue(true)->end()
  688. ->scalarNode('type')->end()
  689. ->scalarNode('dir')->end()
  690. ->scalarNode('alias')->end()
  691. ->scalarNode('prefix')->end()
  692. ->booleanNode('is_bundle')->end()
  693. ->end()
  694. ->end()
  695. ->end()
  696. ->arrayNode('dql')
  697. ->fixXmlConfig('string_function')
  698. ->fixXmlConfig('numeric_function')
  699. ->fixXmlConfig('datetime_function')
  700. ->children()
  701. ->arrayNode('string_functions')
  702. ->useAttributeAsKey('name')
  703. ->prototype('scalar')->end()
  704. ->end()
  705. ->arrayNode('numeric_functions')
  706. ->useAttributeAsKey('name')
  707. ->prototype('scalar')->end()
  708. ->end()
  709. ->arrayNode('datetime_functions')
  710. ->useAttributeAsKey('name')
  711. ->prototype('scalar')->end()
  712. ->end()
  713. ->end()
  714. ->end()
  715. ->end()
  716. ->fixXmlConfig('filter')
  717. ->children()
  718. ->arrayNode('filters')
  719. ->info('Register SQL Filters in the entity manager')
  720. ->useAttributeAsKey('name')
  721. ->prototype('array')
  722. ->beforeNormalization()
  723. ->ifString()
  724. ->then(static function ($v) {
  725. return ['class' => $v];
  726. })
  727. ->end()
  728. ->beforeNormalization()
  729. // The content of the XML node is returned as the "value" key so we need to rename it
  730. ->ifTrue(static function ($v) {
  731. return is_array($v) && isset($v['value']);
  732. })
  733. ->then(static function ($v) {
  734. $v['class'] = $v['value'];
  735. unset($v['value']);
  737. return $v;
  738. })
  739. ->end()
  740. ->fixXmlConfig('parameter')
  741. ->children()
  742. ->scalarNode('class')->isRequired()->end()
  743. ->booleanNode('enabled')->defaultFalse()->end()
  744. ->arrayNode('parameters')
  745. ->useAttributeAsKey('name')
  746. ->prototype('variable')->end()
  747. ->end()
  748. ->end()
  749. ->end()
  750. ->end()
  751. ->end()
  752. ->end();
  754. return $node;
  755. }
  757. /**
  758. * Return a ORM cache driver node for an given entity manager
  759. */
  760. private function getOrmCacheDriverNode(string $name): ArrayNodeDefinition
  761. {
  762. $treeBuilder = new TreeBuilder($name);
  763. $node = $treeBuilder->getRootNode();
  765. $node
  766. ->beforeNormalization()
  767. ->ifString()
  768. ->then(static function ($v): array {
  769. return ['type' => $v];
  770. })
  771. ->end()
  772. ->children()
  773. ->scalarNode('type')->defaultNull()->end()
  774. ->scalarNode('id')->end()
  775. ->scalarNode('pool')->end()
  776. ->end();
  778. if ($name !== 'metadata_cache_driver') {
  779. $node->addDefaultsIfNotSet();
  780. }
  782. return $node;
  783. }
  785. /**
  786. * Find proxy auto generate modes for their names and int values
  787. *
  788. * @return array{names: list<string>, values: list<int>}
  789. */
  790. private function getAutoGenerateModes(): array
  791. {
  792. $constPrefix = 'AUTOGENERATE_';
  793. $prefixLen = strlen($constPrefix);
  794. $refClass = new ReflectionClass(AbstractProxyFactory::class);
  795. $constsArray = $refClass->getConstants();
  796. $namesArray = [];
  797. $valuesArray = [];
  799. foreach ($constsArray as $key => $value) {
  800. if (strpos($key, $constPrefix) !== 0) {
  801. continue;
  802. }
  804. $namesArray[] = substr($key, $prefixLen);
  805. $valuesArray[] = (int) $value;
  806. }
  808. return [
  809. 'names' => $namesArray,
  810. 'values' => $valuesArray,
  811. ];
  812. }
  814. /**
  815. * Returns the correct deprecation param's as an array for setDeprecated.
  816. *
  817. * Symfony/Config v5.1 introduces a deprecation notice when calling
  818. * setDeprecation() with less than 3 args and the getDeprecation method was
  819. * introduced at the same time. By checking if getDeprecation() exists,
  820. * we can determine the correct param count to use when calling setDeprecated.
  821. *
  822. * @return list<string>|array{0:string, 1: numeric-string, string}
  823. */
  824. private function getDeprecationMsg(string $message, string $version): array
  825. {
  826. if (method_exists(BaseNode::class, 'getDeprecation')) {
  827. return [
  828. 'doctrine/doctrine-bundle',
  829. $version,
  830. $message,
  831. ];
  832. }
  834. return [$message];
  835. }
  836. }