vendor/api-platform/core/src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php line 478

  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\Symfony\Bundle\DependencyInjection;
  16. use ApiPlatform\Api\FilterInterface;
  17. use ApiPlatform\Api\UrlGeneratorInterface;
  18. use ApiPlatform\Doctrine\Odm\Extension\AggregationCollectionExtensionInterface;
  19. use ApiPlatform\Doctrine\Odm\Extension\AggregationItemExtensionInterface;
  20. use ApiPlatform\Doctrine\Odm\Filter\AbstractFilter as DoctrineMongoDbOdmAbstractFilter;
  21. use ApiPlatform\Doctrine\Orm\Extension\EagerLoadingExtension;
  22. use ApiPlatform\Doctrine\Orm\Extension\FilterEagerLoadingExtension;
  23. use ApiPlatform\Doctrine\Orm\Extension\QueryCollectionExtensionInterface as DoctrineQueryCollectionExtensionInterface;
  24. use ApiPlatform\Doctrine\Orm\Extension\QueryItemExtensionInterface;
  25. use ApiPlatform\Doctrine\Orm\Filter\AbstractFilter as DoctrineOrmAbstractFilter;
  26. use ApiPlatform\Elasticsearch\Extension\RequestBodySearchCollectionExtensionInterface;
  27. use ApiPlatform\GraphQl\Error\ErrorHandlerInterface;
  28. use ApiPlatform\GraphQl\Resolver\MutationResolverInterface;
  29. use ApiPlatform\GraphQl\Resolver\QueryCollectionResolverInterface;
  30. use ApiPlatform\GraphQl\Resolver\QueryItemResolverInterface;
  31. use ApiPlatform\GraphQl\Type\Definition\TypeInterface as GraphQlTypeInterface;
  32. use ApiPlatform\Metadata\ApiResource;
  33. use ApiPlatform\State\ProcessorInterface;
  34. use ApiPlatform\State\ProviderInterface;
  35. use ApiPlatform\Symfony\GraphQl\Resolver\Factory\DataCollectorResolverFactory;
  36. use ApiPlatform\Symfony\Validator\Metadata\Property\Restriction\PropertySchemaRestrictionMetadataInterface;
  37. use ApiPlatform\Symfony\Validator\ValidationGroupsGeneratorInterface;
  38. use Doctrine\Persistence\ManagerRegistry;
  39. use phpDocumentor\Reflection\DocBlockFactoryInterface;
  40. use PHPStan\PhpDocParser\Parser\PhpDocParser;
  41. use Ramsey\Uuid\Uuid;
  42. use Symfony\Component\Config\FileLocator;
  43. use Symfony\Component\Config\Resource\DirectoryResource;
  44. use Symfony\Component\DependencyInjection\ContainerBuilder;
  45. use Symfony\Component\DependencyInjection\ContainerInterface;
  46. use Symfony\Component\DependencyInjection\Definition;
  47. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  48. use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
  49. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  50. use Symfony\Component\DependencyInjection\Reference;
  51. use Symfony\Component\Finder\Finder;
  52. use Symfony\Component\HttpClient\ScopingHttpClient;
  53. use Symfony\Component\HttpKernel\DependencyInjection\Extension;
  54. use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
  55. use Symfony\Component\Uid\AbstractUid;
  56. use Symfony\Component\Validator\Validator\ValidatorInterface;
  57. use Symfony\Component\Yaml\Yaml;
  58. use Twig\Environment;
  60. /**
  61.  * The extension of this bundle.
  62.  *
  63.  * @author Kévin Dunglas <dunglas@gmail.com>
  64.  */
  65. final class ApiPlatformExtension extends Extension implements PrependExtensionInterface
  66. {
  67.     /**
  68.      * {@inheritdoc}
  69.      */
  70.     public function prepend(ContainerBuilder $container): void
  71.     {
  72.         if (isset($container->getExtensions()['framework'])) {
  73.             $container->prependExtensionConfig('framework', [
  74.                 'serializer' => [
  75.                     'enabled' => true,
  76.                 ],
  77.             ]);
  78.             $container->prependExtensionConfig('framework', [
  79.                 'property_info' => [
  80.                     'enabled' => true,
  81.                 ],
  82.             ]);
  83.         }
  84.     }
  86.     /**
  87.      * {@inheritdoc}
  88.      */
  89.     public function load(array $configs, ContainerBuilder $container): void
  90.     {
  91.         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
  93.         $configuration = new Configuration();
  94.         $config = $this->processConfiguration($configuration, $configs);
  96.         $formats = $this->getFormats($config['formats']);
  97.         $patchFormats = $this->getFormats($config['patch_formats']);
  98.         $errorFormats = $this->getFormats($config['error_formats']);
  100.         // Backward Compatibility layer
  101.         if (isset($formats['jsonapi']) && !isset($patchFormats['jsonapi'])) {
  102.             $patchFormats['jsonapi'] = ['application/vnd.api+json'];
  103.         }
  105.         $this->registerCommonConfiguration($container, $config, $loader, $formats, $patchFormats, $errorFormats);
  106.         $this->registerMetadataConfiguration($container, $config, $loader);
  107.         $this->registerOAuthConfiguration($container, $config);
  108.         $this->registerOpenApiConfiguration($container, $config, $loader);
  109.         $this->registerSwaggerConfiguration($container, $config, $loader);
  110.         $this->registerJsonApiConfiguration($formats, $loader);
  111.         $this->registerJsonLdHydraConfiguration($container, $formats, $loader, $config);
  112.         $this->registerJsonHalConfiguration($formats, $loader);
  113.         $this->registerJsonProblemConfiguration($errorFormats, $loader);
  114.         $this->registerGraphQlConfiguration($container, $config, $loader);
  115.         $this->registerCacheConfiguration($container);
  116.         $this->registerDoctrineOrmConfiguration($container, $config, $loader);
  117.         $this->registerDoctrineMongoDbOdmConfiguration($container, $config, $loader);
  118.         $this->registerHttpCacheConfiguration($container, $config, $loader);
  119.         $this->registerValidatorConfiguration($container, $config, $loader);
  120.         $this->registerDataCollectorConfiguration($container, $config, $loader);
  121.         $this->registerMercureConfiguration($container, $config, $loader);
  122.         $this->registerMessengerConfiguration($container, $config, $loader);
  123.         $this->registerElasticsearchConfiguration($container, $config, $loader);
  124.         $this->registerSecurityConfiguration($container, $loader);
  125.         $this->registerMakerConfiguration($container, $config, $loader);
  126.         $this->registerArgumentResolverConfiguration($loader);
  128.         $container->registerForAutoconfiguration(FilterInterface::class)
  129.             ->addTag('api_platform.filter');
  130.         $container->registerForAutoconfiguration(ProviderInterface::class)
  131.             ->addTag('api_platform.state_provider');
  132.         $container->registerForAutoconfiguration(ProcessorInterface::class)
  133.             ->addTag('api_platform.state_processor');
  135.         if (!$container->has('api_platform.state.item_provider')) {
  136.             $container->setAlias('api_platform.state.item_provider', 'api_platform.state_provider.object');
  137.         }
  138.     }
  140.     private function registerCommonConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader, array $formats, array $patchFormats, array $errorFormats): void
  141.     {
  142.         $loader->load('symfony/events.xml');
  143.         $loader->load('api.xml');
  144.         $loader->load('state.xml');
  145.         $loader->load('filter.xml');
  147.         if (class_exists(Uuid::class)) {
  148.             $loader->load('ramsey_uuid.xml');
  149.         }
  151.         if (class_exists(AbstractUid::class)) {
  152.             $loader->load('symfony/uid.xml');
  153.         }
  155.         $container->setParameter('api_platform.enable_entrypoint', $config['enable_entrypoint']);
  156.         $container->setParameter('api_platform.enable_docs', $config['enable_docs']);
  157.         $container->setParameter('api_platform.title', $config['title']);
  158.         $container->setParameter('api_platform.description', $config['description']);
  159.         $container->setParameter('api_platform.version', $config['version']);
  160.         $container->setParameter('api_platform.show_webby', $config['show_webby']);
  161.         $container->setParameter('api_platform.url_generation_strategy', $config['defaults']['url_generation_strategy'] ?? UrlGeneratorInterface::ABS_PATH);
  162.         $container->setParameter('api_platform.exception_to_status', $config['exception_to_status']);
  163.         $container->setParameter('api_platform.formats', $formats);
  164.         $container->setParameter('api_platform.patch_formats', $patchFormats);
  165.         $container->setParameter('api_platform.error_formats', $errorFormats);
  166.         $container->setParameter('api_platform.eager_loading.enabled', $this->isConfigEnabled($container, $config['eager_loading']));
  167.         $container->setParameter('api_platform.eager_loading.max_joins', $config['eager_loading']['max_joins']);
  168.         $container->setParameter('api_platform.eager_loading.fetch_partial', $config['eager_loading']['fetch_partial']);
  169.         $container->setParameter('api_platform.eager_loading.force_eager', $config['eager_loading']['force_eager']);
  170.         $container->setParameter('api_platform.collection.exists_parameter_name', $config['collection']['exists_parameter_name']);
  171.         $container->setParameter('api_platform.collection.order', $config['collection']['order']);
  172.         $container->setParameter('api_platform.collection.order_parameter_name', $config['collection']['order_parameter_name']);
  173.         $container->setParameter('api_platform.collection.order_nulls_comparison', $config['collection']['order_nulls_comparison']);
  174.         $container->setParameter('api_platform.collection.pagination.enabled', $config['defaults']['pagination_enabled'] ?? true);
  175.         $container->setParameter('api_platform.collection.pagination.partial', $config['defaults']['pagination_partial'] ?? false);
  176.         $container->setParameter('api_platform.collection.pagination.client_enabled', $config['defaults']['pagination_client_enabled'] ?? false);
  177.         $container->setParameter('api_platform.collection.pagination.client_items_per_page', $config['defaults']['pagination_client_items_per_page'] ?? false);
  178.         $container->setParameter('api_platform.collection.pagination.client_partial', $config['defaults']['pagination_client_partial'] ?? false);
  179.         $container->setParameter('api_platform.collection.pagination.items_per_page', $config['defaults']['pagination_items_per_page'] ?? 30);
  180.         $container->setParameter('api_platform.collection.pagination.maximum_items_per_page', $config['defaults']['pagination_maximum_items_per_page'] ?? null);
  181.         $container->setParameter('api_platform.collection.pagination.page_parameter_name', $config['defaults']['pagination_page_parameter_name'] ?? $config['collection']['pagination']['page_parameter_name']);
  182.         $container->setParameter('api_platform.collection.pagination.enabled_parameter_name', $config['defaults']['pagination_enabled_parameter_name'] ?? $config['collection']['pagination']['enabled_parameter_name']);
  183.         $container->setParameter('api_platform.collection.pagination.items_per_page_parameter_name', $config['defaults']['pagination_items_per_page_parameter_name'] ?? $config['collection']['pagination']['items_per_page_parameter_name']);
  184.         $container->setParameter('api_platform.collection.pagination.partial_parameter_name', $config['defaults']['pagination_partial_parameter_name'] ?? $config['collection']['pagination']['partial_parameter_name']);
  185.         $container->setParameter('api_platform.collection.pagination', $this->getPaginationDefaults($config['defaults'] ?? [], $config['collection']['pagination']));
  186.         $container->setParameter('api_platform.http_cache.etag', $config['defaults']['cache_headers']['etag'] ?? true);
  187.         $container->setParameter('api_platform.http_cache.max_age', $config['defaults']['cache_headers']['max_age'] ?? null);
  188.         $container->setParameter('api_platform.http_cache.shared_max_age', $config['defaults']['cache_headers']['shared_max_age'] ?? null);
  189.         $container->setParameter('api_platform.http_cache.vary', $config['defaults']['cache_headers']['vary'] ?? ['Accept']);
  190.         $container->setParameter('api_platform.http_cache.public', $config['defaults']['cache_headers']['public'] ?? $config['http_cache']['public']);
  191.         $container->setParameter('api_platform.http_cache.invalidation.max_header_length', $config['defaults']['cache_headers']['invalidation']['max_header_length'] ?? $config['http_cache']['invalidation']['max_header_length']);
  192.         $container->setParameter('api_platform.http_cache.invalidation.xkey.glue', $config['defaults']['cache_headers']['invalidation']['xkey']['glue'] ?? $config['http_cache']['invalidation']['xkey']['glue']);
  194.         $container->setAlias('api_platform.path_segment_name_generator', $config['path_segment_name_generator']);
  196.         if ($config['name_converter']) {
  197.             $container->setAlias('api_platform.name_converter', $config['name_converter']);
  198.         }
  199.         $container->setParameter('api_platform.asset_package', $config['asset_package']);
  200.         $container->setParameter('api_platform.defaults', $this->normalizeDefaults($config['defaults'] ?? []));
  201.     }
  203.     /**
  204.      * This method will be removed in 3.0 when "defaults" will be the regular configuration path for the pagination.
  205.      */
  206.     private function getPaginationDefaults(array $defaults, array $collectionPaginationConfiguration): array
  207.     {
  208.         $paginationOptions = [];
  210.         foreach ($defaults as $key => $value) {
  211.             if (!str_starts_with($key, 'pagination_')) {
  212.                 continue;
  213.             }
  215.             $paginationOptions[str_replace('pagination_', '', $key)] = $value;
  216.         }
  218.         return array_merge($collectionPaginationConfiguration, $paginationOptions);
  219.     }
  221.     private function normalizeDefaults(array $defaults): array
  222.     {
  223.         $normalizedDefaults = ['extra_properties' => $defaults['extra_properties'] ?? []];
  224.         unset($defaults['extra_properties']);
  226.         $rc = new \ReflectionClass(ApiResource::class);
  227.         $publicProperties = [];
  228.         foreach ($rc->getConstructor()->getParameters() as $param) {
  229.             $publicProperties[$param->getName()] = true;
  230.         }
  232.         $nameConverter = new CamelCaseToSnakeCaseNameConverter();
  233.         foreach ($defaults as $option => $value) {
  234.             if (isset($publicProperties[$nameConverter->denormalize($option)])) {
  235.                 $normalizedDefaults[$option] = $value;
  237.                 continue;
  238.             }
  240.             $normalizedDefaults['extra_properties'][$option] = $value;
  241.         }
  243.         return $normalizedDefaults;
  244.     }
  246.     private function registerMetadataConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  247.     {
  248.         [$xmlResources, $yamlResources] = $this->getResourcesToWatch($container, $config);
  250.         $loader->load('metadata/resource_name.xml');
  251.         $loader->load('metadata/property_name.xml');
  253.         if (!empty($config['resource_class_directories'])) {
  254.             $container->setParameter('api_platform.resource_class_directories', array_merge(
  255.                 $config['resource_class_directories'], $container->getParameter('api_platform.resource_class_directories')
  256.             ));
  257.         }
  259.         // V3 metadata
  260.         $loader->load('metadata/xml.xml');
  261.         $loader->load('metadata/links.xml');
  262.         $loader->load('metadata/property.xml');
  263.         $loader->load('metadata/resource.xml');
  264.         $loader->load('metadata/operation.xml');
  266.         $container->getDefinition('api_platform.metadata.resource_extractor.xml')->replaceArgument(0, $xmlResources);
  267.         $container->getDefinition('api_platform.metadata.property_extractor.xml')->replaceArgument(0, $xmlResources);
  269.         if (class_exists(PhpDocParser::class) || interface_exists(DocBlockFactoryInterface::class)) {
  270.             $loader->load('metadata/php_doc.xml');
  271.         }
  273.         if (class_exists(Yaml::class)) {
  274.             $loader->load('metadata/yaml.xml');
  275.             $container->getDefinition('api_platform.metadata.resource_extractor.yaml')->replaceArgument(0, $yamlResources);
  276.             $container->getDefinition('api_platform.metadata.property_extractor.yaml')->replaceArgument(0, $yamlResources);
  277.         }
  278.     }
  280.     private function getBundlesResourcesPaths(ContainerBuilder $container, array $config): array
  281.     {
  282.         $bundlesResourcesPaths = [];
  284.         foreach ($container->getParameter('kernel.bundles_metadata') as $bundle) {
  285.             $dirname = $bundle['path'];
  286.             $paths = [
  287.                 "$dirname/ApiResource",
  288.                 "$dirname/src/ApiResource",
  289.             ];
  290.             foreach (['.yaml', '.yml', '.xml', ''] as $extension) {
  291.                 $paths[] = "$dirname/Resources/config/api_resources$extension";
  292.                 $paths[] = "$dirname/config/api_resources$extension";
  293.             }
  294.             if ($this->isConfigEnabled($container, $config['doctrine'])) {
  295.                 $paths[] = "$dirname/Entity";
  296.                 $paths[] = "$dirname/src/Entity";
  297.             }
  298.             if ($this->isConfigEnabled($container, $config['doctrine_mongodb_odm'])) {
  299.                 $paths[] = "$dirname/Document";
  300.                 $paths[] = "$dirname/src/Document";
  301.             }
  303.             foreach ($paths as $path) {
  304.                 if ($container->fileExists($path, false)) {
  305.                     $bundlesResourcesPaths[] = $path;
  306.                 }
  307.             }
  308.         }
  310.         return $bundlesResourcesPaths;
  311.     }
  313.     private function getResourcesToWatch(ContainerBuilder $container, array $config): array
  314.     {
  315.         $paths = array_unique(array_merge($this->getBundlesResourcesPaths($container, $config), $config['mapping']['paths']));
  317.         if (!$config['mapping']['paths']) {
  318.             $projectDir = $container->getParameter('kernel.project_dir');
  319.             foreach (["$projectDir/config/api_platform", "$projectDir/src/ApiResource"] as $dir) {
  320.                 if (is_dir($dir)) {
  321.                     $paths[] = $dir;
  322.                 }
  323.             }
  325.             if ($this->isConfigEnabled($container, $config['doctrine']) && is_dir($doctrinePath = "$projectDir/src/Entity")) {
  326.                 $paths[] = $doctrinePath;
  327.             }
  329.             if ($this->isConfigEnabled($container, $config['doctrine_mongodb_odm']) && is_dir($documentPath = "$projectDir/src/Document")) {
  330.                 $paths[] = $documentPath;
  331.             }
  332.         }
  334.         $resources = ['yml' => [], 'xml' => [], 'dir' => []];
  336.         foreach ($paths as $path) {
  337.             if (is_dir($path)) {
  338.                 foreach (Finder::create()->followLinks()->files()->in($path)->name('/\.(xml|ya?ml)$/')->sortByName() as $file) {
  339.                     $resources['yaml' === ($extension = $file->getExtension()) ? 'yml' : $extension][] = $file->getRealPath();
  340.                 }
  342.                 $resources['dir'][] = $path;
  343.                 $container->addResource(new DirectoryResource($path, '/\.(xml|ya?ml|php)$/'));
  345.                 continue;
  346.             }
  348.             if ($container->fileExists($path, false)) {
  349.                 if (!preg_match('/\.(xml|ya?ml)$/', (string) $path, $matches)) {
  350.                     throw new RuntimeException(sprintf('Unsupported mapping type in "%s", supported types are XML & YAML.', $path));
  351.                 }
  353.                 $resources['yaml' === $matches[1] ? 'yml' : $matches[1]][] = $path;
  355.                 continue;
  356.             }
  358.             throw new RuntimeException(sprintf('Could not open file or directory "%s".', $path));
  359.         }
  361.         $container->setParameter('api_platform.resource_class_directories', $resources['dir']);
  363.         return [$resources['xml'], $resources['yml']];
  364.     }
  366.     private function registerOAuthConfiguration(ContainerBuilder $container, array $config): void
  367.     {
  368.         if (!$config['oauth']) {
  369.             return;
  370.         }
  372.         $container->setParameter('api_platform.oauth.enabled', $this->isConfigEnabled($container, $config['oauth']));
  373.         $container->setParameter('api_platform.oauth.clientId', $config['oauth']['clientId']);
  374.         $container->setParameter('api_platform.oauth.clientSecret', $config['oauth']['clientSecret']);
  375.         $container->setParameter('api_platform.oauth.type', $config['oauth']['type']);
  376.         $container->setParameter('api_platform.oauth.flow', $config['oauth']['flow']);
  377.         $container->setParameter('api_platform.oauth.tokenUrl', $config['oauth']['tokenUrl']);
  378.         $container->setParameter('api_platform.oauth.authorizationUrl', $config['oauth']['authorizationUrl']);
  379.         $container->setParameter('api_platform.oauth.refreshUrl', $config['oauth']['refreshUrl']);
  380.         $container->setParameter('api_platform.oauth.scopes', $config['oauth']['scopes']);
  381.         $container->setParameter('api_platform.oauth.pkce', $config['oauth']['pkce']);
  383.         if ($container->hasDefinition('api_platform.swagger_ui.action')) {
  384.             $container->getDefinition('api_platform.swagger_ui.action')->setArgument(10, $config['oauth']['pkce']);
  385.         }
  386.     }
  388.     /**
  389.      * Registers the Swagger, ReDoc and Swagger UI configuration.
  390.      */
  391.     private function registerSwaggerConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  392.     {
  393.         foreach (array_keys($config['swagger']['api_keys']) as $keyName) {
  394.             if (!preg_match('/^[a-zA-Z0-9._-]+$/', $keyName)) {
  395.                 trigger_deprecation('api-platform/core', '3.1', sprintf('The swagger api_keys key "%s" is not valid with OpenAPI 3.1 it should match "^[a-zA-Z0-9._-]+$"', $keyName));
  396.             }
  397.         }
  399.         $container->setParameter('api_platform.swagger.versions', $config['swagger']['versions']);
  401.         if (!$config['enable_swagger'] && $config['enable_swagger_ui']) {
  402.             throw new RuntimeException('You can not enable the Swagger UI without enabling Swagger, fix this by enabling swagger via the configuration "enable_swagger: true".');
  403.         }
  405.         if (!$config['enable_swagger']) {
  406.             return;
  407.         }
  409.         $loader->load('openapi.xml');
  410.         $loader->load('swagger_ui.xml');
  412.         if (!$config['enable_swagger_ui'] && !$config['enable_re_doc']) {
  413.             // Remove the listener but keep the controller to allow customizing the path of the UI
  414.             $container->removeDefinition('api_platform.swagger.listener.ui');
  415.         }
  417.         $container->setParameter('api_platform.enable_swagger_ui', $config['enable_swagger_ui']);
  418.         $container->setParameter('api_platform.enable_re_doc', $config['enable_re_doc']);
  419.         $container->setParameter('api_platform.swagger.api_keys', $config['swagger']['api_keys']);
  420.         if ($config['openapi']['swagger_ui_extra_configuration'] && $config['swagger']['swagger_ui_extra_configuration']) {
  421.             throw new RuntimeException('You can not set "swagger_ui_extra_configuration" twice - in "openapi" and "swagger" section.');
  422.         }
  423.         $container->setParameter('api_platform.swagger_ui.extra_configuration', $config['openapi']['swagger_ui_extra_configuration'] ?: $config['swagger']['swagger_ui_extra_configuration']);
  424.     }
  426.     private function registerJsonApiConfiguration(array $formats, XmlFileLoader $loader): void
  427.     {
  428.         if (!isset($formats['jsonapi'])) {
  429.             return;
  430.         }
  432.         $loader->load('jsonapi.xml');
  433.     }
  435.     private function registerJsonLdHydraConfiguration(ContainerBuilder $container, array $formats, XmlFileLoader $loader, array $config): void
  436.     {
  437.         if (!isset($formats['jsonld'])) {
  438.             return;
  439.         }
  441.         $loader->load('jsonld.xml');
  442.         $loader->load('hydra.xml');
  444.         if (!$container->has('api_platform.json_schema.schema_factory')) {
  445.             $container->removeDefinition('api_platform.hydra.json_schema.schema_factory');
  446.         }
  448.         if (!$config['enable_docs']) {
  449.             $container->removeDefinition('api_platform.hydra.listener.response.add_link_header');
  450.         }
  451.     }
  453.     private function registerJsonHalConfiguration(array $formats, XmlFileLoader $loader): void
  454.     {
  455.         if (!isset($formats['jsonhal'])) {
  456.             return;
  457.         }
  459.         $loader->load('hal.xml');
  460.     }
  462.     private function registerJsonProblemConfiguration(array $errorFormats, XmlFileLoader $loader): void
  463.     {
  464.         if (!isset($errorFormats['jsonproblem'])) {
  465.             return;
  466.         }
  468.         $loader->load('problem.xml');
  469.     }
  471.     private function registerGraphQlConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  472.     {
  473.         $enabled = $this->isConfigEnabled($container, $config['graphql']);
  475.         $graphiqlEnabled = $enabled && $this->isConfigEnabled($container, $config['graphql']['graphiql']);
  476.         $graphqlPlayGroundEnabled = $enabled && $this->isConfigEnabled($container, $config['graphql']['graphql_playground']);
  477.         if ($graphqlPlayGroundEnabled) {
  478.             trigger_deprecation('api-platform/core', '3.1', 'GraphQL Playground is deprecated and will be removed in API Platform 4.0. Only GraphiQL will be available in the future. Set api_platform.graphql.graphql_playground to false in the configuration to remove this deprecation.');
  479.         }
  481.         $container->setParameter('api_platform.graphql.enabled', $enabled);
  482.         $container->setParameter('api_platform.graphql.graphiql.enabled', $graphiqlEnabled);
  483.         $container->setParameter('api_platform.graphql.graphql_playground.enabled', $graphqlPlayGroundEnabled);
  484.         $container->setParameter('api_platform.graphql.collection.pagination', $config['graphql']['collection']['pagination']);
  486.         if (!$enabled) {
  487.             return;
  488.         }
  490.         $container->setParameter('api_platform.graphql.default_ide', $config['graphql']['default_ide']);
  491.         $container->setParameter('api_platform.graphql.nesting_separator', $config['graphql']['nesting_separator']);
  493.         $loader->load('graphql.xml');
  495.         // @phpstan-ignore-next-line because PHPStan uses the container of the test env cache and in test the parameter kernel.bundles always contains the key TwigBundle
  496.         if (!class_exists(Environment::class) || !isset($container->getParameter('kernel.bundles')['TwigBundle'])) {
  497.             if ($graphiqlEnabled || $graphqlPlayGroundEnabled) {
  498.                 throw new RuntimeException(sprintf('GraphiQL and GraphQL Playground interfaces depend on Twig. Please activate TwigBundle for the %s environnement or disable GraphiQL and GraphQL Playground.', $container->getParameter('kernel.environment')));
  499.             }
  500.             $container->removeDefinition('api_platform.graphql.action.graphiql');
  501.             $container->removeDefinition('api_platform.graphql.action.graphql_playground');
  502.         }
  504.         $container->registerForAutoconfiguration(QueryItemResolverInterface::class)
  505.             ->addTag('api_platform.graphql.query_resolver');
  506.         $container->registerForAutoconfiguration(QueryCollectionResolverInterface::class)
  507.             ->addTag('api_platform.graphql.query_resolver');
  508.         $container->registerForAutoconfiguration(MutationResolverInterface::class)
  509.             ->addTag('api_platform.graphql.mutation_resolver');
  510.         $container->registerForAutoconfiguration(GraphQlTypeInterface::class)
  511.             ->addTag('api_platform.graphql.type');
  512.         $container->registerForAutoconfiguration(ErrorHandlerInterface::class)
  513.             ->addTag('api_platform.graphql.error_handler');
  515.         if (!$container->getParameter('kernel.debug')) {
  516.             return;
  517.         }
  519.         $requestStack = new Reference('request_stack', ContainerInterface::NULL_ON_INVALID_REFERENCE);
  520.         $collectionDataCollectorResolverFactory = (new Definition(DataCollectorResolverFactory::class))
  521.             ->setDecoratedService('api_platform.graphql.resolver.factory.collection')
  522.             ->setArguments([new Reference('api_platform.graphql.data_collector.resolver.factory.collection.inner'), $requestStack]);
  524.         $itemDataCollectorResolverFactory = (new Definition(DataCollectorResolverFactory::class))
  525.             ->setDecoratedService('api_platform.graphql.resolver.factory.item')
  526.             ->setArguments([new Reference('api_platform.graphql.data_collector.resolver.factory.item.inner'), $requestStack]);
  528.         $itemMutationDataCollectorResolverFactory = (new Definition(DataCollectorResolverFactory::class))
  529.             ->setDecoratedService('api_platform.graphql.resolver.factory.item_mutation')
  530.             ->setArguments([new Reference('api_platform.graphql.data_collector.resolver.factory.item_mutation.inner'), $requestStack]);
  532.         $itemSubscriptionDataCollectorResolverFactory = (new Definition(DataCollectorResolverFactory::class))
  533.             ->setDecoratedService('api_platform.graphql.resolver.factory.item_subscription')
  534.             ->setArguments([new Reference('api_platform.graphql.data_collector.resolver.factory.item_subscription.inner'), $requestStack]);
  536.         $container->addDefinitions([
  537.             'api_platform.graphql.data_collector.resolver.factory.collection' => $collectionDataCollectorResolverFactory,
  538.             'api_platform.graphql.data_collector.resolver.factory.item' => $itemDataCollectorResolverFactory,
  539.             'api_platform.graphql.data_collector.resolver.factory.item_mutation' => $itemMutationDataCollectorResolverFactory,
  540.             'api_platform.graphql.data_collector.resolver.factory.item_subscription' => $itemSubscriptionDataCollectorResolverFactory,
  541.         ]);
  542.     }
  544.     private function registerCacheConfiguration(ContainerBuilder $container): void
  545.     {
  546.         if (!$container->hasParameter('kernel.debug') || !$container->getParameter('kernel.debug')) {
  547.             $container->removeDefinition('api_platform.cache_warmer.cache_pool_clearer');
  548.         }
  549.     }
  551.     private function registerDoctrineOrmConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  552.     {
  553.         if (!$this->isConfigEnabled($container, $config['doctrine'])) {
  554.             return;
  555.         }
  557.         // For older versions of doctrine bridge this allows autoconfiguration for filters
  558.         if (!$container->has(ManagerRegistry::class)) {
  559.             $container->setAlias(ManagerRegistry::class, 'doctrine');
  560.         }
  562.         $container->registerForAutoconfiguration(QueryItemExtensionInterface::class)
  563.             ->addTag('api_platform.doctrine.orm.query_extension.item');
  564.         $container->registerForAutoconfiguration(DoctrineQueryCollectionExtensionInterface::class)
  565.             ->addTag('api_platform.doctrine.orm.query_extension.collection');
  566.         $container->registerForAutoconfiguration(DoctrineOrmAbstractFilter::class);
  568.         $loader->load('doctrine_orm.xml');
  570.         if ($this->isConfigEnabled($container, $config['eager_loading'])) {
  571.             return;
  572.         }
  574.         $container->removeAlias(EagerLoadingExtension::class);
  575.         $container->removeDefinition('api_platform.doctrine.orm.query_extension.eager_loading');
  576.         $container->removeAlias(FilterEagerLoadingExtension::class);
  577.         $container->removeDefinition('api_platform.doctrine.orm.query_extension.filter_eager_loading');
  578.     }
  580.     private function registerDoctrineMongoDbOdmConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  581.     {
  582.         if (!$this->isConfigEnabled($container, $config['doctrine_mongodb_odm'])) {
  583.             return;
  584.         }
  586.         $container->registerForAutoconfiguration(AggregationItemExtensionInterface::class)
  587.             ->addTag('api_platform.doctrine_mongodb.odm.aggregation_extension.item');
  588.         $container->registerForAutoconfiguration(AggregationCollectionExtensionInterface::class)
  589.             ->addTag('api_platform.doctrine_mongodb.odm.aggregation_extension.collection');
  590.         $container->registerForAutoconfiguration(DoctrineMongoDbOdmAbstractFilter::class)
  591.             ->setBindings(['$managerRegistry' => new Reference('doctrine_mongodb')]);
  593.         $loader->load('doctrine_mongodb_odm.xml');
  594.     }
  596.     private function registerHttpCacheConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  597.     {
  598.         $loader->load('http_cache.xml');
  600.         if (!$this->isConfigEnabled($container, $config['http_cache']['invalidation'])) {
  601.             return;
  602.         }
  604.         if ($this->isConfigEnabled($container, $config['doctrine'])) {
  605.             $loader->load('doctrine_orm_http_cache_purger.xml');
  606.         }
  608.         $loader->load('http_cache_purger.xml');
  610.         foreach ($config['http_cache']['invalidation']['scoped_clients'] as $client) {
  611.             $definition = $container->getDefinition($client);
  612.             $definition->addTag('api_platform.http_cache.http_client');
  613.         }
  615.         if (!($urls = $config['http_cache']['invalidation']['urls'])) {
  616.             $urls = $config['http_cache']['invalidation']['varnish_urls'];
  617.         }
  619.         foreach ($urls as $key => $url) {
  620.             $definition = new Definition(ScopingHttpClient::class, [new Reference('http_client'), $url, ['base_uri' => $url] + $config['http_cache']['invalidation']['request_options']]);
  621.             $definition->setFactory([ScopingHttpClient::class, 'forBaseUri']);
  622.             $definition->addTag('api_platform.http_cache.http_client');
  623.             $container->setDefinition('api_platform.invalidation_http_client.'.$key, $definition);
  624.         }
  626.         $serviceName = $config['http_cache']['invalidation']['purger'];
  628.         if (!$container->hasDefinition('api_platform.http_cache.purger')) {
  629.             $container->setAlias('api_platform.http_cache.purger', $serviceName);
  630.         }
  631.     }
  633.     /**
  634.      * Normalizes the format from config to the one accepted by Symfony HttpFoundation.
  635.      */
  636.     private function getFormats(array $configFormats): array
  637.     {
  638.         $formats = [];
  639.         foreach ($configFormats as $format => $value) {
  640.             foreach ($value['mime_types'] as $mimeType) {
  641.                 $formats[$format][] = $mimeType;
  642.             }
  643.         }
  645.         return $formats;
  646.     }
  648.     private function registerValidatorConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  649.     {
  650.         if (interface_exists(ValidatorInterface::class)) {
  651.             $loader->load('metadata/validator.xml');
  652.             $loader->load('symfony/validator.xml');
  654.             $container->registerForAutoconfiguration(ValidationGroupsGeneratorInterface::class)
  655.                 ->addTag('api_platform.validation_groups_generator');
  656.             $container->registerForAutoconfiguration(PropertySchemaRestrictionMetadataInterface::class)
  657.                 ->addTag('api_platform.metadata.property_schema_restriction');
  658.         }
  660.         if (!$config['validator']) {
  661.             return;
  662.         }
  664.         $container->setParameter('api_platform.validator.serialize_payload_fields', $config['validator']['serialize_payload_fields']);
  665.         $container->setParameter('api_platform.validator.query_parameter_validation', $config['validator']['query_parameter_validation']);
  667.         if (!$config['validator']['query_parameter_validation']) {
  668.             $container->removeDefinition('api_platform.listener.view.validate_query_parameters');
  669.             $container->removeDefinition('api_platform.validator.query_parameter_validator');
  670.         }
  671.     }
  673.     private function registerDataCollectorConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  674.     {
  675.         if (!$config['enable_profiler']) {
  676.             return;
  677.         }
  679.         $loader->load('data_collector.xml');
  681.         if ($container->hasParameter('kernel.debug') && $container->getParameter('kernel.debug')) {
  682.             $loader->load('debug.xml');
  683.         }
  684.     }
  686.     private function registerMercureConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  687.     {
  688.         if (!$this->isConfigEnabled($container, $config['mercure'])) {
  689.             return;
  690.         }
  692.         $container->setParameter('api_platform.mercure.include_type', $config['mercure']['include_type']);
  694.         $loader->load('mercure.xml');
  696.         if ($this->isConfigEnabled($container, $config['doctrine'])) {
  697.             $loader->load('doctrine_orm_mercure_publisher.xml');
  698.         }
  699.         if ($this->isConfigEnabled($container, $config['doctrine_mongodb_odm'])) {
  700.             $loader->load('doctrine_odm_mercure_publisher.xml');
  701.         }
  703.         if ($this->isConfigEnabled($container, $config['graphql'])) {
  704.             $loader->load('graphql_mercure.xml');
  705.         }
  706.     }
  708.     private function registerMessengerConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  709.     {
  710.         if (!$this->isConfigEnabled($container, $config['messenger'])) {
  711.             return;
  712.         }
  714.         $loader->load('messenger.xml');
  715.     }
  717.     private function registerElasticsearchConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  718.     {
  719.         $enabled = $this->isConfigEnabled($container, $config['elasticsearch']);
  721.         $container->setParameter('api_platform.elasticsearch.enabled', $enabled);
  723.         if (!$enabled) {
  724.             return;
  725.         }
  727.         $loader->load('elasticsearch.xml');
  729.         $container->registerForAutoconfiguration(RequestBodySearchCollectionExtensionInterface::class)
  730.             ->addTag('api_platform.elasticsearch.request_body_search_extension.collection');
  732.         $container->setParameter('api_platform.elasticsearch.hosts', $config['elasticsearch']['hosts']);
  733.         $container->setParameter('api_platform.elasticsearch.mapping', $config['elasticsearch']['mapping']);
  734.     }
  736.     private function registerSecurityConfiguration(ContainerBuilder $container, XmlFileLoader $loader): void
  737.     {
  738.         /** @var string[] $bundles */
  739.         $bundles = $container->getParameter('kernel.bundles');
  741.         if (!isset($bundles['SecurityBundle'])) {
  742.             return;
  743.         }
  745.         $loader->load('security.xml');
  746.     }
  748.     private function registerOpenApiConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  749.     {
  750.         $container->setParameter('api_platform.openapi.termsOfService', $config['openapi']['termsOfService']);
  751.         $container->setParameter('api_platform.openapi.contact.name', $config['openapi']['contact']['name']);
  752.         $container->setParameter('api_platform.openapi.contact.url', $config['openapi']['contact']['url']);
  753.         $container->setParameter('api_platform.openapi.contact.email', $config['openapi']['contact']['email']);
  754.         $container->setParameter('api_platform.openapi.license.name', $config['openapi']['license']['name']);
  755.         $container->setParameter('api_platform.openapi.license.url', $config['openapi']['license']['url']);
  757.         $loader->load('json_schema.xml');
  758.     }
  760.     private function registerMakerConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  761.     {
  762.         if (!$this->isConfigEnabled($container, $config['maker'])) {
  763.             return;
  764.         }
  766.         $loader->load('maker.xml');
  767.     }
  769.     private function registerArgumentResolverConfiguration(XmlFileLoader $loader): void
  770.     {
  771.         $loader->load('argument_resolver.xml');
  772.     }
  773. }