, * driver_schemes: array, * default_connection: string, * types: array, * } */ class DoctrineExtension extends Extension { /** * Used inside metadata driver method to simplify aggregation of data. * * @var array List of alias => namespace */ protected array $aliasMap = []; /** * Used inside metadata driver method to simplify aggregation of data. * * @var array> List of driver type => prefix => path */ protected array $drivers = []; /** * @param array $objectManager A configured object manager * * @return void * * @throws InvalidArgumentException */ protected function loadMappingInformation(array $objectManager, ContainerBuilder $container) { if ($objectManager['auto_mapping']) { // automatically register bundle mappings foreach (array_keys($container->getParameter('kernel.bundles')) as $bundle) { if (isset($objectManager['mappings'][$bundle])) { continue; } $objectManager['mappings'][$bundle] = [ 'mapping' => true, 'is_bundle' => true, ]; } } foreach ($objectManager['mappings'] as $mappingName => $mappingConfig) { if ($mappingConfig !== null && $mappingConfig['mapping'] === false) { continue; } $mappingConfig = array_replace([ 'dir' => false, 'type' => false, 'prefix' => false, ], (array) $mappingConfig); $mappingConfig['dir'] = $container->getParameterBag()->resolveValue($mappingConfig['dir']); // a bundle configuration is detected by realizing that the specified dir is not absolute and existing if (! isset($mappingConfig['is_bundle'])) { $mappingConfig['is_bundle'] = ! is_dir((string) $mappingConfig['dir']); } if ($mappingConfig['is_bundle']) { $bundle = null; $bundleMetadata = null; foreach ($container->getParameter('kernel.bundles') as $name => $class) { if ($mappingName === $name) { $bundle = new ReflectionClass($class); $bundleMetadata = $container->getParameter('kernel.bundles_metadata')[$name]; break; } } if ($bundle === null) { throw new InvalidArgumentException(sprintf('Bundle "%s" does not exist or it is not enabled.', $mappingName)); } $mappingConfig = $this->getMappingDriverBundleConfigDefaults($mappingConfig, $bundle, $container, $bundleMetadata['path']); if (! $mappingConfig) { continue; } } elseif (! $mappingConfig['type']) { $mappingConfig['type'] = $this->detectMappingType($mappingConfig['dir'], $container); } $this->assertValidMappingConfiguration($mappingConfig, $objectManager['name']); $this->setMappingDriverConfig($mappingConfig, $mappingName); $this->setMappingDriverAlias($mappingConfig, $mappingName); } } /** * Register the alias for this mapping driver. * * Aliases can be used in the Query languages of all the Doctrine object managers to simplify writing tasks. * * @param array $mappingConfig * * @return void */ protected function setMappingDriverAlias(array $mappingConfig, string $mappingName) { if (isset($mappingConfig['alias'])) { $this->aliasMap[$mappingConfig['alias']] = $mappingConfig['prefix']; } else { $this->aliasMap[$mappingName] = $mappingConfig['prefix']; } } /** * Register the mapping driver configuration for later use with the object managers metadata driver chain. * * @param array $mappingConfig * * @return void * * @throws InvalidArgumentException */ protected function setMappingDriverConfig(array $mappingConfig, string $mappingName) { $mappingDirectory = $mappingConfig['dir']; if (! is_dir($mappingDirectory)) { throw new InvalidArgumentException(sprintf('Invalid Doctrine mapping path given. Cannot load Doctrine mapping/bundle named "%s".', $mappingName)); } $this->drivers[$mappingConfig['type']][$mappingConfig['prefix']] = realpath($mappingDirectory) ?: $mappingDirectory; } /** * If this is a bundle controlled mapping all the missing information can be autodetected by this method. * * Returns false when autodetection failed, an array of the completed information otherwise. * * @param array $bundleConfig */ protected function getMappingDriverBundleConfigDefaults( array $bundleConfig, ReflectionClass $bundle, ContainerBuilder $container, string|null $bundleDir = null, ): array|false { $bundleClassDir = dirname($bundle->getFileName()); $bundleDir ??= $bundleClassDir; if (! $bundleConfig['type']) { $bundleConfig['type'] = $this->detectMetadataDriver($bundleDir, $container); if (! $bundleConfig['type'] && $bundleDir !== $bundleClassDir) { $bundleConfig['type'] = $this->detectMetadataDriver($bundleClassDir, $container); } } if (! $bundleConfig['type']) { // skip this bundle, no mapping information was found. return false; } if (! $bundleConfig['dir']) { if (in_array($bundleConfig['type'], ['annotation', 'staticphp', 'attribute'])) { $bundleConfig['dir'] = $bundleClassDir . '/' . $this->getMappingObjectDefaultName(); } else { $bundleConfig['dir'] = $bundleDir . '/' . $this->getMappingResourceConfigDirectory($bundleDir); } } else { $bundleConfig['dir'] = $bundleDir . '/' . $bundleConfig['dir']; } if (! $bundleConfig['prefix']) { $bundleConfig['prefix'] = $bundle->getNamespaceName() . '\\' . $this->getMappingObjectDefaultName(); } return $bundleConfig; } /** * Register all the collected mapping information with the object manager by registering the appropriate mapping drivers. * * @param array $objectManager * * @return void */ protected function registerMappingDrivers(array $objectManager, ContainerBuilder $container) { // configure metadata driver for each bundle based on the type of mapping files found if ($container->hasDefinition($this->getObjectManagerElementName($objectManager['name'] . '_metadata_driver'))) { $chainDriverDef = $container->getDefinition($this->getObjectManagerElementName($objectManager['name'] . '_metadata_driver')); } else { $chainDriverDef = new Definition($this->getMetadataDriverClass('driver_chain')); } foreach ($this->drivers as $driverType => $driverPaths) { $mappingService = $this->getObjectManagerElementName($objectManager['name'] . '_' . $driverType . '_metadata_driver'); if ($container->hasDefinition($mappingService)) { $mappingDriverDef = $container->getDefinition($mappingService); $args = $mappingDriverDef->getArguments(); if ($driverType === 'annotation') { $args[1] = array_merge(array_values($driverPaths), $args[1]); } else { $args[0] = array_merge(array_values($driverPaths), $args[0]); } $mappingDriverDef->setArguments($args); } elseif ($driverType === 'attribute') { $mappingDriverDef = new Definition($this->getMetadataDriverClass($driverType), [ array_values($driverPaths), ]); } elseif ($driverType === 'annotation') { $mappingDriverDef = new Definition($this->getMetadataDriverClass($driverType), [ new Reference($this->getObjectManagerElementName('metadata.annotation_reader')), array_values($driverPaths), ]); } else { $mappingDriverDef = new Definition($this->getMetadataDriverClass($driverType), [ array_values($driverPaths), ]); } if ( str_contains($mappingDriverDef->getClass(), 'yml') || str_contains($mappingDriverDef->getClass(), 'xml') || str_contains($mappingDriverDef->getClass(), 'Yaml') || str_contains($mappingDriverDef->getClass(), 'Xml') ) { $mappingDriverDef->setArguments([array_flip($driverPaths)]); $mappingDriverDef->addMethodCall('setGlobalBasename', ['mapping']); } $container->setDefinition($mappingService, $mappingDriverDef); foreach ($driverPaths as $prefix => $driverPath) { $chainDriverDef->addMethodCall('addDriver', [new Reference($mappingService), $prefix]); } } $container->setDefinition($this->getObjectManagerElementName($objectManager['name'] . '_metadata_driver'), $chainDriverDef); } /** * Assertion if the specified mapping information is valid. * * @param array $mappingConfig * * @return void * * @throws InvalidArgumentException */ protected function assertValidMappingConfiguration(array $mappingConfig, string $objectManagerName) { if (! $mappingConfig['type'] || ! $mappingConfig['dir'] || ! $mappingConfig['prefix']) { throw new InvalidArgumentException(sprintf('Mapping definitions for Doctrine manager "%s" require at least the "type", "dir" and "prefix" options.', $objectManagerName)); } if (! is_dir($mappingConfig['dir'])) { throw new InvalidArgumentException(sprintf('Specified non-existing directory "%s" as Doctrine mapping source.', $mappingConfig['dir'])); } if (! in_array($mappingConfig['type'], ['xml', 'yml', 'annotation', 'php', 'staticphp', 'attribute'])) { throw new InvalidArgumentException(sprintf('Can only configure "xml", "yml", "annotation", "php", "staticphp" or "attribute" through the DoctrineBundle. Use your own bundle to configure other metadata drivers. You can register them by adding a new driver to the "%s" service definition.', $this->getObjectManagerElementName($objectManagerName . '_metadata_driver'))); } } /** * Detects what metadata driver to use for the supplied directory. */ protected function detectMetadataDriver(string $dir, ContainerBuilder $container): string|null { $configPath = $this->getMappingResourceConfigDirectory($dir); $extension = $this->getMappingResourceExtension(); if (glob($dir . '/' . $configPath . '/*.' . $extension . '.xml', GLOB_NOSORT)) { $driver = 'xml'; } elseif (glob($dir . '/' . $configPath . '/*.' . $extension . '.yml', GLOB_NOSORT)) { $driver = 'yml'; } elseif (glob($dir . '/' . $configPath . '/*.' . $extension . '.php', GLOB_NOSORT)) { $driver = 'php'; } else { // add the closest existing directory as a resource $resource = $dir . '/' . $configPath; while (! is_dir($resource)) { $resource = dirname($resource); } $container->fileExists($resource, false); $discoveryPath = $dir . '/' . $this->getMappingObjectDefaultName(); if ($container->fileExists($discoveryPath, false)) { return $this->detectMappingType($discoveryPath, $container); } return null; } $container->fileExists($dir . '/' . $configPath, false); return $driver; } /** * Detects what mapping type to use for the supplied directory. * * @return string A mapping type 'attribute' or 'annotation' */ private function detectMappingType(string $directory, ContainerBuilder $container): string { $type = 'attribute'; $glob = new GlobResource($directory, '*', true); $container->addResource($glob); $quotedMappingObjectName = preg_quote($this->getMappingObjectDefaultName(), '/'); foreach ($glob as $file) { $content = file_get_contents((string) $file); if ( preg_match('/^#\[.*' . $quotedMappingObjectName . '\b/m', $content) || preg_match('/^#\[.*Embeddable\b/m', $content) || preg_match('/^#\[.*MappedSuperclass\b/m', $content) ) { break; } if ( self::textContainsAnnotation($quotedMappingObjectName, $content) || self::textContainsAnnotation('Embeddable', $content) || self::textContainsAnnotation('MappedSuperclass', $content) ) { $type = 'annotation'; break; } } return $type; } /** * Check if the file content contains a class-like annotation * * @internal */ public static function textContainsAnnotation(string $quotedMappingObjectName, string $content): bool { return preg_match('/^(?:[ ]\*|\/\*\*)[ ]@ # Match phpdoc start or line with an at \\\\? # Can start with antislash ([a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*\\\\)* # Match namespace components ending with antislash ' . $quotedMappingObjectName . ' # The target class \b # Match word boundary /mx', $content) === 1; } /** * Returns a modified version of $managerConfigs. * * The manager called $autoMappedManager will map all bundles that are not mapped by other managers. * * @param array> $managerConfigs * @param array $bundles * * @return array> */ protected function fixManagersAutoMappings(array $managerConfigs, array $bundles): array { $autoMappedManager = $this->validateAutoMapping($managerConfigs); if ($autoMappedManager !== null) { foreach (array_keys($bundles) as $bundle) { foreach ($managerConfigs as $manager) { if (isset($manager['mappings'][$bundle])) { continue 2; } } $managerConfigs[$autoMappedManager]['mappings'][$bundle] = [ 'mapping' => true, 'is_bundle' => true, ]; } $managerConfigs[$autoMappedManager]['auto_mapping'] = false; } return $managerConfigs; } /** * Search for a manager that is declared as 'auto_mapping' = true. * * @param array> $managerConfigs * * @throws LogicException */ private function validateAutoMapping(array $managerConfigs): string|null { $autoMappedManager = null; foreach ($managerConfigs as $name => $manager) { if (! $manager['auto_mapping']) { continue; } if ($autoMappedManager !== null) { throw new LogicException(sprintf('You cannot enable "auto_mapping" on more than one manager at the same time (found in "%s" and "%s"").', $autoMappedManager, $name)); } $autoMappedManager = $name; } return $autoMappedManager; } private string $defaultConnection; /** * {@inheritDoc} * * @return void */ public function load(array $configs, ContainerBuilder $container) { $configuration = $this->getConfiguration($configs, $container); $config = $this->processConfigurationPrependingDefaults($configuration, $configs); if (! empty($config['dbal'])) { $this->dbalLoad($config['dbal'], $container); $this->loadMessengerServices($container); } if (empty($config['orm'])) { return; } if (empty($config['dbal'])) { throw new LogicException('Configuring the ORM layer requires to configure the DBAL layer as well.'); } $this->ormLoad($config['orm'], $container); } /** * Process user configuration and adds a default DBAL connection and/or a * default EM if required, then process again the configuration to get * default values for each. * * @param array> $configs * * @return array */ private function processConfigurationPrependingDefaults(ConfigurationInterface $configuration, array $configs): array { $config = $this->processConfiguration($configuration, $configs); $configToAdd = []; // if no DB connection defined, prepend an empty one for the default // connection name in order to make Symfony Config resolve the default // values if (isset($config['dbal']) && empty($config['dbal']['connections'])) { $configToAdd['dbal'] = ['connections' => [($config['dbal']['default_connection'] ?? 'default') => []]]; } // if no EM defined, prepend an empty one for the default EM name in // order to make Symfony Config resolve the default values if (isset($config['orm']) && empty($config['orm']['entity_managers'])) { $configToAdd['orm'] = ['entity_managers' => [($config['orm']['default_entity_manager'] ?? 'default') => []]]; } if (! $configToAdd) { return $config; } return $this->processConfiguration($configuration, array_merge([$configToAdd], $configs)); } /** * Loads the DBAL configuration. * * Usage example: * * * * @param DBALConfig $config An array of configuration settings * @param ContainerBuilder $container A ContainerBuilder instance */ protected function dbalLoad(array $config, ContainerBuilder $container) { $loader = new PhpFileLoader($container, new FileLocator(__DIR__ . '/../../config')); $loader->load('dbal.php'); if (empty($config['default_connection'])) { $keys = array_keys($config['connections']); $config['default_connection'] = reset($keys); } $this->defaultConnection = $config['default_connection']; $container->setAlias('database_connection', sprintf('doctrine.dbal.%s_connection', $this->defaultConnection)); $container->getAlias('database_connection')->setPublic(true); $container->setAlias('doctrine.dbal.event_manager', new Alias(sprintf('doctrine.dbal.%s_connection.event_manager', $this->defaultConnection), false)); $container->setParameter('doctrine.dbal.connection_factory.types', $config['types']); $container->getDefinition('doctrine.dbal.connection_factory.dsn_parser')->setArgument(0, array_merge(ConnectionFactory::DEFAULT_SCHEME_MAP, $config['driver_schemes'])); $connections = []; foreach (array_keys($config['connections']) as $name) { $connections[$name] = sprintf('doctrine.dbal.%s_connection', $name); } $container->setParameter('doctrine.connections', $connections); $container->setParameter('doctrine.default_connection', $this->defaultConnection); $connWithLogging = []; $connWithProfiling = []; $connWithBacktrace = []; $ttlByConnection = []; foreach ($config['connections'] as $name => $connection) { if ($connection['logging']) { $connWithLogging[] = $name; } if ($connection['profiling']) { $connWithProfiling[] = $name; if ($connection['profiling_collect_backtrace']) { $connWithBacktrace[] = $name; } } if ($connection['idle_connection_ttl'] > 0) { $ttlByConnection[$name] = $connection['idle_connection_ttl']; } $this->loadDbalConnection($name, $connection, $container); } $container->registerForAutoconfiguration(MiddlewareInterface::class)->addTag('doctrine.middleware'); $container->registerAttributeForAutoconfiguration(AsMiddleware::class, static function (ChildDefinition $definition, AsMiddleware $attribute) { $priority = isset($attribute->priority) ? ['priority' => $attribute->priority] : []; if ($attribute->connections === []) { $definition->addTag('doctrine.middleware', $priority); return; } foreach ($attribute->connections as $connName) { $definition->addTag('doctrine.middleware', array_merge($priority, ['connection' => $connName])); } }); $this->registerDbalMiddlewares($container, $connWithLogging, $connWithProfiling, $connWithBacktrace, array_keys($ttlByConnection)); $container->getDefinition('doctrine.dbal.idle_connection_middleware')->setArgument(1, $ttlByConnection); if (class_exists(Listener::class)) { return; } $container->removeDefinition('doctrine.dbal.idle_connection_listener'); $container->removeDefinition('doctrine.dbal.idle_connection_middleware'); } /** * Loads a configured DBAL connection. * * @param string $name The name of the connection * @param array $connection A dbal connection configuration. * @param ContainerBuilder $container A ContainerBuilder instance */ protected function loadDbalConnection($name, array $connection, ContainerBuilder $container) { $configuration = $container->setDefinition(sprintf('doctrine.dbal.%s_connection.configuration', $name), new ChildDefinition('doctrine.dbal.connection.configuration')); unset($connection['logging']); $dataCollectorDefinition = $container->getDefinition('data_collector.doctrine'); $dataCollectorDefinition->replaceArgument(1, $connection['profiling_collect_schema_errors']); unset( $connection['profiling'], $connection['profiling_collect_backtrace'], $connection['profiling_collect_schema_errors'], ); if (isset($connection['auto_commit'])) { $configuration->addMethodCall('setAutoCommit', [$connection['auto_commit']]); } unset($connection['auto_commit']); if (isset($connection['disable_type_comments'])) { $configuration->addMethodCall('setDisableTypeComments', [$connection['disable_type_comments']]); } unset($connection['disable_type_comments']); if (isset($connection['schema_filter']) && $connection['schema_filter']) { $definition = new Definition(RegexSchemaAssetFilter::class, [$connection['schema_filter']]); $definition->addTag('doctrine.dbal.schema_filter', ['connection' => $name]); $container->setDefinition(sprintf('doctrine.dbal.%s_regex_schema_filter', $name), $definition); } unset($connection['schema_filter']); // event manager $container->setDefinition(sprintf('doctrine.dbal.%s_connection.event_manager', $name), new ChildDefinition('doctrine.dbal.connection.event_manager')); // connection $options = $this->getConnectionOptions($connection); $connectionId = sprintf('doctrine.dbal.%s_connection', $name); $def = $container ->setDefinition($connectionId, new ChildDefinition('doctrine.dbal.connection')) ->setPublic(true) ->setArguments([ $options, new Reference(sprintf('doctrine.dbal.%s_connection.configuration', $name)), // event manager is only supported on DBAL < 4 method_exists(Connection::class, 'getEventManager') ? new Reference(sprintf('doctrine.dbal.%s_connection.event_manager', $name)) : null, $connection['mapping_types'], ]); $container ->registerAliasForArgument($connectionId, Connection::class, sprintf('%s.connection', $name)) ->setPublic(false); // Set class in case "wrapper_class" option was used to assist IDEs if (isset($options['wrapperClass'])) { $def->setClass($options['wrapperClass']); } if (isset($connection['use_savepoints'])) { // DBAL >= 4 always has savepoints enabled. So we only need to call "setNestTransactionsWithSavepoints" for DBAL < 4 if (method_exists(Connection::class, 'getEventManager')) { if ($connection['use_savepoints']) { $def->addMethodCall('setNestTransactionsWithSavepoints', [$connection['use_savepoints']]); } } elseif (! $connection['use_savepoints']) { throw new LogicException('The "use_savepoints" option can only be set to "true" and should ideally not be set when using DBAL >= 4'); } } $container->setDefinition( ManagerRegistryAwareConnectionProvider::class, new Definition(ManagerRegistryAwareConnectionProvider::class, [$container->getDefinition('doctrine')]), ); $configuration->addMethodCall('setSchemaManagerFactory', [new Reference($connection['schema_manager_factory'])]); if (isset($connection['result_cache'])) { $configuration->addMethodCall('setResultCache', [new Reference($connection['result_cache'])]); } if (class_exists(LegacySchemaManagerFactory::class)) { return; } $container->removeDefinition('doctrine.dbal.legacy_schema_manager_factory'); } /** * @param array $connection * * @return mixed[] */ protected function getConnectionOptions(array $connection): array { $options = $connection; $connectionDefaults = [ 'host' => 'localhost', 'port' => null, 'user' => 'root', 'password' => null, ]; if ($options['override_url'] ?? false) { $options['connection_override_options'] = array_intersect_key($options, ['dbname' => null] + $connectionDefaults); } unset($options['override_url']); unset($options['schema_manager_factory']); $options += $connectionDefaults; foreach (['replicas', 'slaves'] as $connectionKey) { foreach (array_keys($options[$connectionKey]) as $name) { $options[$connectionKey][$name] += $connectionDefaults; } } if (isset($options['platform_service'])) { $options['platform'] = new Reference($options['platform_service']); unset($options['platform_service']); } unset($options['mapping_types']); foreach ( [ 'options' => 'driverOptions', 'driver_class' => 'driverClass', 'wrapper_class' => 'wrapperClass', 'keep_slave' => 'keepReplica', 'keep_replica' => 'keepReplica', 'replicas' => 'replica', 'server_version' => 'serverVersion', 'default_table_options' => 'defaultTableOptions', ] as $old => $new ) { if (! isset($options[$old])) { continue; } $options[$new] = $options[$old]; unset($options[$old]); } foreach (['replica', 'slaves'] as $connectionKey) { foreach ($options[$connectionKey] as $name => $value) { $driverOptions = $value['driverOptions'] ?? []; $parentDriverOptions = $options['driverOptions'] ?? []; if ($driverOptions === [] && $parentDriverOptions === []) { continue; } $options[$connectionKey][$name]['driverOptions'] = $driverOptions + $parentDriverOptions; } } if (! empty($options['slaves']) || ! empty($options['replica'])) { $nonRewrittenKeys = [ 'driver' => true, 'driverClass' => true, 'wrapperClass' => true, 'keepSlave' => true, 'keepReplica' => true, 'platform' => true, 'slaves' => true, 'primary' => true, 'replica' => true, 'serverVersion' => true, 'defaultTableOptions' => true, // included by safety but should have been unset already 'logging' => true, 'profiling' => true, 'mapping_types' => true, 'platform_service' => true, ]; foreach ($options as $key => $value) { if (isset($nonRewrittenKeys[$key])) { continue; } $options['primary'][$key] = $value; unset($options[$key]); } if (empty($options['wrapperClass'])) { // Change the wrapper class only if user did not configure custom one. $options['wrapperClass'] = PrimaryReadReplicaConnection::class; } } else { unset($options['slaves'], $options['replica']); } return $options; } /** * Loads the Doctrine ORM configuration. * * Usage example: * * * * @param array $config An array of configuration settings * @param ContainerBuilder $container A ContainerBuilder instance */ protected function ormLoad(array $config, ContainerBuilder $container) { if (! class_exists(UnitOfWork::class)) { throw new LogicException('To configure the ORM layer, you must first install the doctrine/orm package.'); } $loader = new PhpFileLoader($container, new FileLocator(__DIR__ . '/../../config')); $loader->load('orm.php'); if (class_exists(AbstractType::class)) { $container->getDefinition('form.type.entity')->addTag('kernel.reset', ['method' => 'reset']); } if (! class_exists(Annotation::class)) { $container->removeAlias('doctrine.orm.metadata.annotation_reader'); } if (! class_exists(UlidGenerator::class)) { $container->removeDefinition('doctrine.ulid_generator'); } if (! class_exists(UuidGenerator::class)) { $container->removeDefinition('doctrine.uuid_generator'); } if (! class_exists(ExpressionLanguage::class)) { $container->removeDefinition('doctrine.orm.entity_value_resolver.expression_language'); } $controllerResolverDefaults = []; if (! $config['controller_resolver']['enabled']) { $controllerResolverDefaults['disabled'] = true; } if ($config['controller_resolver']['auto_mapping'] === null) { Deprecation::trigger( 'doctrine/doctrine-bundle', 'https://github.com/doctrine/DoctrineBundle/pull/1762', 'The default value of "doctrine.orm.controller_resolver.auto_mapping" will be changed from `true` to `false`. Explicitly configure `true` to keep existing behaviour.', ); $config['controller_resolver']['auto_mapping'] = true; } if ($config['controller_resolver']['auto_mapping'] === true) { Deprecation::trigger( 'doctrine/doctrine-bundle', 'https://github.com/doctrine/DoctrineBundle/pull/1804', 'Enabling the controller resolver automapping feature has been deprecated. Symfony Mapped Route Parameters should be used as replacement.', ); } if (! $config['controller_resolver']['auto_mapping']) { $controllerResolverDefaults['mapping'] = []; } if ($config['controller_resolver']['evict_cache']) { $controllerResolverDefaults['evict_cache'] = true; } $valueResolverDefinition = $container->getDefinition('doctrine.orm.entity_value_resolver'); $valueResolverDefinition->setArgument(2, (new Definition(MapEntity::class))->setArguments([ null, null, null, $controllerResolverDefaults['mapping'] ?? null, null, null, null, $controllerResolverDefaults['evict_cache'] ?? null, $controllerResolverDefaults['disabled'] ?? false, ])); // Symfony 7.3 and higher expose type alias support in the EntityValueResolver $valueResolverDefinition->setArgument(3, $config['resolve_target_entities']); // not available in Doctrine ORM 3.0 and higher if (! class_exists(ConvertMappingCommand::class)) { $container->removeDefinition('doctrine.mapping_convert_command'); } if (! class_exists(EnsureProductionSettingsCommand::class)) { $container->removeDefinition('doctrine.ensure_production_settings_command'); } if (! class_exists(ClassMetadataExporter::class)) { $container->removeDefinition('doctrine.mapping_import_command'); } $entityManagers = []; foreach (array_keys($config['entity_managers']) as $name) { $entityManagers[$name] = sprintf('doctrine.orm.%s_entity_manager', $name); } $container->setParameter('doctrine.entity_managers', $entityManagers); if (empty($config['default_entity_manager'])) { $tmp = array_keys($entityManagers); $config['default_entity_manager'] = reset($tmp); } $container->setParameter('doctrine.default_entity_manager', $config['default_entity_manager']); if ($config['enable_lazy_ghost_objects'] ?? false) { if (! class_exists(ProxyHelper::class)) { throw new LogicException( 'Lazy ghost objects cannot be enabled because the "symfony/var-exporter" library' . ' is not installed. Please run "composer require symfony/var-exporter".', ); } } elseif (! method_exists(ProxyFactory::class, 'resetUninitializedProxy')) { throw new LogicException( 'Lazy ghost objects cannot be disabled for ORM 3.', ); } else { Deprecation::trigger( 'doctrine/doctrine-bundle', 'https://github.com/doctrine/DoctrineBundle/pull/1568', 'Not setting "doctrine.orm.enable_lazy_ghost_objects" to true is deprecated.', ); } if ($config['enable_native_lazy_objects'] ?? false) { /** @phpstan-ignore function.alreadyNarrowedType */ if (! method_exists(ORMConfiguration::class, 'enableNativeLazyObjects')) { throw new LogicException( 'Native lazy objects are not supported with your installed version of the ORM. Please upgrade to "doctrine/orm >= 3.4".', ); } if (PHP_VERSION_ID < 80400) { throw new LogicException('Using native lazy objects requires PHP 8.4 or higher.'); } $container->removeDefinition('doctrine.orm.proxy_cache_warmer'); } elseif (! class_exists(AnnotationDriver::class) && PHP_VERSION_ID >= 80400) { // Only emit the deprecation notice for ORM 3 and PHP 8.4+ users Deprecation::trigger( 'doctrine/doctrine-bundle', 'https://github.com/doctrine/DoctrineBundle/pull/1905', 'Not setting "doctrine.orm.enable_native_lazy_objects" to true is deprecated.', ); } $options = ['auto_generate_proxy_classes', 'enable_lazy_ghost_objects', 'enable_native_lazy_objects', 'proxy_dir', 'proxy_namespace']; foreach ($options as $key) { $container->setParameter('doctrine.orm.' . $key, $config[$key]); } $container->setAlias('doctrine.orm.entity_manager', $defaultEntityManagerDefinitionId = sprintf('doctrine.orm.%s_entity_manager', $config['default_entity_manager'])); $container->getAlias('doctrine.orm.entity_manager')->setPublic(true); $config['entity_managers'] = $this->fixManagersAutoMappings($config['entity_managers'], $container->getParameter('kernel.bundles')); foreach ($config['entity_managers'] as $name => $entityManager) { $entityManager['name'] = $name; $this->loadOrmEntityManager($entityManager, $container); if (interface_exists(PropertyInfoExtractorInterface::class)) { $this->loadPropertyInfoExtractor($name, $container); } if (! interface_exists(LoaderInterface::class)) { continue; } $this->loadValidatorLoader($name, $container); } if ($config['resolve_target_entities']) { $def = $container->findDefinition('doctrine.orm.listeners.resolve_target_entity'); foreach ($config['resolve_target_entities'] as $name => $implementation) { $def->addMethodCall('addResolveTargetEntity', [ $name, $implementation, [], ]); } $def ->addTag('doctrine.event_listener', ['event' => Events::loadClassMetadata]) ->addTag('doctrine.event_listener', ['event' => Events::onClassMetadataNotFound]); } $container->registerForAutoconfiguration(ServiceEntityRepositoryInterface::class) ->addTag(ServiceRepositoryCompilerPass::REPOSITORY_SERVICE_TAG); $container->registerForAutoconfiguration(EventSubscriberInterface::class) ->addTag('doctrine.event_subscriber'); $container->registerForAutoconfiguration(AbstractIdGenerator::class) ->addTag(IdGeneratorPass::ID_GENERATOR_TAG); $container->registerAttributeForAutoconfiguration(AsEntityListener::class, static function (ChildDefinition $definition, AsEntityListener $attribute) { $definition->addTag('doctrine.orm.entity_listener', [ 'event' => $attribute->event, 'method' => $attribute->method, 'lazy' => $attribute->lazy, 'entity_manager' => $attribute->entityManager, 'entity' => $attribute->entity, 'priority' => $attribute->priority, ]); }); $container->registerAttributeForAutoconfiguration(AsDoctrineListener::class, static function (ChildDefinition $definition, AsDoctrineListener $attribute) { $definition->addTag('doctrine.event_listener', [ 'event' => $attribute->event, 'priority' => $attribute->priority, 'connection' => $attribute->connection, ]); }); $container->registerAttributeForAutoconfiguration(Embeddable::class, static function (ChildDefinition $definition) { $definition->setAbstract(true)->addTag('container.excluded', ['source' => sprintf('with #[%s] attribute', Embeddable::class)]); }); $container->registerAttributeForAutoconfiguration(Entity::class, static function (ChildDefinition $definition) { $definition->setAbstract(true)->addTag('container.excluded', ['source' => sprintf('with #[%s] attribute', Entity::class)]); }); $container->registerAttributeForAutoconfiguration(MappedSuperclass::class, static function (ChildDefinition $definition) { $definition->setAbstract(true)->addTag('container.excluded', ['source' => sprintf('with #[%s] attribute', MappedSuperclass::class)]); }); /** @see DoctrineBundle::boot() */ $container->getDefinition($defaultEntityManagerDefinitionId) ->addTag('container.preload', [ 'class' => Autoloader::class, ]); } /** * Loads a configured ORM entity manager. * * @param array $entityManager A configured ORM entity manager. * @param ContainerBuilder $container A ContainerBuilder instance */ protected function loadOrmEntityManager(array $entityManager, ContainerBuilder $container) { $ormConfigDef = $container->setDefinition(sprintf('doctrine.orm.%s_configuration', $entityManager['name']), new ChildDefinition('doctrine.orm.configuration')); $ormConfigDef->addTag(IdGeneratorPass::CONFIGURATION_TAG); $this->loadOrmEntityManagerMappingInformation($entityManager, $ormConfigDef, $container); $this->loadOrmCacheDrivers($entityManager, $container); if (isset($entityManager['entity_listener_resolver']) && $entityManager['entity_listener_resolver']) { $container->setAlias(sprintf('doctrine.orm.%s_entity_listener_resolver', $entityManager['name']), $entityManager['entity_listener_resolver']); } else { $definition = new Definition('%doctrine.orm.entity_listener_resolver.class%'); $definition->addArgument(new Reference('service_container')); $container->setDefinition(sprintf('doctrine.orm.%s_entity_listener_resolver', $entityManager['name']), $definition); } $methods = [ 'setMetadataCache' => new Reference(sprintf('doctrine.orm.%s_metadata_cache', $entityManager['name'])), 'setQueryCache' => new Reference(sprintf('doctrine.orm.%s_query_cache', $entityManager['name'])), 'setResultCache' => new Reference(sprintf('doctrine.orm.%s_result_cache', $entityManager['name'])), 'setMetadataDriverImpl' => new Reference('doctrine.orm.' . $entityManager['name'] . '_metadata_driver'), 'setProxyDir' => '%doctrine.orm.proxy_dir%', 'setProxyNamespace' => '%doctrine.orm.proxy_namespace%', 'setAutoGenerateProxyClasses' => '%doctrine.orm.auto_generate_proxy_classes%', 'setSchemaIgnoreClasses' => $entityManager['schema_ignore_classes'], 'setClassMetadataFactoryName' => $entityManager['class_metadata_factory_name'], 'setDefaultRepositoryClassName' => $entityManager['default_repository_class'], 'setNamingStrategy' => new Reference($entityManager['naming_strategy']), 'setQuoteStrategy' => new Reference($entityManager['quote_strategy']), 'setTypedFieldMapper' => new Reference($entityManager['typed_field_mapper']), 'setEntityListenerResolver' => new Reference(sprintf('doctrine.orm.%s_entity_listener_resolver', $entityManager['name'])), 'setLazyGhostObjectEnabled' => '%doctrine.orm.enable_lazy_ghost_objects%', 'setIdentityGenerationPreferences' => $entityManager['identity_generation_preferences'], ]; if (PHP_VERSION_ID >= 80400 && class_exists(LegacyReflectionFields::class)) { $enableNativeLazyObjects = $container->getParameter('doctrine.orm.enable_native_lazy_objects'); assert(is_bool($enableNativeLazyObjects)); $methods['enableNativeLazyObjects'] = $enableNativeLazyObjects; // Do not set deprecated proxy configurations when native lazy objects are enabled with `doctrine/orm:^3.5` /** @phpstan-ignore function.alreadyNarrowedType */ if ($enableNativeLazyObjects && method_exists(ORMSetup::class, 'createAttributeMetadataConfig')) { unset( $methods['setProxyDir'], $methods['setProxyNamespace'], $methods['setAutoGenerateProxyClasses'], ); } } if (isset($entityManager['fetch_mode_subselect_batch_size'])) { $methods['setEagerFetchBatchSize'] = $entityManager['fetch_mode_subselect_batch_size']; } $listenerId = sprintf('doctrine.orm.%s_listeners.attach_entity_listeners', $entityManager['name']); $listenerDef = $container->setDefinition($listenerId, new Definition('%doctrine.orm.listeners.attach_entity_listeners.class%')); $listenerTagParams = ['event' => 'loadClassMetadata']; if (isset($entityManager['connection'])) { $listenerTagParams['connection'] = $entityManager['connection']; } $listenerDef->addTag('doctrine.event_listener', $listenerTagParams); if (isset($entityManager['second_level_cache'])) { $this->loadOrmSecondLevelCache($entityManager, $ormConfigDef, $container); } if ($entityManager['repository_factory']) { $methods['setRepositoryFactory'] = new Reference($entityManager['repository_factory']); } foreach ($methods as $method => $arg) { $ormConfigDef->addMethodCall($method, [$arg]); } foreach ($entityManager['hydrators'] as $name => $class) { $ormConfigDef->addMethodCall('addCustomHydrationMode', [$name, $class]); } if (! empty($entityManager['dql'])) { foreach ($entityManager['dql']['string_functions'] as $name => $function) { $ormConfigDef->addMethodCall('addCustomStringFunction', [$name, $function]); } foreach ($entityManager['dql']['numeric_functions'] as $name => $function) { $ormConfigDef->addMethodCall('addCustomNumericFunction', [$name, $function]); } foreach ($entityManager['dql']['datetime_functions'] as $name => $function) { $ormConfigDef->addMethodCall('addCustomDatetimeFunction', [$name, $function]); } } $enabledFilters = []; $filtersParameters = []; foreach ($entityManager['filters'] as $name => $filter) { $ormConfigDef->addMethodCall('addFilter', [$name, $filter['class']]); if ($filter['enabled']) { $enabledFilters[] = $name; } if (! $filter['parameters']) { continue; } $filtersParameters[$name] = $filter['parameters']; } $managerConfiguratorName = sprintf('doctrine.orm.%s_manager_configurator', $entityManager['name']); $container ->setDefinition($managerConfiguratorName, new ChildDefinition('doctrine.orm.manager_configurator.abstract')) ->replaceArgument(0, $enabledFilters) ->replaceArgument(1, $filtersParameters); if (! isset($entityManager['connection'])) { $entityManager['connection'] = $this->defaultConnection; } $entityManagerId = sprintf('doctrine.orm.%s_entity_manager', $entityManager['name']); $container ->setDefinition($entityManagerId, new ChildDefinition('doctrine.orm.entity_manager.abstract')) ->setPublic(true) ->setArguments([ new Reference(sprintf('doctrine.dbal.%s_connection', $entityManager['connection'])), new Reference(sprintf('doctrine.orm.%s_configuration', $entityManager['name'])), new Reference(sprintf('doctrine.dbal.%s_connection.event_manager', $entityManager['connection'])), ]) ->setConfigurator([new Reference($managerConfiguratorName), 'configure']); $container ->registerAliasForArgument($entityManagerId, EntityManagerInterface::class, sprintf('%s.entity_manager', $entityManager['name'])) ->setPublic(false); $container->setAlias( sprintf('doctrine.orm.%s_entity_manager.event_manager', $entityManager['name']), new Alias(sprintf('doctrine.dbal.%s_connection.event_manager', $entityManager['connection']), false), ); if (! isset($entityManager['entity_listeners'])) { return; } $entities = $entityManager['entity_listeners']['entities']; foreach ($entities as $entityListenerClass => $entity) { foreach ($entity['listeners'] as $listenerClass => $listener) { foreach ($listener['events'] as $listenerEvent) { $listenerEventName = $listenerEvent['type']; $listenerMethod = $listenerEvent['method']; $listenerDef->addMethodCall('addEntityListener', [ $entityListenerClass, $listenerClass, $listenerEventName, $listenerMethod, ]); } } } } /** * Loads an ORM entity managers bundle mapping information. * * There are two distinct configuration possibilities for mapping information: * * 1. Specify a bundle and optionally details where the entity and mapping information reside. * 2. Specify an arbitrary mapping location. * * @param array $entityManager A configured ORM entity manager * @param Definition $ormConfigDef A Definition instance * @param ContainerBuilder $container A ContainerBuilder instance * * @example * * doctrine.orm: * mappings: * MyBundle1: ~ * MyBundle2: yml * MyBundle3: { type: annotation, dir: Entities/ } * MyBundle4: { type: xml, dir: Resources/config/doctrine/mapping } * MyBundle5: { type: attribute, dir: Entities/ } * MyBundle6: * type: yml * dir: bundle-mappings/ * alias: BundleAlias * arbitrary_key: * type: xml * dir: %kernel.project_dir%/src/vendor/DoctrineExtensions/lib/DoctrineExtensions/Entities * prefix: DoctrineExtensions\Entities\ * alias: DExt * * In the case of bundles everything is really optional (which leads to autodetection for this bundle) but * in the mappings key everything except alias is a required argument. */ protected function loadOrmEntityManagerMappingInformation(array $entityManager, Definition $ormConfigDef, ContainerBuilder $container) { // reset state of drivers and alias map. They are only used by this methods and children. $this->drivers = []; $this->aliasMap = []; $this->loadMappingInformation($entityManager, $container); $this->registerMappingDrivers($entityManager, $container); $container->getDefinition($this->getObjectManagerElementName($entityManager['name'] . '_metadata_driver')); /** @psalm-suppress NoValue $this->drivers is set by $this->loadMappingInformation() call */ foreach (array_keys($this->drivers) as $driverType) { $mappingService = $this->getObjectManagerElementName($entityManager['name'] . '_' . $driverType . '_metadata_driver'); $mappingDriverDef = $container->getDefinition($mappingService); $args = $mappingDriverDef->getArguments(); if ($driverType === 'annotation') { $args[2] = $entityManager['report_fields_where_declared']; } elseif ($driverType === 'attribute') { $args[1] = $entityManager['report_fields_where_declared']; } elseif ($driverType === 'xml') { $args[1] ??= SimplifiedXmlDriver::DEFAULT_FILE_EXTENSION; $args[2] = $entityManager['validate_xml_mapping']; } else { continue; } $mappingDriverDef->setArguments($args); } $ormConfigDef->addMethodCall('setEntityNamespaces', [$this->aliasMap]); } /** * Loads an ORM second level cache bundle mapping information. * * @param array $entityManager A configured ORM entity manager * @param Definition $ormConfigDef A Definition instance * @param ContainerBuilder $container A ContainerBuilder instance * * @example * entity_managers: * default: * second_level_cache: * region_lifetime: 3600 * region_lock_lifetime: 60 * region_cache_driver: apc * log_enabled: true * regions: * my_service_region: * type: service * service : "my_service_region" * * my_query_region: * lifetime: 300 * cache_driver: array * type: filelock * * my_entity_region: * lifetime: 600 * cache_driver: * type: apc */ protected function loadOrmSecondLevelCache(array $entityManager, Definition $ormConfigDef, ContainerBuilder $container) { $driverId = null; $enabled = $entityManager['second_level_cache']['enabled']; if (isset($entityManager['second_level_cache']['region_cache_driver'])) { $driverName = 'second_level_cache.region_cache_driver'; $driverMap = $entityManager['second_level_cache']['region_cache_driver']; $driverId = $this->loadCacheDriver($driverName, $entityManager['name'], $driverMap, $container); } $configId = sprintf('doctrine.orm.%s_second_level_cache.cache_configuration', $entityManager['name']); $regionsId = sprintf('doctrine.orm.%s_second_level_cache.regions_configuration', $entityManager['name']); $driverId = $driverId ?: sprintf('doctrine.orm.%s_second_level_cache.region_cache_driver', $entityManager['name']); $configDef = $container->setDefinition($configId, new Definition('%doctrine.orm.second_level_cache.cache_configuration.class%')); $regionsDef = $container ->setDefinition($regionsId, new Definition('%doctrine.orm.second_level_cache.regions_configuration.class%')) ->setArguments([$entityManager['second_level_cache']['region_lifetime'], $entityManager['second_level_cache']['region_lock_lifetime']]); $slcFactoryId = sprintf('doctrine.orm.%s_second_level_cache.default_cache_factory', $entityManager['name']); $factoryClass = $entityManager['second_level_cache']['factory'] ?? '%doctrine.orm.second_level_cache.default_cache_factory.class%'; $definition = new Definition($factoryClass, [new Reference($regionsId), new Reference($driverId)]); $slcFactoryDef = $container ->setDefinition($slcFactoryId, $definition); if (isset($entityManager['second_level_cache']['regions'])) { foreach ($entityManager['second_level_cache']['regions'] as $name => $region) { $regionRef = null; $regionType = $region['type']; if ($regionType === 'service') { $regionId = sprintf('doctrine.orm.%s_second_level_cache.region.%s', $entityManager['name'], $name); $regionRef = new Reference($region['service']); $container->setAlias($regionId, new Alias($region['service'], false)); } if ($regionType === 'default' || $regionType === 'filelock') { $regionId = sprintf('doctrine.orm.%s_second_level_cache.region.%s', $entityManager['name'], $name); $driverName = sprintf('second_level_cache.region.%s_driver', $name); $driverMap = $region['cache_driver']; $driverId = $this->loadCacheDriver($driverName, $entityManager['name'], $driverMap, $container); $regionRef = new Reference($regionId); $container ->setDefinition($regionId, new Definition('%doctrine.orm.second_level_cache.default_region.class%')) ->setArguments([$name, new Reference($driverId), $region['lifetime']]); } if ($regionType === 'filelock') { $regionId = sprintf('doctrine.orm.%s_second_level_cache.region.%s_filelock', $entityManager['name'], $name); $container ->setDefinition($regionId, new Definition('%doctrine.orm.second_level_cache.filelock_region.class%')) ->setArguments([$regionRef, $region['lock_path'], $region['lock_lifetime']]); $regionRef = new Reference($regionId); $regionsDef->addMethodCall('getLockLifetime', [$name, $region['lock_lifetime']]); } $regionsDef->addMethodCall('setLifetime', [$name, $region['lifetime']]); $slcFactoryDef->addMethodCall('setRegion', [$regionRef]); } } if ($entityManager['second_level_cache']['log_enabled']) { $loggerChainId = sprintf('doctrine.orm.%s_second_level_cache.logger_chain', $entityManager['name']); $loggerStatsId = sprintf('doctrine.orm.%s_second_level_cache.logger_statistics', $entityManager['name']); $loggerChaingDef = $container->setDefinition($loggerChainId, new Definition('%doctrine.orm.second_level_cache.logger_chain.class%')); $loggerStatsDef = $container->setDefinition($loggerStatsId, new Definition('%doctrine.orm.second_level_cache.logger_statistics.class%')); $loggerChaingDef->addMethodCall('setLogger', ['statistics', $loggerStatsDef]); $configDef->addMethodCall('setCacheLogger', [$loggerChaingDef]); foreach ($entityManager['second_level_cache']['loggers'] as $name => $logger) { $loggerId = sprintf('doctrine.orm.%s_second_level_cache.logger.%s', $entityManager['name'], $name); $loggerRef = new Reference($logger['service']); $container->setAlias($loggerId, new Alias($logger['service'], false)); $loggerChaingDef->addMethodCall('setLogger', [$name, $loggerRef]); } } $configDef->addMethodCall('setCacheFactory', [$slcFactoryDef]); $configDef->addMethodCall('setRegionsConfiguration', [$regionsDef]); $ormConfigDef->addMethodCall('setSecondLevelCacheEnabled', [$enabled]); $ormConfigDef->addMethodCall('setSecondLevelCacheConfiguration', [$configDef]); } /** * Prefixes the relative dependency injection container path with the object manager prefix. * * @param string $name * * @example $name is 'entity_manager' then the result would be 'doctrine.orm.entity_manager' */ protected function getObjectManagerElementName($name): string { return 'doctrine.orm.' . $name; } /** * Noun that describes the mapped objects such as Entity or Document. * * Will be used for autodetection of persistent objects directory. */ protected function getMappingObjectDefaultName(): string { return 'Entity'; } /** * Relative path from the bundle root to the directory where mapping files reside. */ protected function getMappingResourceConfigDirectory(string|null $bundleDir = null): string { if ($bundleDir !== null && is_dir($bundleDir . '/config/doctrine')) { return 'config/doctrine'; } return 'Resources/config/doctrine'; } /** * Extension used by the mapping files. */ protected function getMappingResourceExtension(): string { return 'orm'; } /** * Loads a cache driver. * * @param string $cacheName * @param string $objectManagerName * @param array $cacheDriver * * @throws InvalidArgumentException */ protected function loadCacheDriver( $cacheName, $objectManagerName, array $cacheDriver, ContainerBuilder $container, ): string { $aliasId = $this->getObjectManagerElementName(sprintf('%s_%s', $objectManagerName, $cacheName)); switch ($cacheDriver['type'] ?? 'pool') { case 'service': $serviceId = $cacheDriver['id']; break; case 'pool': $serviceId = $cacheDriver['pool'] ?? $this->createArrayAdapterCachePool($container, $objectManagerName, $cacheName); break; default: throw new InvalidArgumentException(sprintf( 'Unknown cache of type "%s" configured for cache "%s" in entity manager "%s".', $cacheDriver['type'], $cacheName, $objectManagerName, )); } $container->setAlias($aliasId, new Alias($serviceId, false)); return $aliasId; } /** * Loads a configured entity managers cache drivers. * * @param array $entityManager A configured ORM entity manager. */ protected function loadOrmCacheDrivers(array $entityManager, ContainerBuilder $container) { if (isset($entityManager['metadata_cache_driver'])) { $this->loadCacheDriver('metadata_cache', $entityManager['name'], $entityManager['metadata_cache_driver'], $container); } else { $this->createMetadataCache($entityManager['name'], $container); } $this->loadCacheDriver('result_cache', $entityManager['name'], $entityManager['result_cache_driver'], $container); $this->loadCacheDriver('query_cache', $entityManager['name'], $entityManager['query_cache_driver'], $container); } private function createMetadataCache(string $objectManagerName, ContainerBuilder $container): void { $aliasId = $this->getObjectManagerElementName(sprintf('%s_%s', $objectManagerName, 'metadata_cache')); $cacheId = sprintf('cache.doctrine.orm.%s.%s', $objectManagerName, 'metadata'); $cache = new Definition(ArrayAdapter::class); if (! $container->getParameter('kernel.debug')) { $phpArrayFile = '%kernel.build_dir%' . sprintf('/doctrine/orm/%s_metadata.php', $objectManagerName); $cacheWarmerServiceId = $this->getObjectManagerElementName(sprintf('%s_%s', $objectManagerName, 'metadata_cache_warmer')); $container->register($cacheWarmerServiceId, DoctrineMetadataCacheWarmer::class) ->setArguments([new Reference(sprintf('doctrine.orm.%s_entity_manager', $objectManagerName)), $phpArrayFile]) ->addTag('kernel.cache_warmer', ['priority' => 1000]); // priority should be higher than ProxyCacheWarmer $cache = new Definition(PhpArrayAdapter::class, [$phpArrayFile, $cache]); } $container->setDefinition($cacheId, $cache); $container->setAlias($aliasId, $cacheId); } /** * Loads a property info extractor for each defined entity manager. */ private function loadPropertyInfoExtractor(string $entityManagerName, ContainerBuilder $container): void { $propertyExtractorDefinition = $container->register(sprintf('doctrine.orm.%s_entity_manager.property_info_extractor', $entityManagerName), DoctrineExtractor::class); $argumentId = sprintf('doctrine.orm.%s_entity_manager', $entityManagerName); $propertyExtractorDefinition->addArgument(new Reference($argumentId)); $propertyExtractorDefinition->addTag('property_info.list_extractor', ['priority' => -1001]); $propertyExtractorDefinition->addTag('property_info.type_extractor', ['priority' => -999]); $propertyExtractorDefinition->addTag('property_info.access_extractor', ['priority' => -999]); } /** * Loads a validator loader for each defined entity manager. */ private function loadValidatorLoader(string $entityManagerName, ContainerBuilder $container): void { $validatorLoaderDefinition = $container->register(sprintf('doctrine.orm.%s_entity_manager.validator_loader', $entityManagerName), DoctrineLoader::class); $validatorLoaderDefinition->addArgument(new Reference(sprintf('doctrine.orm.%s_entity_manager', $entityManagerName))); $validatorLoaderDefinition->addTag('validator.auto_mapper', ['priority' => -100]); } public function getXsdValidationBasePath(): string { return __DIR__ . '/../../config/schema'; } public function getNamespace(): string { return 'http://symfony.com/schema/dic/doctrine'; } /** * {@inheritDoc} */ public function getConfiguration(array $config, ContainerBuilder $container): Configuration { return new Configuration((bool) $container->getParameter('kernel.debug')); } /** * The class name used by the various mapping drivers. */ protected function getMetadataDriverClass(string $driverType): string { switch ($driverType) { case 'driver_chain': return MappingDriverChain::class; case 'annotation': if (! class_exists(AnnotationDriver::class)) { throw new LogicException('The annotation driver is only available in doctrine/orm v2.'); } return AnnotationDriver::class; case 'xml': return SimplifiedXmlDriver::class; case 'yml': /* @phpstan-ignore class.notFound */ return SimplifiedYamlDriver::class; case 'php': /* @phpstan-ignore class.notFound */ return class_exists(PHPDriver::class) ? PHPDriver::class : LegacyPHPDriver::class; case 'staticphp': /* @phpstan-ignore class.notFound */ return class_exists(StaticPHPDriver::class) ? StaticPHPDriver::class : LegacyStaticPHPDriver::class; case 'attribute': return AttributeDriver::class; default: throw new LogicException(sprintf('Unknown "%s" metadata driver type.', $driverType)); } } private function loadMessengerServices(ContainerBuilder $container): void { // If the Messenger component is installed, wire it: if (! interface_exists(MessageBusInterface::class)) { return; } $loader = new PhpFileLoader($container, new FileLocator(__DIR__ . '/../../config')); $loader->load('messenger.php'); /** * The Doctrine transport component (symfony/doctrine-messenger) is optional. * Remove service definition, if it is not available */ if (class_exists(DoctrineTransportFactory::class)) { return; } $container->removeDefinition('messenger.transport.doctrine.factory'); $container->removeDefinition('doctrine.orm.messenger.doctrine_schema_listener'); } private function createArrayAdapterCachePool(ContainerBuilder $container, string $objectManagerName, string $cacheName): string { $id = sprintf('cache.doctrine.orm.%s.%s', $objectManagerName, str_replace('_cache', '', $cacheName)); $poolDefinition = $container->register($id, ArrayAdapter::class); $poolDefinition->addTag('cache.pool'); $container->setDefinition($id, $poolDefinition); return $id; } /** * @param string[] $connWithLogging * @param string[] $connWithProfiling * @param string[] $connWithBacktrace * @param string[] $connWithTtl */ private function registerDbalMiddlewares( ContainerBuilder $container, array $connWithLogging, array $connWithProfiling, array $connWithBacktrace, array $connWithTtl, ): void { $loader = new PhpFileLoader($container, new FileLocator(__DIR__ . '/../../config')); $loader->load('middlewares.php'); $loggingMiddlewareAbstractDef = $container->getDefinition('doctrine.dbal.logging_middleware'); foreach ($connWithLogging as $connName) { $loggingMiddlewareAbstractDef->addTag('doctrine.middleware', ['connection' => $connName, 'priority' => 10]); } $container->getDefinition('doctrine.debug_data_holder')->replaceArgument(0, $connWithBacktrace); $debugMiddlewareAbstractDef = $container->getDefinition('doctrine.dbal.debug_middleware'); foreach ($connWithProfiling as $connName) { $debugMiddlewareAbstractDef ->addTag('doctrine.middleware', ['connection' => $connName, 'priority' => 10]); } $idleConnectionMiddlewareAbstractDef = $container->getDefinition('doctrine.dbal.idle_connection_middleware'); foreach ($connWithTtl as $connName) { $idleConnectionMiddlewareAbstractDef ->addTag('doctrine.middleware', ['connection' => $connName, 'priority' => 10]); } } }