PageRenderTime 49ms CodeModel.GetById 13ms RepoModel.GetById 0ms app.codeStats 0ms

/vendor/doctrine/doctrine-bundle/DependencyInjection/DoctrineExtension.php

https://gitlab.com/ineszribi/SmartBookStoreWeb
PHP | 752 lines | 474 code | 106 blank | 172 comment | 56 complexity | b392b8a068846546ee6bccd1338b56cf MD5 | raw file
Possible License(s): BSD-3-Clause
  1. <?php
  2. /*
  3. * This file is part of the Doctrine Bundle
  4. *
  5. * The code was originally distributed inside the Symfony framework.
  6. *
  7. * (c) Fabien Potencier <fabien@symfony.com>
  8. * (c) Doctrine Project, Benjamin Eberlei <kontakt@beberlei.de>
  9. *
  10. * For the full copyright and license information, please view the LICENSE
  11. * file that was distributed with this source code.
  12. */
  13. namespace Doctrine\Bundle\DoctrineBundle\DependencyInjection;
  14. use Doctrine\ORM\Version;
  15. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  16. use Symfony\Component\DependencyInjection\Alias;
  17. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  18. use Symfony\Component\DependencyInjection\ContainerBuilder;
  19. use Symfony\Component\DependencyInjection\Definition;
  20. use Symfony\Component\DependencyInjection\DefinitionDecorator;
  21. use Symfony\Component\DependencyInjection\Reference;
  22. use Symfony\Bridge\Doctrine\DependencyInjection\AbstractDoctrineExtension;
  23. use Symfony\Component\Config\FileLocator;
  24. use Doctrine\Bundle\DoctrineCacheBundle\DependencyInjection\SymfonyBridgeAdapter;
  25. use Doctrine\Bundle\DoctrineCacheBundle\DependencyInjection\CacheProviderLoader;
  26. /**
  27. * DoctrineExtension is an extension for the Doctrine DBAL and ORM library.
  28. *
  29. * @author Jonathan H. Wage <jonwage@gmail.com>
  30. * @author Fabien Potencier <fabien@symfony.com>
  31. * @author Benjamin Eberlei <kontakt@beberlei.de>
  32. * @author Fabio B. Silva <fabio.bat.silva@gmail.com>
  33. * @author Kinn Coelho JuliĆ£o <kinncj@php.net>
  34. */
  35. class DoctrineExtension extends AbstractDoctrineExtension
  36. {
  37. /**
  38. * @var string
  39. */
  40. private $defaultConnection;
  41. /**
  42. * @var array
  43. */
  44. private $entityManagers;
  45. /**
  46. * @var SymfonyBridgeAdapter
  47. */
  48. private $adapter;
  49. /**
  50. * @param SymfonyBridgeAdapter $adapter
  51. */
  52. public function __construct(SymfonyBridgeAdapter $adapter = null)
  53. {
  54. $this->adapter = $adapter ?: new SymfonyBridgeAdapter(new CacheProviderLoader(), 'doctrine.orm', 'orm');
  55. }
  56. /**
  57. * {@inheritDoc}
  58. */
  59. public function load(array $configs, ContainerBuilder $container)
  60. {
  61. $configuration = $this->getConfiguration($configs, $container);
  62. $config = $this->processConfiguration($configuration, $configs);
  63. $this->adapter->loadServicesConfiguration($container);
  64. if (!empty($config['dbal'])) {
  65. $this->dbalLoad($config['dbal'], $container);
  66. }
  67. if (!empty($config['orm'])) {
  68. $this->ormLoad($config['orm'], $container);
  69. }
  70. $this->addClassesToCompile(array(
  71. 'Doctrine\\Common\\Annotations\\DocLexer',
  72. 'Doctrine\\Common\\Annotations\\FileCacheReader',
  73. 'Doctrine\\Common\\Annotations\\PhpParser',
  74. 'Doctrine\\Common\\Annotations\\Reader',
  75. 'Doctrine\\Common\\Lexer',
  76. 'Doctrine\\Common\\Persistence\\ConnectionRegistry',
  77. 'Doctrine\\Common\\Persistence\\Proxy',
  78. 'Doctrine\\Common\\Util\\ClassUtils',
  79. 'Doctrine\\Bundle\\DoctrineBundle\\Registry',
  80. ));
  81. }
  82. /**
  83. * Loads the DBAL configuration.
  84. *
  85. * Usage example:
  86. *
  87. * <doctrine:dbal id="myconn" dbname="sfweb" user="root" />
  88. *
  89. * @param array $config An array of configuration settings
  90. * @param ContainerBuilder $container A ContainerBuilder instance
  91. */
  92. protected function dbalLoad(array $config, ContainerBuilder $container)
  93. {
  94. $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
  95. $loader->load('dbal.xml');
  96. if (empty($config['default_connection'])) {
  97. $keys = array_keys($config['connections']);
  98. $config['default_connection'] = reset($keys);
  99. }
  100. $this->defaultConnection = $config['default_connection'];
  101. $container->setAlias('database_connection', sprintf('doctrine.dbal.%s_connection', $this->defaultConnection));
  102. $container->setAlias('doctrine.dbal.event_manager', new Alias(sprintf('doctrine.dbal.%s_connection.event_manager', $this->defaultConnection), false));
  103. $container->setParameter('doctrine.dbal.connection_factory.types', $config['types']);
  104. $connections = array();
  105. foreach (array_keys($config['connections']) as $name) {
  106. $connections[$name] = sprintf('doctrine.dbal.%s_connection', $name);
  107. }
  108. $container->setParameter('doctrine.connections', $connections);
  109. $container->setParameter('doctrine.default_connection', $this->defaultConnection);
  110. foreach ($config['connections'] as $name => $connection) {
  111. $this->loadDbalConnection($name, $connection, $container);
  112. }
  113. }
  114. /**
  115. * Loads a configured DBAL connection.
  116. *
  117. * @param string $name The name of the connection
  118. * @param array $connection A dbal connection configuration.
  119. * @param ContainerBuilder $container A ContainerBuilder instance
  120. */
  121. protected function loadDbalConnection($name, array $connection, ContainerBuilder $container)
  122. {
  123. // configuration
  124. $configuration = $container->setDefinition(sprintf('doctrine.dbal.%s_connection.configuration', $name), new DefinitionDecorator('doctrine.dbal.connection.configuration'));
  125. $logger = null;
  126. if ($connection['logging']) {
  127. $logger = new Reference('doctrine.dbal.logger');
  128. }
  129. unset ($connection['logging']);
  130. if ($connection['profiling']) {
  131. $profilingLoggerId = 'doctrine.dbal.logger.profiling.'.$name;
  132. $container->setDefinition($profilingLoggerId, new DefinitionDecorator('doctrine.dbal.logger.profiling'));
  133. $logger = new Reference($profilingLoggerId);
  134. $container->getDefinition('data_collector.doctrine')->addMethodCall('addLogger', array($name, $logger));
  135. if (null !== $logger) {
  136. $chainLogger = new DefinitionDecorator('doctrine.dbal.logger.chain');
  137. $chainLogger->addMethodCall('addLogger', array($logger));
  138. $loggerId = 'doctrine.dbal.logger.chain.'.$name;
  139. $container->setDefinition($loggerId, $chainLogger);
  140. $logger = new Reference($loggerId);
  141. }
  142. }
  143. unset($connection['profiling']);
  144. if (isset($connection['auto_commit'])) {
  145. $configuration->addMethodCall('setAutoCommit', array($connection['auto_commit']));
  146. }
  147. unset($connection['auto_commit']);
  148. if (isset($connection['schema_filter']) && $connection['schema_filter']) {
  149. $configuration->addMethodCall('setFilterSchemaAssetsExpression', array($connection['schema_filter']));
  150. }
  151. unset($connection['schema_filter']);
  152. if ($logger) {
  153. $configuration->addMethodCall('setSQLLogger', array($logger));
  154. }
  155. // event manager
  156. $container->setDefinition(sprintf('doctrine.dbal.%s_connection.event_manager', $name), new DefinitionDecorator('doctrine.dbal.connection.event_manager'));
  157. // connection
  158. // PDO ignores the charset property before 5.3.6 so the init listener has to be used instead.
  159. if (isset($connection['charset']) && version_compare(PHP_VERSION, '5.3.6', '<')) {
  160. if ((isset($connection['driver']) && stripos($connection['driver'], 'mysql') !== false) ||
  161. (isset($connection['driver_class']) && stripos($connection['driver_class'], 'mysql') !== false)) {
  162. $mysqlSessionInit = new Definition('%doctrine.dbal.events.mysql_session_init.class%');
  163. $mysqlSessionInit->setArguments(array($connection['charset']));
  164. $mysqlSessionInit->setPublic(false);
  165. $mysqlSessionInit->addTag('doctrine.event_subscriber', array('connection' => $name));
  166. $container->setDefinition(
  167. sprintf('doctrine.dbal.%s_connection.events.mysqlsessioninit', $name),
  168. $mysqlSessionInit
  169. );
  170. unset($connection['charset']);
  171. }
  172. }
  173. $options = $this->getConnectionOptions($connection);
  174. $container
  175. ->setDefinition(sprintf('doctrine.dbal.%s_connection', $name), new DefinitionDecorator('doctrine.dbal.connection'))
  176. ->setArguments(array(
  177. $options,
  178. new Reference(sprintf('doctrine.dbal.%s_connection.configuration', $name)),
  179. new Reference(sprintf('doctrine.dbal.%s_connection.event_manager', $name)),
  180. $connection['mapping_types'],
  181. ))
  182. ;
  183. }
  184. protected function getConnectionOptions($connection)
  185. {
  186. $options = $connection;
  187. if (isset($options['platform_service'])) {
  188. $options['platform'] = new Reference($options['platform_service']);
  189. unset($options['platform_service']);
  190. }
  191. unset($options['mapping_types']);
  192. if (isset($options['shard_choser_service'])) {
  193. $options['shard_choser'] = new Reference($options['shard_choser_service']);
  194. unset($options['shard_choser_service']);
  195. }
  196. foreach (array(
  197. 'options' => 'driverOptions',
  198. 'driver_class' => 'driverClass',
  199. 'wrapper_class' => 'wrapperClass',
  200. 'keep_slave' => 'keepSlave',
  201. 'shard_choser' => 'shardChoser',
  202. 'server_version' => 'serverVersion',
  203. ) as $old => $new) {
  204. if (isset($options[$old])) {
  205. $options[$new] = $options[$old];
  206. unset($options[$old]);
  207. }
  208. }
  209. if (!empty($options['slaves']) && !empty($options['shards'])) {
  210. throw new InvalidArgumentException('Sharding and master-slave connection cannot be used together');
  211. }
  212. if (!empty($options['slaves'])) {
  213. $nonRewrittenKeys = array(
  214. 'driver' => true, 'driverOptions' => true, 'driverClass' => true,
  215. 'wrapperClass' => true, 'keepSlave' => true, 'shardChoser' => true,
  216. 'platform' => true, 'slaves' => true, 'master' => true, 'shards' => true,
  217. // included by safety but should have been unset already
  218. 'logging' => true, 'profiling' => true, 'mapping_types' => true, 'platform_service' => true,
  219. );
  220. foreach ($options as $key => $value) {
  221. if (isset($nonRewrittenKeys[$key])) {
  222. continue;
  223. }
  224. $options['master'][$key] = $value;
  225. unset($options[$key]);
  226. }
  227. if (empty($options['wrapperClass'])) {
  228. // Change the wrapper class only if the user does not already forced using a custom one.
  229. $options['wrapperClass'] = 'Doctrine\\DBAL\\Connections\\MasterSlaveConnection';
  230. }
  231. } else {
  232. unset($options['slaves']);
  233. }
  234. if (!empty($options['shards'])) {
  235. $nonRewrittenKeys = array(
  236. 'driver' => true, 'driverOptions' => true, 'driverClass' => true,
  237. 'wrapperClass' => true, 'keepSlave' => true, 'shardChoser' => true,
  238. 'platform' => true, 'slaves' => true, 'global' => true, 'shards' => true,
  239. // included by safety but should have been unset already
  240. 'logging' => true, 'profiling' => true, 'mapping_types' => true, 'platform_service' => true,
  241. );
  242. foreach ($options as $key => $value) {
  243. if (isset($nonRewrittenKeys[$key])) {
  244. continue;
  245. }
  246. $options['global'][$key] = $value;
  247. unset($options[$key]);
  248. }
  249. if (empty($options['wrapperClass'])) {
  250. // Change the wrapper class only if the user does not already forced using a custom one.
  251. $options['wrapperClass'] = 'Doctrine\\DBAL\\Sharding\\PoolingShardConnection';
  252. }
  253. } else {
  254. unset($options['shards']);
  255. }
  256. return $options;
  257. }
  258. /**
  259. * Loads the Doctrine ORM configuration.
  260. *
  261. * Usage example:
  262. *
  263. * <doctrine:orm id="mydm" connection="myconn" />
  264. *
  265. * @param array $config An array of configuration settings
  266. * @param ContainerBuilder $container A ContainerBuilder instance
  267. */
  268. protected function ormLoad(array $config, ContainerBuilder $container)
  269. {
  270. $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
  271. $loader->load('orm.xml');
  272. $this->entityManagers = array();
  273. foreach (array_keys($config['entity_managers']) as $name) {
  274. $this->entityManagers[$name] = sprintf('doctrine.orm.%s_entity_manager', $name);
  275. }
  276. $container->setParameter('doctrine.entity_managers', $this->entityManagers);
  277. if (empty($config['default_entity_manager'])) {
  278. $tmp = array_keys($this->entityManagers);
  279. $config['default_entity_manager'] = reset($tmp);
  280. }
  281. $container->setParameter('doctrine.default_entity_manager', $config['default_entity_manager']);
  282. $options = array('auto_generate_proxy_classes', 'proxy_dir', 'proxy_namespace');
  283. foreach ($options as $key) {
  284. $container->setParameter('doctrine.orm.'.$key, $config[$key]);
  285. }
  286. $container->setAlias('doctrine.orm.entity_manager', sprintf('doctrine.orm.%s_entity_manager', $config['default_entity_manager']));
  287. // BC logic to handle DoctrineBridge < 2.6
  288. if (!method_exists($this, 'fixManagersAutoMappings')) {
  289. foreach ($config['entity_managers'] as $entityManager) {
  290. if ($entityManager['auto_mapping'] && count($config['entity_managers']) > 1) {
  291. throw new \LogicException('You cannot enable "auto_mapping" when several entity managers are defined.');
  292. }
  293. }
  294. } else {
  295. $config['entity_managers'] = $this->fixManagersAutoMappings($config['entity_managers'], $container->getParameter('kernel.bundles'));
  296. }
  297. foreach ($config['entity_managers'] as $name => $entityManager) {
  298. $entityManager['name'] = $name;
  299. $this->loadOrmEntityManager($entityManager, $container);
  300. }
  301. if ($config['resolve_target_entities']) {
  302. $def = $container->findDefinition('doctrine.orm.listeners.resolve_target_entity');
  303. foreach ($config['resolve_target_entities'] as $name => $implementation) {
  304. $def->addMethodCall('addResolveTargetEntity', array(
  305. $name, $implementation, array(),
  306. ));
  307. }
  308. $def->addTag('doctrine.event_listener', array('event' => 'loadClassMetadata'));
  309. }
  310. }
  311. /**
  312. * Loads a configured ORM entity manager.
  313. *
  314. * @param array $entityManager A configured ORM entity manager.
  315. * @param ContainerBuilder $container A ContainerBuilder instance
  316. */
  317. protected function loadOrmEntityManager(array $entityManager, ContainerBuilder $container)
  318. {
  319. $ormConfigDef = $container->setDefinition(sprintf('doctrine.orm.%s_configuration', $entityManager['name']), new DefinitionDecorator('doctrine.orm.configuration'));
  320. $this->loadOrmEntityManagerMappingInformation($entityManager, $ormConfigDef, $container);
  321. $this->loadOrmCacheDrivers($entityManager, $container);
  322. if (isset($entityManager['entity_listener_resolver']) && $entityManager['entity_listener_resolver']) {
  323. $container->setAlias(sprintf('doctrine.orm.%s_entity_listener_resolver', $entityManager['name']), $entityManager['entity_listener_resolver']);
  324. } else {
  325. $container->setDefinition(sprintf('doctrine.orm.%s_entity_listener_resolver', $entityManager['name']), new Definition('%doctrine.orm.entity_listener_resolver.class%'));
  326. }
  327. $methods = array(
  328. 'setMetadataCacheImpl' => new Reference(sprintf('doctrine.orm.%s_metadata_cache', $entityManager['name'])),
  329. 'setQueryCacheImpl' => new Reference(sprintf('doctrine.orm.%s_query_cache', $entityManager['name'])),
  330. 'setResultCacheImpl' => new Reference(sprintf('doctrine.orm.%s_result_cache', $entityManager['name'])),
  331. 'setMetadataDriverImpl' => new Reference('doctrine.orm.'.$entityManager['name'].'_metadata_driver'),
  332. 'setProxyDir' => '%doctrine.orm.proxy_dir%',
  333. 'setProxyNamespace' => '%doctrine.orm.proxy_namespace%',
  334. 'setAutoGenerateProxyClasses' => '%doctrine.orm.auto_generate_proxy_classes%',
  335. 'setClassMetadataFactoryName' => $entityManager['class_metadata_factory_name'],
  336. 'setDefaultRepositoryClassName' => $entityManager['default_repository_class'],
  337. );
  338. // check for version to keep BC
  339. if (version_compare(Version::VERSION, "2.3.0-DEV") >= 0) {
  340. $methods = array_merge($methods, array(
  341. 'setNamingStrategy' => new Reference($entityManager['naming_strategy']),
  342. ));
  343. }
  344. if (version_compare(Version::VERSION, "2.4.0-DEV") >= 0) {
  345. $methods = array_merge($methods, array(
  346. 'setEntityListenerResolver' => new Reference(sprintf('doctrine.orm.%s_entity_listener_resolver', $entityManager['name'])),
  347. ));
  348. }
  349. if (isset($entityManager['second_level_cache'])) {
  350. $this->loadOrmSecondLevelCache($entityManager, $ormConfigDef, $container);
  351. }
  352. if ($entityManager['repository_factory']) {
  353. $methods['setRepositoryFactory'] = new Reference($entityManager['repository_factory']);
  354. }
  355. foreach ($methods as $method => $arg) {
  356. $ormConfigDef->addMethodCall($method, array($arg));
  357. }
  358. foreach ($entityManager['hydrators'] as $name => $class) {
  359. $ormConfigDef->addMethodCall('addCustomHydrationMode', array($name, $class));
  360. }
  361. if (!empty($entityManager['dql'])) {
  362. foreach ($entityManager['dql']['string_functions'] as $name => $function) {
  363. $ormConfigDef->addMethodCall('addCustomStringFunction', array($name, $function));
  364. }
  365. foreach ($entityManager['dql']['numeric_functions'] as $name => $function) {
  366. $ormConfigDef->addMethodCall('addCustomNumericFunction', array($name, $function));
  367. }
  368. foreach ($entityManager['dql']['datetime_functions'] as $name => $function) {
  369. $ormConfigDef->addMethodCall('addCustomDatetimeFunction', array($name, $function));
  370. }
  371. }
  372. $enabledFilters = array();
  373. $filtersParameters = array();
  374. foreach ($entityManager['filters'] as $name => $filter) {
  375. $ormConfigDef->addMethodCall('addFilter', array($name, $filter['class']));
  376. if ($filter['enabled']) {
  377. $enabledFilters[] = $name;
  378. }
  379. if ($filter['parameters']) {
  380. $filtersParameters[$name] = $filter['parameters'];
  381. }
  382. }
  383. $managerConfiguratorName = sprintf('doctrine.orm.%s_manager_configurator', $entityManager['name']);
  384. $container
  385. ->setDefinition($managerConfiguratorName, new DefinitionDecorator('doctrine.orm.manager_configurator.abstract'))
  386. ->replaceArgument(0, $enabledFilters)
  387. ->replaceArgument(1, $filtersParameters)
  388. ;
  389. if (!isset($entityManager['connection'])) {
  390. $entityManager['connection'] = $this->defaultConnection;
  391. }
  392. $container
  393. ->setDefinition(sprintf('doctrine.orm.%s_entity_manager', $entityManager['name']), new DefinitionDecorator('doctrine.orm.entity_manager.abstract'))
  394. ->setArguments(array(
  395. new Reference(sprintf('doctrine.dbal.%s_connection', $entityManager['connection'])),
  396. new Reference(sprintf('doctrine.orm.%s_configuration', $entityManager['name'])),
  397. ))
  398. ->setConfigurator(array(new Reference($managerConfiguratorName), 'configure'))
  399. ;
  400. $container->setAlias(
  401. sprintf('doctrine.orm.%s_entity_manager.event_manager', $entityManager['name']),
  402. new Alias(sprintf('doctrine.dbal.%s_connection.event_manager', $entityManager['connection']), false)
  403. );
  404. if (isset($entityManager['entity_listeners'])) {
  405. if (version_compare(Version::VERSION, "2.5.0-DEV") < 0) {
  406. throw new InvalidArgumentException('Entity listeners configuration requires doctrine-orm 2.5.0 or newer');
  407. }
  408. $entities = $entityManager['entity_listeners']['entities'];
  409. $listenerId = sprintf('doctrine.orm.%s_listeners.attach_entity_listeners', $entityManager['name']);
  410. $listenerDef = $container->setDefinition($listenerId, new Definition('%doctrine.orm.listeners.attach_entity_listeners.class%'));
  411. foreach ($entities as $entityListenerClass => $entity) {
  412. foreach ($entity['listeners'] as $listenerClass => $listener) {
  413. foreach ($listener['events'] as $listenerEvent) {
  414. $listenerEventName = $listenerEvent['type'];
  415. $listenerMethod = $listenerEvent['method'];
  416. $listenerDef->addMethodCall('addEntityListener', array(
  417. $entityListenerClass, $listenerClass, $listenerEventName, $listenerMethod,
  418. ));
  419. }
  420. }
  421. }
  422. $listenerDef->addTag('doctrine.event_listener', array('event' => 'loadClassMetadata'));
  423. }
  424. }
  425. /**
  426. * Loads an ORM entity managers bundle mapping information.
  427. *
  428. * There are two distinct configuration possibilities for mapping information:
  429. *
  430. * 1. Specify a bundle and optionally details where the entity and mapping information reside.
  431. * 2. Specify an arbitrary mapping location.
  432. *
  433. * @example
  434. *
  435. * doctrine.orm:
  436. * mappings:
  437. * MyBundle1: ~
  438. * MyBundle2: yml
  439. * MyBundle3: { type: annotation, dir: Entities/ }
  440. * MyBundle4: { type: xml, dir: Resources/config/doctrine/mapping }
  441. * MyBundle5:
  442. * type: yml
  443. * dir: [bundle-mappings1/, bundle-mappings2/]
  444. * alias: BundleAlias
  445. * arbitrary_key:
  446. * type: xml
  447. * dir: %kernel.dir%/../src/vendor/DoctrineExtensions/lib/DoctrineExtensions/Entities
  448. * prefix: DoctrineExtensions\Entities\
  449. * alias: DExt
  450. *
  451. * In the case of bundles everything is really optional (which leads to autodetection for this bundle) but
  452. * in the mappings key everything except alias is a required argument.
  453. *
  454. * @param array $entityManager A configured ORM entity manager
  455. * @param Definition $ormConfigDef A Definition instance
  456. * @param ContainerBuilder $container A ContainerBuilder instance
  457. */
  458. protected function loadOrmEntityManagerMappingInformation(array $entityManager, Definition $ormConfigDef, ContainerBuilder $container)
  459. {
  460. // reset state of drivers and alias map. They are only used by this methods and children.
  461. $this->drivers = array();
  462. $this->aliasMap = array();
  463. $this->loadMappingInformation($entityManager, $container);
  464. $this->registerMappingDrivers($entityManager, $container);
  465. $ormConfigDef->addMethodCall('setEntityNamespaces', array($this->aliasMap));
  466. }
  467. /**
  468. * Loads an ORM second level cache bundle mapping information.
  469. *
  470. * @example
  471. * entity_managers:
  472. * default:
  473. * second_level_cache:
  474. * region_cache_driver: apc
  475. * log_enabled: true
  476. * regions:
  477. * my_service_region:
  478. * type: service
  479. * service : "my_service_region"
  480. *
  481. * my_query_region:
  482. * lifetime: 300
  483. * cache_driver: array
  484. * type: filelock
  485. *
  486. * my_entity_region:
  487. * lifetime: 600
  488. * cache_driver:
  489. * type: apc
  490. *
  491. * @param array $entityManager A configured ORM entity manager
  492. * @param Definition $ormConfigDef A Definition instance
  493. * @param ContainerBuilder $container A ContainerBuilder instance
  494. */
  495. protected function loadOrmSecondLevelCache(array $entityManager, Definition $ormConfigDef, ContainerBuilder $container)
  496. {
  497. if (version_compare(Version::VERSION, '2.5.0-DEV') < 0) {
  498. throw new \InvalidArgumentException('Second-level cache requires doctrine-orm 2.5.0 or newer');
  499. }
  500. $driverId = null;
  501. $enabled = $entityManager['second_level_cache']['enabled'];
  502. if (isset($entityManager['second_level_cache']['region_cache_driver'])) {
  503. $driverName = 'second_level_cache.region_cache_driver';
  504. $driverMap = $entityManager['second_level_cache']['region_cache_driver'];
  505. $driverId = $this->loadCacheDriver($driverName, $entityManager['name'], $driverMap, $container);
  506. }
  507. $configId = sprintf('doctrine.orm.%s_second_level_cache.cache_configuration', $entityManager['name']);
  508. $regionsId = sprintf('doctrine.orm.%s_second_level_cache.regions_configuration', $entityManager['name']);
  509. $driverId = $driverId ?: sprintf('doctrine.orm.%s_second_level_cache.region_cache_driver', $entityManager['name']);
  510. $configDef = $container->setDefinition($configId, new Definition('%doctrine.orm.second_level_cache.cache_configuration.class%'));
  511. $regionsDef = $container->setDefinition($regionsId, new Definition('%doctrine.orm.second_level_cache.regions_configuration.class%'));
  512. $slcFactoryId = sprintf('doctrine.orm.%s_second_level_cache.default_cache_factory', $entityManager['name']);
  513. $slcFactoryDef = $container
  514. ->setDefinition($slcFactoryId, new Definition('%doctrine.orm.second_level_cache.default_cache_factory.class%'))
  515. ->setArguments(array(new Reference($regionsId), new Reference($driverId)));
  516. if (isset($entityManager['second_level_cache']['regions'])) {
  517. foreach ($entityManager['second_level_cache']['regions'] as $name => $region) {
  518. $regionRef = null;
  519. $regionType = $region['type'];
  520. if ($regionType === 'service') {
  521. $regionId = sprintf('doctrine.orm.%s_second_level_cache.region.%s', $entityManager['name'], $name);
  522. $regionRef = new Reference($region['service']);
  523. $container->setAlias($regionId, new Alias($region['service'], false));
  524. }
  525. if ($regionType === 'default' || $regionType === 'filelock') {
  526. $regionId = sprintf('doctrine.orm.%s_second_level_cache.region.%s', $entityManager['name'], $name);
  527. $driverName = sprintf('second_level_cache.region.%s_driver', $name);
  528. $driverMap = $region['cache_driver'];
  529. $driverId = $this->loadCacheDriver($driverName, $entityManager['name'], $driverMap, $container);
  530. $regionRef = new Reference($regionId);
  531. $container
  532. ->setDefinition($regionId, new Definition('%doctrine.orm.second_level_cache.default_region.class%'))
  533. ->setArguments(array($name, new Reference($driverId), $region['lifetime']));
  534. }
  535. if ($regionType === 'filelock') {
  536. $regionId = sprintf('doctrine.orm.%s_second_level_cache.region.%s_filelock', $entityManager['name'], $name);
  537. $container
  538. ->setDefinition($regionId, new Definition('%doctrine.orm.second_level_cache.filelock_region.class%'))
  539. ->setArguments(array($regionRef, $region['lock_path'], $region['lock_lifetime']));
  540. $regionRef = new Reference($regionId);
  541. $regionsDef->addMethodCall('getLockLifetime', array($name, $region['lock_lifetime']));
  542. }
  543. $regionsDef->addMethodCall('setLifetime', array($name, $region['lifetime']));
  544. $slcFactoryDef->addMethodCall('setRegion', array($regionRef));
  545. }
  546. }
  547. if ($entityManager['second_level_cache']['log_enabled']) {
  548. $loggerChainId = sprintf('doctrine.orm.%s_second_level_cache.logger_chain', $entityManager['name']);
  549. $loggerStatsId = sprintf('doctrine.orm.%s_second_level_cache.logger_statistics', $entityManager['name']);
  550. $loggerChaingDef = $container->setDefinition($loggerChainId, new Definition('%doctrine.orm.second_level_cache.logger_chain.class%'));
  551. $loggerStatsDef = $container->setDefinition($loggerStatsId, new Definition('%doctrine.orm.second_level_cache.logger_statistics.class%'));
  552. $loggerChaingDef->addMethodCall('setLogger', array('statistics', $loggerStatsDef));
  553. $configDef->addMethodCall('setCacheLogger', array($loggerChaingDef));
  554. foreach ($entityManager['second_level_cache']['loggers'] as $name => $logger) {
  555. $loggerId = sprintf('doctrine.orm.%s_second_level_cache.logger.%s', $entityManager['name'], $name);
  556. $loggerRef = new Reference($logger['service']);
  557. $container->setAlias($loggerId, new Alias($logger['service'], false));
  558. $loggerChaingDef->addMethodCall('setLogger', array($name, $loggerRef));
  559. }
  560. }
  561. $configDef->addMethodCall('setCacheFactory', array($slcFactoryDef));
  562. $configDef->addMethodCall('setRegionsConfiguration', array($regionsDef));
  563. $ormConfigDef->addMethodCall('setSecondLevelCacheEnabled', array($enabled));
  564. $ormConfigDef->addMethodCall('setSecondLevelCacheConfiguration', array($configDef));
  565. }
  566. /**
  567. * {@inheritDoc}
  568. */
  569. protected function getObjectManagerElementName($name)
  570. {
  571. return 'doctrine.orm.'.$name;
  572. }
  573. protected function getMappingObjectDefaultName()
  574. {
  575. return 'Entity';
  576. }
  577. /**
  578. * {@inheritDoc}
  579. */
  580. protected function getMappingResourceConfigDirectory()
  581. {
  582. return 'Resources/config/doctrine';
  583. }
  584. /**
  585. * {@inheritDoc}
  586. */
  587. protected function getMappingResourceExtension()
  588. {
  589. return 'orm';
  590. }
  591. /**
  592. * {@inheritDoc}
  593. */
  594. protected function loadCacheDriver($driverName, $entityManagerName, array $driverMap, ContainerBuilder $container)
  595. {
  596. if (!empty($driverMap['cache_provider'])) {
  597. $aliasId = $this->getObjectManagerElementName($driverName);
  598. $serviceId = printf('doctrine_cache.providers.%s', $driverMap['cache_provider']);
  599. $container->setAlias($aliasId, new Alias($serviceId, false));
  600. return $aliasId;
  601. }
  602. return $this->adapter->loadCacheDriver($driverName, $entityManagerName, $driverMap, $container);
  603. }
  604. /**
  605. * Loads a configured entity managers cache drivers.
  606. *
  607. * @param array $entityManager A configured ORM entity manager.
  608. * @param ContainerBuilder $container A ContainerBuilder instance
  609. */
  610. protected function loadOrmCacheDrivers(array $entityManager, ContainerBuilder $container)
  611. {
  612. $this->loadCacheDriver('metadata_cache', $entityManager['name'], $entityManager['metadata_cache_driver'], $container);
  613. $this->loadCacheDriver('result_cache', $entityManager['name'], $entityManager['result_cache_driver'], $container);
  614. $this->loadCacheDriver('query_cache', $entityManager['name'], $entityManager['query_cache_driver'], $container);
  615. }
  616. /**
  617. * @param array $objectManager
  618. * @param ContainerBuilder $container
  619. * @param string $cacheName
  620. */
  621. public function loadObjectManagerCacheDriver(array $objectManager, ContainerBuilder $container, $cacheName)
  622. {
  623. $this->loadCacheDriver($cacheName, $objectManager['name'], $objectManager[$cacheName.'_driver'], $container);
  624. }
  625. /**
  626. * {@inheritDoc}
  627. */
  628. public function getXsdValidationBasePath()
  629. {
  630. return __DIR__.'/../Resources/config/schema';
  631. }
  632. /**
  633. * {@inheritDoc}
  634. */
  635. public function getNamespace()
  636. {
  637. return 'http://symfony.com/schema/dic/doctrine';
  638. }
  639. /**
  640. * {@inheritDoc}
  641. */
  642. public function getConfiguration(array $config, ContainerBuilder $container)
  643. {
  644. return new Configuration($container->getParameter('kernel.debug'));
  645. }
  646. }