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

  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\ApiResource\Error;
  17. use ApiPlatform\Doctrine\Odm\Extension\AggregationCollectionExtensionInterface;
  18. use ApiPlatform\Doctrine\Odm\Extension\AggregationItemExtensionInterface;
  19. use ApiPlatform\Doctrine\Odm\Filter\AbstractFilter as DoctrineMongoDbOdmAbstractFilter;
  20. use ApiPlatform\Doctrine\Odm\State\LinksHandlerInterface as OdmLinksHandlerInterface;
  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\Doctrine\Orm\State\LinksHandlerInterface as OrmLinksHandlerInterface;
  27. use ApiPlatform\Elasticsearch\Extension\RequestBodySearchCollectionExtensionInterface;
  28. use ApiPlatform\GraphQl\Error\ErrorHandlerInterface;
  29. use ApiPlatform\GraphQl\Resolver\MutationResolverInterface;
  30. use ApiPlatform\GraphQl\Resolver\QueryCollectionResolverInterface;
  31. use ApiPlatform\GraphQl\Resolver\QueryItemResolverInterface;
  32. use ApiPlatform\GraphQl\Type\Definition\TypeInterface as GraphQlTypeInterface;
  33. use ApiPlatform\Metadata\ApiResource;
  34. use ApiPlatform\Metadata\FilterInterface;
  35. use ApiPlatform\Metadata\UrlGeneratorInterface;
  36. use ApiPlatform\Metadata\Util\Inflector;
  37. use ApiPlatform\State\ProcessorInterface;
  38. use ApiPlatform\State\ProviderInterface;
  39. use ApiPlatform\Symfony\GraphQl\Resolver\Factory\DataCollectorResolverFactory;
  40. use ApiPlatform\Symfony\Validator\Exception\ValidationException;
  41. use ApiPlatform\Symfony\Validator\Metadata\Property\Restriction\PropertySchemaRestrictionMetadataInterface;
  42. use ApiPlatform\Symfony\Validator\ValidationGroupsGeneratorInterface;
  43. use Doctrine\Persistence\ManagerRegistry;
  44. use phpDocumentor\Reflection\DocBlockFactoryInterface;
  45. use PHPStan\PhpDocParser\Parser\PhpDocParser;
  46. use Ramsey\Uuid\Uuid;
  47. use Symfony\Component\Config\FileLocator;
  48. use Symfony\Component\Config\Resource\DirectoryResource;
  49. use Symfony\Component\DependencyInjection\ContainerBuilder;
  50. use Symfony\Component\DependencyInjection\ContainerInterface;
  51. use Symfony\Component\DependencyInjection\Definition;
  52. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  53. use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
  54. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  55. use Symfony\Component\DependencyInjection\Reference;
  56. use Symfony\Component\Finder\Finder;
  57. use Symfony\Component\HttpClient\ScopingHttpClient;
  58. use Symfony\Component\HttpKernel\DependencyInjection\Extension;
  59. use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
  60. use Symfony\Component\Uid\AbstractUid;
  61. use Symfony\Component\Validator\Validator\ValidatorInterface;
  62. use Symfony\Component\Yaml\Yaml;
  63. use Twig\Environment;
  65. /**
  66.  * The extension of this bundle.
  67.  *
  68.  * @author Kévin Dunglas <dunglas@gmail.com>
  69.  */
  70. final class ApiPlatformExtension extends Extension implements PrependExtensionInterface
  71. {
  72.     /**
  73.      * {@inheritdoc}
  74.      */
  75.     public function prepend(ContainerBuilder $container): void
  76.     {
  77.         if (isset($container->getExtensions()['framework'])) {
  78.             $container->prependExtensionConfig('framework', [
  79.                 'serializer' => [
  80.                     'enabled' => true,
  81.                 ],
  82.             ]);
  83.             $container->prependExtensionConfig('framework', [
  84.                 'property_info' => [
  85.                     'enabled' => true,
  86.                 ],
  87.             ]);
  88.         }
  89.         if (isset($container->getExtensions()['lexik_jwt_authentication'])) {
  90.             $container->prependExtensionConfig('lexik_jwt_authentication', [
  91.                 'api_platform' => [
  92.                     'enabled' => true,
  93.                 ],
  94.             ]);
  95.         }
  96.     }
  98.     /**
  99.      * {@inheritdoc}
  100.      */
  101.     public function load(array $configs, ContainerBuilder $container): void
  102.     {
  103.         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
  105.         $configuration = new Configuration();
  106.         $config = $this->processConfiguration($configuration, $configs);
  108.         if (!$config['formats']) {
  109.             trigger_deprecation('api-platform/core', '3.2', 'Setting the "formats" section will be mandatory in API Platform 4.');
  110.             $config['formats'] = [
  111.                 'jsonld' => ['mime_types' => ['application/ld+json']],
  112.                 // Note that in API Platform 4 this will be removed as it was used for documentation only and are is now present in the docsFormats
  113.                 'json' => ['mime_types' => ['application/json']], // Swagger support
  114.             ];
  115.         }
  117.         $formats = $this->getFormats($config['formats']);
  118.         $patchFormats = $this->getFormats($config['patch_formats']);
  119.         $errorFormats = $this->getFormats($config['error_formats']);
  120.         $docsFormats = $this->getFormats($config['docs_formats']);
  122.         if (!isset($errorFormats['html']) && $config['enable_swagger'] && $config['enable_swagger_ui']) {
  123.             $errorFormats['html'] = ['text/html'];
  124.         }
  126.         if (!isset($errorFormats['json'])) {
  127.             $errorFormats['json'] = ['application/problem+json', 'application/json'];
  128.         }
  130.         if ($this->isConfigEnabled($container, $config['graphql']) && !isset($formats['json'])) {
  131.             trigger_deprecation('api-platform/core', '3.2', 'Add the "json" format to the configuration to use GraphQL.');
  132.             $formats['json'] = ['application/json'];
  133.         }
  135.         // Backward Compatibility layer
  136.         if (isset($formats['jsonapi']) && !isset($patchFormats['jsonapi'])) {
  137.             $patchFormats['jsonapi'] = ['application/vnd.api+json'];
  138.         }
  140.         if (isset($docsFormats['json']) && !isset($docsFormats['jsonopenapi'])) {
  141.             trigger_deprecation('api-platform/core', '3.2', 'The "json" format is too broad, use ["jsonopenapi" => ["application/vnd.openapi+json"]] instead.');
  142.             $docsFormats['jsonopenapi'] = ['application/vnd.openapi+json'];
  143.         }
  145.         $this->registerCommonConfiguration($container, $config, $loader, $formats, $patchFormats, $errorFormats, $docsFormats);
  146.         $this->registerMetadataConfiguration($container, $config, $loader);
  147.         $this->registerOAuthConfiguration($container, $config);
  148.         $this->registerOpenApiConfiguration($container, $config, $loader);
  149.         $this->registerSwaggerConfiguration($container, $config, $loader);
  150.         $this->registerJsonApiConfiguration($formats, $loader, $config);
  151.         $this->registerJsonLdHydraConfiguration($container, $formats, $loader, $config);
  152.         $this->registerJsonHalConfiguration($formats, $loader);
  153.         $this->registerJsonProblemConfiguration($errorFormats, $loader);
  154.         $this->registerGraphQlConfiguration($container, $config, $loader);
  155.         $this->registerCacheConfiguration($container);
  156.         $this->registerDoctrineOrmConfiguration($container, $config, $loader);
  157.         $this->registerDoctrineMongoDbOdmConfiguration($container, $config, $loader);
  158.         $this->registerHttpCacheConfiguration($container, $config, $loader);
  159.         $this->registerValidatorConfiguration($container, $config, $loader);
  160.         $this->registerDataCollectorConfiguration($container, $config, $loader);
  161.         $this->registerMercureConfiguration($container, $config, $loader);
  162.         $this->registerMessengerConfiguration($container, $config, $loader);
  163.         $this->registerElasticsearchConfiguration($container, $config, $loader);
  164.         $this->registerSecurityConfiguration($container, $config, $loader);
  165.         $this->registerMakerConfiguration($container, $config, $loader);
  166.         $this->registerArgumentResolverConfiguration($loader);
  168.         $container->registerForAutoconfiguration(FilterInterface::class)
  169.             ->addTag('api_platform.filter');
  170.         $container->registerForAutoconfiguration(ProviderInterface::class)
  171.             ->addTag('api_platform.state_provider');
  172.         $container->registerForAutoconfiguration(ProcessorInterface::class)
  173.             ->addTag('api_platform.state_processor');
  175.         if (!$container->has('api_platform.state.item_provider')) {
  176.             $container->setAlias('api_platform.state.item_provider', 'api_platform.state_provider.object');
  177.         }
  179.         $this->registerInflectorConfiguration($config);
  180.     }
  182.     private function registerCommonConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader, array $formats, array $patchFormats, array $errorFormats, array $docsFormats): void
  183.     {
  184.         $loader->load('symfony/events.xml');
  185.         $loader->load('symfony/controller.xml');
  186.         $loader->load('api.xml');
  187.         $loader->load('state.xml');
  188.         $loader->load('filter.xml');
  190.         if (class_exists(Uuid::class)) {
  191.             $loader->load('ramsey_uuid.xml');
  192.         }
  194.         if (class_exists(AbstractUid::class)) {
  195.             $loader->load('symfony/uid.xml');
  196.         }
  198.         // TODO: remove in 4.x
  199.         $container->setParameter('api_platform.event_listeners_backward_compatibility_layer', $config['event_listeners_backward_compatibility_layer']);
  200.         $loader->load('legacy/events.xml');
  202.         $container->setParameter('api_platform.enable_entrypoint', $config['enable_entrypoint']);
  203.         $container->setParameter('api_platform.enable_docs', $config['enable_docs']);
  204.         $container->setParameter('api_platform.keep_legacy_inflector', $config['keep_legacy_inflector']);
  205.         $container->setParameter('api_platform.title', $config['title']);
  206.         $container->setParameter('api_platform.description', $config['description']);
  207.         $container->setParameter('api_platform.version', $config['version']);
  208.         $container->setParameter('api_platform.show_webby', $config['show_webby']);
  209.         $container->setParameter('api_platform.url_generation_strategy', $config['defaults']['url_generation_strategy'] ?? UrlGeneratorInterface::ABS_PATH);
  210.         $container->setParameter('api_platform.exception_to_status', $config['exception_to_status']);
  211.         $container->setParameter('api_platform.formats', $formats);
  212.         $container->setParameter('api_platform.patch_formats', $patchFormats);
  213.         $container->setParameter('api_platform.error_formats', $errorFormats);
  214.         $container->setParameter('api_platform.docs_formats', $docsFormats);
  215.         $container->setParameter('api_platform.eager_loading.enabled', $this->isConfigEnabled($container, $config['eager_loading']));
  216.         $container->setParameter('api_platform.eager_loading.max_joins', $config['eager_loading']['max_joins']);
  217.         $container->setParameter('api_platform.eager_loading.fetch_partial', $config['eager_loading']['fetch_partial']);
  218.         $container->setParameter('api_platform.eager_loading.force_eager', $config['eager_loading']['force_eager']);
  219.         $container->setParameter('api_platform.collection.exists_parameter_name', $config['collection']['exists_parameter_name']);
  220.         $container->setParameter('api_platform.collection.order', $config['collection']['order']);
  221.         $container->setParameter('api_platform.collection.order_parameter_name', $config['collection']['order_parameter_name']);
  222.         $container->setParameter('api_platform.collection.order_nulls_comparison', $config['collection']['order_nulls_comparison']);
  223.         $container->setParameter('api_platform.collection.pagination.enabled', $config['defaults']['pagination_enabled'] ?? true);
  224.         $container->setParameter('api_platform.collection.pagination.partial', $config['defaults']['pagination_partial'] ?? false);
  225.         $container->setParameter('api_platform.collection.pagination.client_enabled', $config['defaults']['pagination_client_enabled'] ?? false);
  226.         $container->setParameter('api_platform.collection.pagination.client_items_per_page', $config['defaults']['pagination_client_items_per_page'] ?? false);
  227.         $container->setParameter('api_platform.collection.pagination.client_partial', $config['defaults']['pagination_client_partial'] ?? false);
  228.         $container->setParameter('api_platform.collection.pagination.items_per_page', $config['defaults']['pagination_items_per_page'] ?? 30);
  229.         $container->setParameter('api_platform.collection.pagination.maximum_items_per_page', $config['defaults']['pagination_maximum_items_per_page'] ?? null);
  230.         $container->setParameter('api_platform.collection.pagination.page_parameter_name', $config['defaults']['pagination_page_parameter_name'] ?? $config['collection']['pagination']['page_parameter_name']);
  231.         $container->setParameter('api_platform.collection.pagination.enabled_parameter_name', $config['defaults']['pagination_enabled_parameter_name'] ?? $config['collection']['pagination']['enabled_parameter_name']);
  232.         $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']);
  233.         $container->setParameter('api_platform.collection.pagination.partial_parameter_name', $config['defaults']['pagination_partial_parameter_name'] ?? $config['collection']['pagination']['partial_parameter_name']);
  234.         $container->setParameter('api_platform.collection.pagination', $this->getPaginationDefaults($config['defaults'] ?? [], $config['collection']['pagination']));
  235.         $container->setParameter('api_platform.http_cache.etag', $config['defaults']['cache_headers']['etag'] ?? true);
  236.         $container->setParameter('api_platform.http_cache.max_age', $config['defaults']['cache_headers']['max_age'] ?? null);
  237.         $container->setParameter('api_platform.http_cache.shared_max_age', $config['defaults']['cache_headers']['shared_max_age'] ?? null);
  238.         $container->setParameter('api_platform.http_cache.vary', $config['defaults']['cache_headers']['vary'] ?? ['Accept']);
  239.         $container->setParameter('api_platform.http_cache.public', $config['defaults']['cache_headers']['public'] ?? $config['http_cache']['public']);
  240.         $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']);
  241.         $container->setParameter('api_platform.http_cache.invalidation.xkey.glue', $config['defaults']['cache_headers']['invalidation']['xkey']['glue'] ?? $config['http_cache']['invalidation']['xkey']['glue']);
  243.         $container->setAlias('api_platform.path_segment_name_generator', $config['path_segment_name_generator']);
  245.         if ($config['name_converter']) {
  246.             $container->setAlias('api_platform.name_converter', $config['name_converter']);
  247.         }
  248.         $container->setParameter('api_platform.asset_package', $config['asset_package']);
  249.         $container->setParameter('api_platform.defaults', $this->normalizeDefaults($config['defaults'] ?? []));
  251.         if ($container->getParameter('kernel.debug')) {
  252.             $container->removeDefinition('api_platform.serializer.mapping.cache_class_metadata_factory');
  253.         }
  254.     }
  256.     /**
  257.      * This method will be removed in 3.0 when "defaults" will be the regular configuration path for the pagination.
  258.      */
  259.     private function getPaginationDefaults(array $defaults, array $collectionPaginationConfiguration): array
  260.     {
  261.         $paginationOptions = [];
  263.         foreach ($defaults as $key => $value) {
  264.             if (!str_starts_with($key, 'pagination_')) {
  265.                 continue;
  266.             }
  268.             $paginationOptions[str_replace('pagination_', '', $key)] = $value;
  269.         }
  271.         return array_merge($collectionPaginationConfiguration, $paginationOptions);
  272.     }
  274.     private function normalizeDefaults(array $defaults): array
  275.     {
  276.         $normalizedDefaults = ['extra_properties' => $defaults['extra_properties'] ?? []];
  277.         unset($defaults['extra_properties']);
  279.         $rc = new \ReflectionClass(ApiResource::class);
  280.         $publicProperties = [];
  281.         foreach ($rc->getConstructor()->getParameters() as $param) {
  282.             $publicProperties[$param->getName()] = true;
  283.         }
  285.         $nameConverter = new CamelCaseToSnakeCaseNameConverter();
  286.         foreach ($defaults as $option => $value) {
  287.             if (isset($publicProperties[$nameConverter->denormalize($option)])) {
  288.                 $normalizedDefaults[$option] = $value;
  290.                 continue;
  291.             }
  293.             $normalizedDefaults['extra_properties'][$option] = $value;
  294.         }
  296.         return $normalizedDefaults;
  297.     }
  299.     private function registerMetadataConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  300.     {
  301.         [$xmlResources, $yamlResources] = $this->getResourcesToWatch($container, $config);
  303.         $container->setParameter('api_platform.class_name_resources', $this->getClassNameResources());
  305.         $loader->load('metadata/resource_name.xml');
  306.         $loader->load('metadata/property_name.xml');
  308.         if (!empty($config['resource_class_directories'])) {
  309.             $container->setParameter('api_platform.resource_class_directories', array_merge(
  310.                 $config['resource_class_directories'],
  311.                 $container->getParameter('api_platform.resource_class_directories')
  312.             ));
  313.         }
  315.         // V3 metadata
  316.         $loader->load('metadata/xml.xml');
  317.         $loader->load('metadata/links.xml');
  318.         $loader->load('metadata/property.xml');
  319.         $loader->load('metadata/resource.xml');
  320.         $loader->load('metadata/operation.xml');
  322.         $container->getDefinition('api_platform.metadata.resource_extractor.xml')->replaceArgument(0, $xmlResources);
  323.         $container->getDefinition('api_platform.metadata.property_extractor.xml')->replaceArgument(0, $xmlResources);
  325.         if (class_exists(PhpDocParser::class) || interface_exists(DocBlockFactoryInterface::class)) {
  326.             $loader->load('metadata/php_doc.xml');
  327.         }
  329.         if (class_exists(Yaml::class)) {
  330.             $loader->load('metadata/yaml.xml');
  331.             $container->getDefinition('api_platform.metadata.resource_extractor.yaml')->replaceArgument(0, $yamlResources);
  332.             $container->getDefinition('api_platform.metadata.property_extractor.yaml')->replaceArgument(0, $yamlResources);
  333.         }
  334.     }
  336.     private function getClassNameResources(): array
  337.     {
  338.         return [
  339.             Error::class,
  340.             ValidationException::class,
  341.         ];
  342.     }
  344.     private function getBundlesResourcesPaths(ContainerBuilder $container, array $config): array
  345.     {
  346.         $bundlesResourcesPaths = [];
  348.         foreach ($container->getParameter('kernel.bundles_metadata') as $bundle) {
  349.             $dirname = $bundle['path'];
  350.             $paths = [
  351.                 "$dirname/ApiResource",
  352.                 "$dirname/src/ApiResource",
  353.             ];
  354.             foreach (['.yaml', '.yml', '.xml', ''] as $extension) {
  355.                 $paths[] = "$dirname/Resources/config/api_resources$extension";
  356.                 $paths[] = "$dirname/config/api_resources$extension";
  357.             }
  358.             if ($this->isConfigEnabled($container, $config['doctrine'])) {
  359.                 $paths[] = "$dirname/Entity";
  360.                 $paths[] = "$dirname/src/Entity";
  361.             }
  362.             if ($this->isConfigEnabled($container, $config['doctrine_mongodb_odm'])) {
  363.                 $paths[] = "$dirname/Document";
  364.                 $paths[] = "$dirname/src/Document";
  365.             }
  367.             foreach ($paths as $path) {
  368.                 if ($container->fileExists($path, false)) {
  369.                     $bundlesResourcesPaths[] = $path;
  370.                 }
  371.             }
  372.         }
  374.         return $bundlesResourcesPaths;
  375.     }
  377.     private function getResourcesToWatch(ContainerBuilder $container, array $config): array
  378.     {
  379.         $paths = array_unique(array_merge($this->getBundlesResourcesPaths($container, $config), $config['mapping']['paths']));
  381.         if (!$config['mapping']['paths']) {
  382.             $projectDir = $container->getParameter('kernel.project_dir');
  383.             foreach (["$projectDir/config/api_platform", "$projectDir/src/ApiResource"] as $dir) {
  384.                 if (is_dir($dir)) {
  385.                     $paths[] = $dir;
  386.                 }
  387.             }
  389.             if ($this->isConfigEnabled($container, $config['doctrine']) && is_dir($doctrinePath = "$projectDir/src/Entity")) {
  390.                 $paths[] = $doctrinePath;
  391.             }
  393.             if ($this->isConfigEnabled($container, $config['doctrine_mongodb_odm']) && is_dir($documentPath = "$projectDir/src/Document")) {
  394.                 $paths[] = $documentPath;
  395.             }
  396.         }
  398.         $resources = ['yml' => [], 'xml' => [], 'dir' => []];
  400.         foreach ($paths as $path) {
  401.             if (is_dir($path)) {
  402.                 foreach (Finder::create()->followLinks()->files()->in($path)->name('/\.(xml|ya?ml)$/')->sortByName() as $file) {
  403.                     $resources['yaml' === ($extension = $file->getExtension()) ? 'yml' : $extension][] = $file->getRealPath();
  404.                 }
  406.                 $resources['dir'][] = $path;
  407.                 $container->addResource(new DirectoryResource($path, '/\.(xml|ya?ml|php)$/'));
  409.                 continue;
  410.             }
  412.             if ($container->fileExists($path, false)) {
  413.                 if (!preg_match('/\.(xml|ya?ml)$/', (string) $path, $matches)) {
  414.                     throw new RuntimeException(sprintf('Unsupported mapping type in "%s", supported types are XML & YAML.', $path));
  415.                 }
  417.                 $resources['yaml' === $matches[1] ? 'yml' : $matches[1]][] = $path;
  419.                 continue;
  420.             }
  422.             throw new RuntimeException(sprintf('Could not open file or directory "%s".', $path));
  423.         }
  425.         $container->setParameter('api_platform.resource_class_directories', $resources['dir']);
  427.         return [$resources['xml'], $resources['yml']];
  428.     }
  430.     private function registerOAuthConfiguration(ContainerBuilder $container, array $config): void
  431.     {
  432.         if (!$config['oauth']) {
  433.             return;
  434.         }
  436.         $container->setParameter('api_platform.oauth.enabled', $this->isConfigEnabled($container, $config['oauth']));
  437.         $container->setParameter('api_platform.oauth.clientId', $config['oauth']['clientId']);
  438.         $container->setParameter('api_platform.oauth.clientSecret', $config['oauth']['clientSecret']);
  439.         $container->setParameter('api_platform.oauth.type', $config['oauth']['type']);
  440.         $container->setParameter('api_platform.oauth.flow', $config['oauth']['flow']);
  441.         $container->setParameter('api_platform.oauth.tokenUrl', $config['oauth']['tokenUrl']);
  442.         $container->setParameter('api_platform.oauth.authorizationUrl', $config['oauth']['authorizationUrl']);
  443.         $container->setParameter('api_platform.oauth.refreshUrl', $config['oauth']['refreshUrl']);
  444.         $container->setParameter('api_platform.oauth.scopes', $config['oauth']['scopes']);
  445.         $container->setParameter('api_platform.oauth.pkce', $config['oauth']['pkce']);
  447.         if ($container->hasDefinition('api_platform.swagger_ui.action')) {
  448.             $container->getDefinition('api_platform.swagger_ui.action')->setArgument(10, $config['oauth']['pkce']);
  449.         }
  450.     }
  452.     /**
  453.      * Registers the Swagger, ReDoc and Swagger UI configuration.
  454.      */
  455.     private function registerSwaggerConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  456.     {
  457.         foreach (array_keys($config['swagger']['api_keys']) as $keyName) {
  458.             if (!preg_match('/^[a-zA-Z0-9._-]+$/', $keyName)) {
  459.                 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));
  460.             }
  461.         }
  463.         $container->setParameter('api_platform.swagger.versions', $config['swagger']['versions']);
  465.         if (!$config['enable_swagger'] && $config['enable_swagger_ui']) {
  466.             throw new RuntimeException('You can not enable the Swagger UI without enabling Swagger, fix this by enabling swagger via the configuration "enable_swagger: true".');
  467.         }
  469.         if (!$config['enable_swagger']) {
  470.             return;
  471.         }
  473.         $loader->load('openapi.xml');
  474.         $loader->load('swagger_ui.xml');
  476.         $loader->load('legacy/swagger_ui.xml');
  478.         if (!$config['enable_swagger_ui'] && !$config['enable_re_doc']) {
  479.             // Remove the listener but keep the controller to allow customizing the path of the UI
  480.             $container->removeDefinition('api_platform.swagger.listener.ui');
  481.         }
  483.         $container->setParameter('api_platform.enable_swagger_ui', $config['enable_swagger_ui']);
  484.         $container->setParameter('api_platform.enable_re_doc', $config['enable_re_doc']);
  485.         $container->setParameter('api_platform.swagger.api_keys', $config['swagger']['api_keys']);
  486.         if ($config['openapi']['swagger_ui_extra_configuration'] && $config['swagger']['swagger_ui_extra_configuration']) {
  487.             throw new RuntimeException('You can not set "swagger_ui_extra_configuration" twice - in "openapi" and "swagger" section.');
  488.         }
  489.         $container->setParameter('api_platform.swagger_ui.extra_configuration', $config['openapi']['swagger_ui_extra_configuration'] ?: $config['swagger']['swagger_ui_extra_configuration']);
  490.     }
  492.     private function registerJsonApiConfiguration(array $formats, XmlFileLoader $loader, array $config): void
  493.     {
  494.         if (!isset($formats['jsonapi'])) {
  495.             return;
  496.         }
  498.         $loader->load('jsonapi.xml');
  499.         $loader->load('legacy/jsonapi.xml');
  500.     }
  502.     private function registerJsonLdHydraConfiguration(ContainerBuilder $container, array $formats, XmlFileLoader $loader, array $config): void
  503.     {
  504.         if (!isset($formats['jsonld'])) {
  505.             return;
  506.         }
  508.         $loader->load('jsonld.xml');
  509.         $loader->load('legacy/hydra.xml');
  510.         $loader->load('hydra.xml');
  512.         if (!$container->has('api_platform.json_schema.schema_factory')) {
  513.             $container->removeDefinition('api_platform.hydra.json_schema.schema_factory');
  514.         }
  516.         if (!$config['enable_docs']) {
  517.             $container->removeDefinition('api_platform.hydra.listener.response.add_link_header');
  518.         }
  519.     }
  521.     private function registerJsonHalConfiguration(array $formats, XmlFileLoader $loader): void
  522.     {
  523.         if (!isset($formats['jsonhal'])) {
  524.             return;
  525.         }
  527.         $loader->load('hal.xml');
  528.     }
  530.     private function registerJsonProblemConfiguration(array $errorFormats, XmlFileLoader $loader): void
  531.     {
  532.         if (!isset($errorFormats['jsonproblem'])) {
  533.             return;
  534.         }
  536.         $loader->load('problem.xml');
  537.     }
  539.     private function registerGraphQlConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  540.     {
  541.         $enabled = $this->isConfigEnabled($container, $config['graphql']);
  543.         $graphqlIntrospectionEnabled = $enabled && $this->isConfigEnabled($container, $config['graphql']['introspection']);
  545.         $graphiqlEnabled = $enabled && $this->isConfigEnabled($container, $config['graphql']['graphiql']);
  546.         $graphqlPlayGroundEnabled = $enabled && $this->isConfigEnabled($container, $config['graphql']['graphql_playground']);
  547.         if ($graphqlPlayGroundEnabled) {
  548.             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.');
  549.         }
  551.         $container->setParameter('api_platform.graphql.enabled', $enabled);
  552.         $container->setParameter('api_platform.graphql.introspection.enabled', $graphqlIntrospectionEnabled);
  553.         $container->setParameter('api_platform.graphql.graphiql.enabled', $graphiqlEnabled);
  554.         $container->setParameter('api_platform.graphql.graphql_playground.enabled', $graphqlPlayGroundEnabled);
  555.         $container->setParameter('api_platform.graphql.collection.pagination', $config['graphql']['collection']['pagination']);
  557.         if (!$enabled) {
  558.             return;
  559.         }
  561.         $container->setParameter('api_platform.graphql.default_ide', $config['graphql']['default_ide']);
  562.         $container->setParameter('api_platform.graphql.nesting_separator', $config['graphql']['nesting_separator']);
  564.         $loader->load('graphql.xml');
  566.         // @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
  567.         if (!class_exists(Environment::class) || !isset($container->getParameter('kernel.bundles')['TwigBundle'])) {
  568.             if ($graphiqlEnabled || $graphqlPlayGroundEnabled) {
  569.                 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')));
  570.             }
  571.             $container->removeDefinition('api_platform.graphql.action.graphiql');
  572.             $container->removeDefinition('api_platform.graphql.action.graphql_playground');
  573.         }
  575.         $container->registerForAutoconfiguration(QueryItemResolverInterface::class)
  576.             ->addTag('api_platform.graphql.resolver');
  577.         $container->registerForAutoconfiguration(QueryCollectionResolverInterface::class)
  578.             ->addTag('api_platform.graphql.resolver');
  579.         $container->registerForAutoconfiguration(MutationResolverInterface::class)
  580.             ->addTag('api_platform.graphql.resolver');
  581.         $container->registerForAutoconfiguration(GraphQlTypeInterface::class)
  582.             ->addTag('api_platform.graphql.type');
  583.         $container->registerForAutoconfiguration(ErrorHandlerInterface::class)
  584.             ->addTag('api_platform.graphql.error_handler');
  586.         if (!$container->getParameter('kernel.debug')) {
  587.             return;
  588.         }
  590.         /* TODO: remove these in 4.x only one resolver factory is used and we're using providers/processors */
  591.         if ($config['event_listeners_backward_compatibility_layer'] ?? true) {
  592.             $loader->load('legacy/graphql.xml');
  593.             $requestStack = new Reference('request_stack', ContainerInterface::NULL_ON_INVALID_REFERENCE);
  594.             $collectionDataCollectorResolverFactory = (new Definition(DataCollectorResolverFactory::class))
  595.                 ->setDecoratedService('api_platform.graphql.resolver.factory.collection')
  596.                 ->setArguments([new Reference('api_platform.graphql.data_collector.resolver.factory.collection.inner'), $requestStack]);
  598.             $itemDataCollectorResolverFactory = (new Definition(DataCollectorResolverFactory::class))
  599.                 ->setDecoratedService('api_platform.graphql.resolver.factory.item')
  600.                 ->setArguments([new Reference('api_platform.graphql.data_collector.resolver.factory.item.inner'), $requestStack]);
  602.             $itemMutationDataCollectorResolverFactory = (new Definition(DataCollectorResolverFactory::class))
  603.                 ->setDecoratedService('api_platform.graphql.resolver.factory.item_mutation')
  604.                 ->setArguments([new Reference('api_platform.graphql.data_collector.resolver.factory.item_mutation.inner'), $requestStack]);
  606.             $itemSubscriptionDataCollectorResolverFactory = (new Definition(DataCollectorResolverFactory::class))
  607.                 ->setDecoratedService('api_platform.graphql.resolver.factory.item_subscription')
  608.                 ->setArguments([new Reference('api_platform.graphql.data_collector.resolver.factory.item_subscription.inner'), $requestStack]);
  610.             $container->addDefinitions([
  611.                 'api_platform.graphql.data_collector.resolver.factory.collection' => $collectionDataCollectorResolverFactory,
  612.                 'api_platform.graphql.data_collector.resolver.factory.item' => $itemDataCollectorResolverFactory,
  613.                 'api_platform.graphql.data_collector.resolver.factory.item_mutation' => $itemMutationDataCollectorResolverFactory,
  614.                 'api_platform.graphql.data_collector.resolver.factory.item_subscription' => $itemSubscriptionDataCollectorResolverFactory,
  615.             ]);
  616.         }
  617.     }
  619.     private function registerCacheConfiguration(ContainerBuilder $container): void
  620.     {
  621.         if (!$container->hasParameter('kernel.debug') || !$container->getParameter('kernel.debug')) {
  622.             $container->removeDefinition('api_platform.cache_warmer.cache_pool_clearer');
  623.         }
  624.     }
  626.     private function registerDoctrineOrmConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  627.     {
  628.         if (!$this->isConfigEnabled($container, $config['doctrine'])) {
  629.             return;
  630.         }
  632.         // For older versions of doctrine bridge this allows autoconfiguration for filters
  633.         if (!$container->has(ManagerRegistry::class)) {
  634.             $container->setAlias(ManagerRegistry::class, 'doctrine');
  635.         }
  637.         $container->registerForAutoconfiguration(QueryItemExtensionInterface::class)
  638.             ->addTag('api_platform.doctrine.orm.query_extension.item');
  639.         $container->registerForAutoconfiguration(DoctrineQueryCollectionExtensionInterface::class)
  640.             ->addTag('api_platform.doctrine.orm.query_extension.collection');
  641.         $container->registerForAutoconfiguration(DoctrineOrmAbstractFilter::class);
  643.         $container->registerForAutoconfiguration(OrmLinksHandlerInterface::class)
  644.             ->addTag('api_platform.doctrine.orm.links_handler');
  646.         $loader->load('doctrine_orm.xml');
  648.         if ($this->isConfigEnabled($container, $config['eager_loading'])) {
  649.             return;
  650.         }
  652.         $container->removeAlias(EagerLoadingExtension::class);
  653.         $container->removeDefinition('api_platform.doctrine.orm.query_extension.eager_loading');
  654.         $container->removeAlias(FilterEagerLoadingExtension::class);
  655.         $container->removeDefinition('api_platform.doctrine.orm.query_extension.filter_eager_loading');
  656.     }
  658.     private function registerDoctrineMongoDbOdmConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  659.     {
  660.         if (!$this->isConfigEnabled($container, $config['doctrine_mongodb_odm'])) {
  661.             return;
  662.         }
  664.         $container->registerForAutoconfiguration(AggregationItemExtensionInterface::class)
  665.             ->addTag('api_platform.doctrine_mongodb.odm.aggregation_extension.item');
  666.         $container->registerForAutoconfiguration(AggregationCollectionExtensionInterface::class)
  667.             ->addTag('api_platform.doctrine_mongodb.odm.aggregation_extension.collection');
  668.         $container->registerForAutoconfiguration(DoctrineMongoDbOdmAbstractFilter::class)
  669.             ->setBindings(['$managerRegistry' => new Reference('doctrine_mongodb')]);
  670.         $container->registerForAutoconfiguration(OdmLinksHandlerInterface::class)
  671.             ->addTag('api_platform.doctrine.odm.links_handler');
  673.         $loader->load('doctrine_mongodb_odm.xml');
  674.     }
  676.     private function registerHttpCacheConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  677.     {
  678.         $loader->load('http_cache.xml');
  679.         $loader->load('legacy/http_cache.xml');
  681.         if (!$this->isConfigEnabled($container, $config['http_cache']['invalidation'])) {
  682.             return;
  683.         }
  685.         if ($this->isConfigEnabled($container, $config['doctrine'])) {
  686.             $loader->load('doctrine_orm_http_cache_purger.xml');
  687.         }
  689.         $loader->load('http_cache_purger.xml');
  690.         $loader->load('legacy/http_cache_purger.xml');
  692.         foreach ($config['http_cache']['invalidation']['scoped_clients'] as $client) {
  693.             $definition = $container->getDefinition($client);
  694.             $definition->addTag('api_platform.http_cache.http_client');
  695.         }
  697.         if (!($urls = $config['http_cache']['invalidation']['urls'])) {
  698.             $urls = $config['http_cache']['invalidation']['varnish_urls'];
  699.         }
  701.         foreach ($urls as $key => $url) {
  702.             $definition = new Definition(ScopingHttpClient::class, [new Reference('http_client'), $url, ['base_uri' => $url] + $config['http_cache']['invalidation']['request_options']]);
  703.             $definition->setFactory([ScopingHttpClient::class, 'forBaseUri']);
  704.             $definition->addTag('api_platform.http_cache.http_client');
  705.             $container->setDefinition('api_platform.invalidation_http_client.'.$key, $definition);
  706.         }
  708.         $serviceName = $config['http_cache']['invalidation']['purger'];
  710.         if (!$container->hasDefinition('api_platform.http_cache.purger')) {
  711.             $container->setAlias('api_platform.http_cache.purger', $serviceName);
  712.         }
  713.     }
  715.     /**
  716.      * Normalizes the format from config to the one accepted by Symfony HttpFoundation.
  717.      */
  718.     private function getFormats(array $configFormats): array
  719.     {
  720.         $formats = [];
  721.         foreach ($configFormats as $format => $value) {
  722.             foreach ($value['mime_types'] as $mimeType) {
  723.                 $formats[$format][] = $mimeType;
  724.             }
  725.         }
  727.         return $formats;
  728.     }
  730.     private function registerValidatorConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  731.     {
  732.         if (interface_exists(ValidatorInterface::class)) {
  733.             $loader->load('metadata/validator.xml');
  734.             $loader->load('symfony/validator.xml');
  736.             if ($this->isConfigEnabled($container, $config['graphql'])) {
  737.                 $loader->load('graphql/validator.xml');
  738.             }
  740.             $container->registerForAutoconfiguration(ValidationGroupsGeneratorInterface::class)
  741.                 ->addTag('api_platform.validation_groups_generator');
  742.             $container->registerForAutoconfiguration(PropertySchemaRestrictionMetadataInterface::class)
  743.                 ->addTag('api_platform.metadata.property_schema_restriction');
  745.             $loader->load('legacy/validator.xml');
  746.         }
  748.         if (!$config['validator']) {
  749.             return;
  750.         }
  752.         $container->setParameter('api_platform.validator.serialize_payload_fields', $config['validator']['serialize_payload_fields']);
  753.         $container->setParameter('api_platform.validator.query_parameter_validation', $config['validator']['query_parameter_validation']);
  755.         if (!$config['validator']['query_parameter_validation']) {
  756.             $container->removeDefinition('api_platform.listener.view.validate_query_parameters');
  757.             $container->removeDefinition('api_platform.validator.query_parameter_validator');
  758.         }
  759.     }
  761.     private function registerDataCollectorConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  762.     {
  763.         if (!$config['enable_profiler']) {
  764.             return;
  765.         }
  767.         $loader->load('data_collector.xml');
  769.         if ($container->hasParameter('kernel.debug') && $container->getParameter('kernel.debug')) {
  770.             $loader->load('debug.xml');
  771.         }
  772.     }
  774.     private function registerMercureConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  775.     {
  776.         if (!$this->isConfigEnabled($container, $config['mercure'])) {
  777.             return;
  778.         }
  780.         $container->setParameter('api_platform.mercure.include_type', $config['mercure']['include_type']);
  782.         $loader->load('legacy/mercure.xml');
  783.         $loader->load('mercure.xml');
  785.         if ($this->isConfigEnabled($container, $config['doctrine'])) {
  786.             $loader->load('doctrine_orm_mercure_publisher.xml');
  787.         }
  788.         if ($this->isConfigEnabled($container, $config['doctrine_mongodb_odm'])) {
  789.             $loader->load('doctrine_odm_mercure_publisher.xml');
  790.         }
  792.         if ($this->isConfigEnabled($container, $config['graphql'])) {
  793.             $loader->load('graphql_mercure.xml');
  794.         }
  795.     }
  797.     private function registerMessengerConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  798.     {
  799.         if (!$this->isConfigEnabled($container, $config['messenger'])) {
  800.             return;
  801.         }
  803.         $loader->load('messenger.xml');
  804.     }
  806.     private function registerElasticsearchConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  807.     {
  808.         $enabled = $this->isConfigEnabled($container, $config['elasticsearch']);
  810.         $container->setParameter('api_platform.elasticsearch.enabled', $enabled);
  812.         if (!$enabled) {
  813.             return;
  814.         }
  816.         $clientClass = class_exists(\Elasticsearch\Client::class) ? \Elasticsearch\Client::class : \Elastic\Elasticsearch\Client::class;
  818.         $clientDefinition = new Definition($clientClass);
  819.         $container->setDefinition('api_platform.elasticsearch.client', $clientDefinition);
  820.         $container->registerForAutoconfiguration(RequestBodySearchCollectionExtensionInterface::class)
  821.             ->addTag('api_platform.elasticsearch.request_body_search_extension.collection');
  822.         $container->setParameter('api_platform.elasticsearch.hosts', $config['elasticsearch']['hosts']);
  823.         $loader->load('elasticsearch.xml');
  825.         // @phpstan-ignore-next-line
  826.         if (\Elasticsearch\Client::class === $clientClass) {
  827.             $loader->load('legacy/elasticsearch.xml');
  828.             $container->setParameter('api_platform.elasticsearch.mapping', $config['elasticsearch']['mapping']);
  829.             $container->setDefinition('api_platform.elasticsearch.client_for_metadata', $clientDefinition);
  830.         }
  831.     }
  833.     private function registerSecurityConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  834.     {
  835.         /** @var string[] $bundles */
  836.         $bundles = $container->getParameter('kernel.bundles');
  838.         if (!isset($bundles['SecurityBundle'])) {
  839.             return;
  840.         }
  842.         $loader->load('security.xml');
  843.         $loader->load('legacy/security.xml');
  845.         if (interface_exists(ValidatorInterface::class)) {
  846.             $loader->load('symfony/security_validator.xml');
  847.         }
  849.         if ($this->isConfigEnabled($container, $config['graphql'])) {
  850.             $loader->load('graphql/security.xml');
  851.         }
  852.     }
  854.     private function registerOpenApiConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  855.     {
  856.         $container->setParameter('api_platform.openapi.termsOfService', $config['openapi']['termsOfService']);
  857.         $container->setParameter('api_platform.openapi.contact.name', $config['openapi']['contact']['name']);
  858.         $container->setParameter('api_platform.openapi.contact.url', $config['openapi']['contact']['url']);
  859.         $container->setParameter('api_platform.openapi.contact.email', $config['openapi']['contact']['email']);
  860.         $container->setParameter('api_platform.openapi.license.name', $config['openapi']['license']['name']);
  861.         $container->setParameter('api_platform.openapi.license.url', $config['openapi']['license']['url']);
  863.         $loader->load('json_schema.xml');
  864.     }
  866.     private function registerMakerConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  867.     {
  868.         if (!$this->isConfigEnabled($container, $config['maker'])) {
  869.             return;
  870.         }
  872.         $loader->load('maker.xml');
  873.     }
  875.     private function registerArgumentResolverConfiguration(XmlFileLoader $loader): void
  876.     {
  877.         $loader->load('argument_resolver.xml');
  878.     }
  880.     private function registerInflectorConfiguration(array $config): void
  881.     {
  882.         if ($config['keep_legacy_inflector']) {
  883.             Inflector::keepLegacyInflector(true);
  884.             trigger_deprecation('api-platform/core', '3.2', 'Using doctrine/inflector is deprecated since API Platform 3.2 and will be removed in API Platform 4. Use symfony/string instead. Run "composer require symfony/string" and set "keep_legacy_inflector" to false in config.');
  885.         } else {
  886.             Inflector::keepLegacyInflector(false);
  887.         }
  888.     }
  889. }