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

  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 as LegacyFilterInterface;
  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\UriVariableTransformerInterface;
  36. use ApiPlatform\Metadata\UrlGeneratorInterface;
  37. use ApiPlatform\Metadata\Util\Inflector;
  38. use ApiPlatform\State\ApiResource\Error;
  39. use ApiPlatform\State\ProcessorInterface;
  40. use ApiPlatform\State\ProviderInterface;
  41. use ApiPlatform\Symfony\GraphQl\Resolver\Factory\DataCollectorResolverFactory;
  42. use ApiPlatform\Symfony\Validator\Exception\ValidationException;
  43. use ApiPlatform\Symfony\Validator\Metadata\Property\Restriction\PropertySchemaRestrictionMetadataInterface;
  44. use ApiPlatform\Symfony\Validator\ValidationGroupsGeneratorInterface;
  45. use Doctrine\Persistence\ManagerRegistry;
  46. use phpDocumentor\Reflection\DocBlockFactoryInterface;
  47. use PHPStan\PhpDocParser\Parser\PhpDocParser;
  48. use Ramsey\Uuid\Uuid;
  49. use Symfony\Component\Config\FileLocator;
  50. use Symfony\Component\Config\Resource\DirectoryResource;
  51. use Symfony\Component\DependencyInjection\ContainerBuilder;
  52. use Symfony\Component\DependencyInjection\ContainerInterface;
  53. use Symfony\Component\DependencyInjection\Definition;
  54. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  55. use Symfony\Component\DependencyInjection\Extension\Extension;
  56. use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
  57. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  58. use Symfony\Component\DependencyInjection\Reference;
  59. use Symfony\Component\Finder\Finder;
  60. use Symfony\Component\HttpClient\ScopingHttpClient;
  61. use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
  62. use Symfony\Component\Uid\AbstractUid;
  63. use Symfony\Component\Validator\Validator\ValidatorInterface;
  64. use Symfony\Component\Yaml\Yaml;
  65. use Twig\Environment;
  67. /**
  68.  * The extension of this bundle.
  69.  *
  70.  * @author Kévin Dunglas <dunglas@gmail.com>
  71.  */
  72. final class ApiPlatformExtension extends Extension implements PrependExtensionInterface
  73. {
  74.     /**
  75.      * {@inheritdoc}
  76.      */
  77.     public function prepend(ContainerBuilder $container): void
  78.     {
  79.         if (isset($container->getExtensions()['framework'])) {
  80.             $container->prependExtensionConfig('framework', [
  81.                 'serializer' => [
  82.                     'enabled' => true,
  83.                 ],
  84.             ]);
  85.             $container->prependExtensionConfig('framework', [
  86.                 'property_info' => [
  87.                     'enabled' => true,
  88.                 ],
  89.             ]);
  90.         }
  91.         if (isset($container->getExtensions()['lexik_jwt_authentication'])) {
  92.             $container->prependExtensionConfig('lexik_jwt_authentication', [
  93.                 'api_platform' => [
  94.                     'enabled' => true,
  95.                 ],
  96.             ]);
  97.         }
  98.     }
  100.     /**
  101.      * {@inheritdoc}
  102.      */
  103.     public function load(array $configs, ContainerBuilder $container): void
  104.     {
  105.         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
  107.         $configuration = new Configuration();
  108.         $config = $this->processConfiguration($configuration, $configs);
  110.         if (!$config['formats']) {
  111.             trigger_deprecation('api-platform/core', '3.2', 'Setting the "formats" section will be mandatory in API Platform 4.');
  112.             $config['formats'] = [
  113.                 'jsonld' => ['mime_types' => ['application/ld+json']],
  114.                 // 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
  115.                 'json' => ['mime_types' => ['application/json']], // Swagger support
  116.             ];
  117.         }
  119.         $formats = $this->getFormats($config['formats']);
  120.         $patchFormats = $this->getFormats($config['patch_formats']);
  121.         $errorFormats = $this->getFormats($config['error_formats']);
  122.         $docsFormats = $this->getFormats($config['docs_formats']);
  123.         $jsonSchemaFormats = $config['jsonschema_formats'];
  125.         if (!$jsonSchemaFormats) {
  126.             foreach (array_keys($formats) as $f) {
  127.                 // Distinct JSON-based formats must have names that start with 'json'
  128.                 if (str_starts_with($f, 'json')) {
  129.                     $jsonSchemaFormats[$f] = true;
  130.                 }
  131.             }
  132.         }
  134.         if (!isset($errorFormats['json'])) {
  135.             $errorFormats['json'] = ['application/problem+json', 'application/json'];
  136.         }
  138.         if (!isset($errorFormats['jsonproblem'])) {
  139.             $errorFormats['jsonproblem'] = ['application/problem+json'];
  140.         }
  142.         if ($this->isConfigEnabled($container, $config['graphql']) && !isset($formats['json'])) {
  143.             trigger_deprecation('api-platform/core', '3.2', 'Add the "json" format to the configuration to use GraphQL.');
  144.             $formats['json'] = ['application/json'];
  145.         }
  147.         // Backward Compatibility layer
  148.         if (isset($formats['jsonapi']) && !isset($patchFormats['jsonapi'])) {
  149.             $patchFormats['jsonapi'] = ['application/vnd.api+json'];
  150.         }
  152.         if (isset($docsFormats['json']) && !isset($docsFormats['jsonopenapi'])) {
  153.             trigger_deprecation('api-platform/core', '3.2', 'The "json" format is too broad, use ["jsonopenapi" => ["application/vnd.openapi+json"]] instead.');
  154.             $docsFormats['jsonopenapi'] = ['application/vnd.openapi+json'];
  155.         }
  157.         $this->registerCommonConfiguration($container, $config, $loader, $formats, $patchFormats, $errorFormats, $docsFormats, $jsonSchemaFormats);
  158.         $this->registerMetadataConfiguration($container, $config, $loader);
  159.         $this->registerOAuthConfiguration($container, $config);
  160.         $this->registerOpenApiConfiguration($container, $config, $loader);
  161.         $this->registerSwaggerConfiguration($container, $config, $loader);
  162.         $this->registerJsonApiConfiguration($formats, $loader, $config);
  163.         $this->registerJsonLdHydraConfiguration($container, $formats, $loader, $config);
  164.         $this->registerJsonHalConfiguration($formats, $loader);
  165.         $this->registerJsonProblemConfiguration($errorFormats, $loader);
  166.         $this->registerGraphQlConfiguration($container, $config, $loader);
  167.         $this->registerCacheConfiguration($container);
  168.         $this->registerDoctrineOrmConfiguration($container, $config, $loader);
  169.         $this->registerDoctrineMongoDbOdmConfiguration($container, $config, $loader);
  170.         $this->registerHttpCacheConfiguration($container, $config, $loader);
  171.         $this->registerValidatorConfiguration($container, $config, $loader);
  172.         $this->registerDataCollectorConfiguration($container, $config, $loader);
  173.         $this->registerMercureConfiguration($container, $config, $loader);
  174.         $this->registerMessengerConfiguration($container, $config, $loader);
  175.         $this->registerElasticsearchConfiguration($container, $config, $loader);
  176.         $this->registerSecurityConfiguration($container, $config, $loader);
  177.         $this->registerMakerConfiguration($container, $config, $loader);
  178.         $this->registerArgumentResolverConfiguration($loader);
  180.         $container->registerForAutoconfiguration(FilterInterface::class)
  181.             ->addTag('api_platform.filter');
  182.         $container->registerForAutoconfiguration(LegacyFilterInterface::class)
  183.             ->addTag('api_platform.filter');
  184.         $container->registerForAutoconfiguration(ProviderInterface::class)
  185.             ->addTag('api_platform.state_provider');
  186.         $container->registerForAutoconfiguration(ProcessorInterface::class)
  187.             ->addTag('api_platform.state_processor');
  188.         $container->registerForAutoconfiguration(UriVariableTransformerInterface::class)
  189.             ->addTag('api_platform.uri_variables.transformer');
  191.         if (!$container->has('api_platform.state.item_provider')) {
  192.             $container->setAlias('api_platform.state.item_provider', 'api_platform.state_provider.object');
  193.         }
  195.         $this->registerInflectorConfiguration($config);
  196.     }
  198.     private function registerCommonConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader, array $formats, array $patchFormats, array $errorFormats, array $docsFormats, array $jsonSchemaFormats): void
  199.     {
  200.         $loader->load('symfony/events.xml');
  201.         $loader->load('symfony/controller.xml');
  202.         $loader->load('api.xml');
  203.         $loader->load('state.xml');
  204.         $loader->load('filter.xml');
  206.         if (class_exists(Uuid::class)) {
  207.             $loader->load('ramsey_uuid.xml');
  208.         }
  210.         if (class_exists(AbstractUid::class)) {
  211.             $loader->load('symfony/uid.xml');
  212.         }
  214.         // TODO: remove in 4.x
  215.         $container->setParameter('api_platform.event_listeners_backward_compatibility_layer', $config['event_listeners_backward_compatibility_layer']);
  216.         $loader->load('legacy/events.xml');
  218.         $container->setParameter('api_platform.enable_entrypoint', $config['enable_entrypoint']);
  219.         $container->setParameter('api_platform.enable_docs', $config['enable_docs']);
  220.         $container->setParameter('api_platform.keep_legacy_inflector', $config['keep_legacy_inflector']);
  221.         $container->setParameter('api_platform.title', $config['title']);
  222.         $container->setParameter('api_platform.description', $config['description']);
  223.         $container->setParameter('api_platform.version', $config['version']);
  224.         $container->setParameter('api_platform.show_webby', $config['show_webby']);
  225.         $container->setParameter('api_platform.url_generation_strategy', $config['defaults']['url_generation_strategy'] ?? UrlGeneratorInterface::ABS_PATH);
  226.         $container->setParameter('api_platform.exception_to_status', $config['exception_to_status']);
  227.         $container->setParameter('api_platform.formats', $formats);
  228.         $container->setParameter('api_platform.patch_formats', $patchFormats);
  229.         $container->setParameter('api_platform.error_formats', $errorFormats);
  230.         $container->setParameter('api_platform.docs_formats', $docsFormats);
  231.         $container->setParameter('api_platform.jsonschema_formats', $jsonSchemaFormats);
  232.         $container->setParameter('api_platform.eager_loading.enabled', $this->isConfigEnabled($container, $config['eager_loading']));
  233.         $container->setParameter('api_platform.eager_loading.max_joins', $config['eager_loading']['max_joins']);
  234.         $container->setParameter('api_platform.eager_loading.fetch_partial', $config['eager_loading']['fetch_partial']);
  235.         $container->setParameter('api_platform.eager_loading.force_eager', $config['eager_loading']['force_eager']);
  236.         $container->setParameter('api_platform.collection.exists_parameter_name', $config['collection']['exists_parameter_name']);
  237.         $container->setParameter('api_platform.collection.order', $config['collection']['order']);
  238.         $container->setParameter('api_platform.collection.order_parameter_name', $config['collection']['order_parameter_name']);
  239.         $container->setParameter('api_platform.collection.order_nulls_comparison', $config['collection']['order_nulls_comparison']);
  240.         $container->setParameter('api_platform.collection.pagination.enabled', $config['defaults']['pagination_enabled'] ?? true);
  241.         $container->setParameter('api_platform.collection.pagination.partial', $config['defaults']['pagination_partial'] ?? false);
  242.         $container->setParameter('api_platform.collection.pagination.client_enabled', $config['defaults']['pagination_client_enabled'] ?? false);
  243.         $container->setParameter('api_platform.collection.pagination.client_items_per_page', $config['defaults']['pagination_client_items_per_page'] ?? false);
  244.         $container->setParameter('api_platform.collection.pagination.client_partial', $config['defaults']['pagination_client_partial'] ?? false);
  245.         $container->setParameter('api_platform.collection.pagination.items_per_page', $config['defaults']['pagination_items_per_page'] ?? 30);
  246.         $container->setParameter('api_platform.collection.pagination.maximum_items_per_page', $config['defaults']['pagination_maximum_items_per_page'] ?? null);
  247.         $container->setParameter('api_platform.collection.pagination.page_parameter_name', $config['defaults']['pagination_page_parameter_name'] ?? $config['collection']['pagination']['page_parameter_name']);
  248.         $container->setParameter('api_platform.collection.pagination.enabled_parameter_name', $config['defaults']['pagination_enabled_parameter_name'] ?? $config['collection']['pagination']['enabled_parameter_name']);
  249.         $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']);
  250.         $container->setParameter('api_platform.collection.pagination.partial_parameter_name', $config['defaults']['pagination_partial_parameter_name'] ?? $config['collection']['pagination']['partial_parameter_name']);
  251.         $container->setParameter('api_platform.collection.pagination', $this->getPaginationDefaults($config['defaults'] ?? [], $config['collection']['pagination']));
  252.         $container->setParameter('api_platform.handle_symfony_errors', $config['handle_symfony_errors'] ?? false);
  253.         $container->setParameter('api_platform.http_cache.etag', $config['defaults']['cache_headers']['etag'] ?? true);
  254.         $container->setParameter('api_platform.http_cache.max_age', $config['defaults']['cache_headers']['max_age'] ?? null);
  255.         $container->setParameter('api_platform.http_cache.shared_max_age', $config['defaults']['cache_headers']['shared_max_age'] ?? null);
  256.         $container->setParameter('api_platform.http_cache.vary', $config['defaults']['cache_headers']['vary'] ?? ['Accept']);
  257.         $container->setParameter('api_platform.http_cache.public', $config['defaults']['cache_headers']['public'] ?? $config['http_cache']['public']);
  258.         $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']);
  259.         $container->setParameter('api_platform.http_cache.invalidation.xkey.glue', $config['defaults']['cache_headers']['invalidation']['xkey']['glue'] ?? $config['http_cache']['invalidation']['xkey']['glue']);
  261.         $container->setAlias('api_platform.path_segment_name_generator', $config['path_segment_name_generator']);
  263.         if ($config['name_converter']) {
  264.             $container->setAlias('api_platform.name_converter', $config['name_converter']);
  265.         }
  266.         $container->setParameter('api_platform.asset_package', $config['asset_package']);
  267.         $container->setParameter('api_platform.defaults', $this->normalizeDefaults($config['defaults'] ?? []));
  268.         $container->setParameter('api_platform.rfc_7807_compliant_errors', $config['defaults']['extra_properties']['rfc_7807_compliant_errors'] ?? false);
  270.         if ($container->getParameter('kernel.debug')) {
  271.             $container->removeDefinition('api_platform.serializer.mapping.cache_class_metadata_factory');
  272.         }
  273.     }
  275.     /**
  276.      * This method will be removed in 3.0 when "defaults" will be the regular configuration path for the pagination.
  277.      */
  278.     private function getPaginationDefaults(array $defaults, array $collectionPaginationConfiguration): array
  279.     {
  280.         $paginationOptions = [];
  282.         foreach ($defaults as $key => $value) {
  283.             if (!str_starts_with($key, 'pagination_')) {
  284.                 continue;
  285.             }
  287.             $paginationOptions[str_replace('pagination_', '', $key)] = $value;
  288.         }
  290.         return array_merge($collectionPaginationConfiguration, $paginationOptions);
  291.     }
  293.     private function normalizeDefaults(array $defaults): array
  294.     {
  295.         $normalizedDefaults = ['extra_properties' => $defaults['extra_properties'] ?? []];
  296.         unset($defaults['extra_properties']);
  298.         $rc = new \ReflectionClass(ApiResource::class);
  299.         $publicProperties = [];
  300.         foreach ($rc->getConstructor()->getParameters() as $param) {
  301.             $publicProperties[$param->getName()] = true;
  302.         }
  304.         $nameConverter = new CamelCaseToSnakeCaseNameConverter();
  305.         foreach ($defaults as $option => $value) {
  306.             if (isset($publicProperties[$nameConverter->denormalize($option)])) {
  307.                 $normalizedDefaults[$option] = $value;
  309.                 continue;
  310.             }
  312.             $normalizedDefaults['extra_properties'][$option] = $value;
  313.         }
  315.         return $normalizedDefaults;
  316.     }
  318.     private function registerMetadataConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  319.     {
  320.         [$xmlResources, $yamlResources] = $this->getResourcesToWatch($container, $config);
  322.         $container->setParameter('api_platform.class_name_resources', $this->getClassNameResources());
  324.         $loader->load('metadata/resource_name.xml');
  325.         $loader->load('metadata/property_name.xml');
  327.         if (!empty($config['resource_class_directories'])) {
  328.             $container->setParameter('api_platform.resource_class_directories', array_merge(
  329.                 $config['resource_class_directories'],
  330.                 $container->getParameter('api_platform.resource_class_directories')
  331.             ));
  332.         }
  334.         // V3 metadata
  335.         $loader->load('metadata/xml.xml');
  336.         $loader->load('metadata/links.xml');
  337.         $loader->load('metadata/property.xml');
  338.         $loader->load('metadata/resource.xml');
  339.         $loader->load('metadata/operation.xml');
  341.         $container->getDefinition('api_platform.metadata.resource_extractor.xml')->replaceArgument(0, $xmlResources);
  342.         $container->getDefinition('api_platform.metadata.property_extractor.xml')->replaceArgument(0, $xmlResources);
  344.         if (class_exists(PhpDocParser::class) || interface_exists(DocBlockFactoryInterface::class)) {
  345.             $loader->load('metadata/php_doc.xml');
  346.         }
  348.         if (class_exists(Yaml::class)) {
  349.             $loader->load('metadata/yaml.xml');
  350.             $container->getDefinition('api_platform.metadata.resource_extractor.yaml')->replaceArgument(0, $yamlResources);
  351.             $container->getDefinition('api_platform.metadata.property_extractor.yaml')->replaceArgument(0, $yamlResources);
  352.         }
  353.     }
  355.     private function getClassNameResources(): array
  356.     {
  357.         return [
  358.             Error::class,
  359.             ValidationException::class,
  360.         ];
  361.     }
  363.     private function getBundlesResourcesPaths(ContainerBuilder $container, array $config): array
  364.     {
  365.         $bundlesResourcesPaths = [];
  367.         foreach ($container->getParameter('kernel.bundles_metadata') as $bundle) {
  368.             $dirname = $bundle['path'];
  369.             $paths = [
  370.                 "$dirname/ApiResource",
  371.                 "$dirname/src/ApiResource",
  372.             ];
  373.             foreach (['.yaml', '.yml', '.xml', ''] as $extension) {
  374.                 $paths[] = "$dirname/Resources/config/api_resources$extension";
  375.                 $paths[] = "$dirname/config/api_resources$extension";
  376.             }
  377.             if ($this->isConfigEnabled($container, $config['doctrine'])) {
  378.                 $paths[] = "$dirname/Entity";
  379.                 $paths[] = "$dirname/src/Entity";
  380.             }
  381.             if ($this->isConfigEnabled($container, $config['doctrine_mongodb_odm'])) {
  382.                 $paths[] = "$dirname/Document";
  383.                 $paths[] = "$dirname/src/Document";
  384.             }
  386.             foreach ($paths as $path) {
  387.                 if ($container->fileExists($path, false)) {
  388.                     $bundlesResourcesPaths[] = $path;
  389.                 }
  390.             }
  391.         }
  393.         return $bundlesResourcesPaths;
  394.     }
  396.     private function getResourcesToWatch(ContainerBuilder $container, array $config): array
  397.     {
  398.         $paths = array_unique(array_merge($this->getBundlesResourcesPaths($container, $config), $config['mapping']['paths']));
  400.         if (!$config['mapping']['paths']) {
  401.             $projectDir = $container->getParameter('kernel.project_dir');
  402.             foreach (["$projectDir/config/api_platform", "$projectDir/src/ApiResource"] as $dir) {
  403.                 if (is_dir($dir)) {
  404.                     $paths[] = $dir;
  405.                 }
  406.             }
  408.             if ($this->isConfigEnabled($container, $config['doctrine']) && is_dir($doctrinePath = "$projectDir/src/Entity")) {
  409.                 $paths[] = $doctrinePath;
  410.             }
  412.             if ($this->isConfigEnabled($container, $config['doctrine_mongodb_odm']) && is_dir($documentPath = "$projectDir/src/Document")) {
  413.                 $paths[] = $documentPath;
  414.             }
  415.         }
  417.         $resources = ['yml' => [], 'xml' => [], 'dir' => []];
  419.         foreach ($paths as $path) {
  420.             if (is_dir($path)) {
  421.                 foreach (Finder::create()->followLinks()->files()->in($path)->name('/\.(xml|ya?ml)$/')->sortByName() as $file) {
  422.                     $resources['yaml' === ($extension = $file->getExtension()) ? 'yml' : $extension][] = $file->getRealPath();
  423.                 }
  425.                 $resources['dir'][] = $path;
  426.                 $container->addResource(new DirectoryResource($path, '/\.(xml|ya?ml|php)$/'));
  428.                 continue;
  429.             }
  431.             if ($container->fileExists($path, false)) {
  432.                 if (!preg_match('/\.(xml|ya?ml)$/', (string) $path, $matches)) {
  433.                     throw new RuntimeException(sprintf('Unsupported mapping type in "%s", supported types are XML & YAML.', $path));
  434.                 }
  436.                 $resources['yaml' === $matches[1] ? 'yml' : $matches[1]][] = $path;
  438.                 continue;
  439.             }
  441.             throw new RuntimeException(sprintf('Could not open file or directory "%s".', $path));
  442.         }
  444.         $container->setParameter('api_platform.resource_class_directories', $resources['dir']);
  446.         return [$resources['xml'], $resources['yml']];
  447.     }
  449.     private function registerOAuthConfiguration(ContainerBuilder $container, array $config): void
  450.     {
  451.         if (!$config['oauth']) {
  452.             return;
  453.         }
  455.         $container->setParameter('api_platform.oauth.enabled', $this->isConfigEnabled($container, $config['oauth']));
  456.         $container->setParameter('api_platform.oauth.clientId', $config['oauth']['clientId']);
  457.         $container->setParameter('api_platform.oauth.clientSecret', $config['oauth']['clientSecret']);
  458.         $container->setParameter('api_platform.oauth.type', $config['oauth']['type']);
  459.         $container->setParameter('api_platform.oauth.flow', $config['oauth']['flow']);
  460.         $container->setParameter('api_platform.oauth.tokenUrl', $config['oauth']['tokenUrl']);
  461.         $container->setParameter('api_platform.oauth.authorizationUrl', $config['oauth']['authorizationUrl']);
  462.         $container->setParameter('api_platform.oauth.refreshUrl', $config['oauth']['refreshUrl']);
  463.         $container->setParameter('api_platform.oauth.scopes', $config['oauth']['scopes']);
  464.         $container->setParameter('api_platform.oauth.pkce', $config['oauth']['pkce']);
  466.         if ($container->hasDefinition('api_platform.swagger_ui.action')) {
  467.             $container->getDefinition('api_platform.swagger_ui.action')->setArgument(10, $config['oauth']['pkce']);
  468.         }
  469.     }
  471.     /**
  472.      * Registers the Swagger, ReDoc and Swagger UI configuration.
  473.      */
  474.     private function registerSwaggerConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  475.     {
  476.         foreach (array_keys($config['swagger']['api_keys']) as $keyName) {
  477.             if (!preg_match('/^[a-zA-Z0-9._-]+$/', $keyName)) {
  478.                 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));
  479.             }
  480.         }
  482.         $container->setParameter('api_platform.swagger.versions', $config['swagger']['versions']);
  484.         if (!$config['enable_swagger'] && $config['enable_swagger_ui']) {
  485.             throw new RuntimeException('You can not enable the Swagger UI without enabling Swagger, fix this by enabling swagger via the configuration "enable_swagger: true".');
  486.         }
  488.         if (!$config['enable_swagger']) {
  489.             return;
  490.         }
  492.         $loader->load('openapi.xml');
  493.         $loader->load('swagger_ui.xml');
  495.         $loader->load('legacy/swagger_ui.xml');
  497.         if (!$config['enable_swagger_ui'] && !$config['enable_re_doc']) {
  498.             // Remove the listener but keep the controller to allow customizing the path of the UI
  499.             $container->removeDefinition('api_platform.swagger.listener.ui');
  500.         }
  502.         $container->setParameter('api_platform.enable_swagger_ui', $config['enable_swagger_ui']);
  503.         $container->setParameter('api_platform.enable_re_doc', $config['enable_re_doc']);
  504.         $container->setParameter('api_platform.swagger.api_keys', $config['swagger']['api_keys']);
  505.         if ($config['openapi']['swagger_ui_extra_configuration'] && $config['swagger']['swagger_ui_extra_configuration']) {
  506.             throw new RuntimeException('You can not set "swagger_ui_extra_configuration" twice - in "openapi" and "swagger" section.');
  507.         }
  508.         $container->setParameter('api_platform.swagger_ui.extra_configuration', $config['openapi']['swagger_ui_extra_configuration'] ?: $config['swagger']['swagger_ui_extra_configuration']);
  509.     }
  511.     private function registerJsonApiConfiguration(array $formats, XmlFileLoader $loader, array $config): void
  512.     {
  513.         if (!isset($formats['jsonapi'])) {
  514.             return;
  515.         }
  517.         $loader->load('jsonapi.xml');
  518.         $loader->load('legacy/jsonapi.xml');
  519.     }
  521.     private function registerJsonLdHydraConfiguration(ContainerBuilder $container, array $formats, XmlFileLoader $loader, array $config): void
  522.     {
  523.         if (!isset($formats['jsonld'])) {
  524.             return;
  525.         }
  527.         $loader->load('jsonld.xml');
  528.         $loader->load('legacy/hydra.xml');
  529.         $loader->load('hydra.xml');
  531.         if (!$container->has('api_platform.json_schema.schema_factory')) {
  532.             $container->removeDefinition('api_platform.hydra.json_schema.schema_factory');
  533.         }
  535.         if (!$config['enable_docs']) {
  536.             $container->removeDefinition('api_platform.hydra.listener.response.add_link_header');
  537.             $container->removeDefinition('api_platform.hydra.processor.link');
  538.         }
  539.     }
  541.     private function registerJsonHalConfiguration(array $formats, XmlFileLoader $loader): void
  542.     {
  543.         if (!isset($formats['jsonhal'])) {
  544.             return;
  545.         }
  547.         $loader->load('hal.xml');
  548.     }
  550.     private function registerJsonProblemConfiguration(array $errorFormats, XmlFileLoader $loader): void
  551.     {
  552.         if (!isset($errorFormats['jsonproblem'])) {
  553.             return;
  554.         }
  556.         $loader->load('problem.xml');
  557.     }
  559.     private function registerGraphQlConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  560.     {
  561.         $enabled = $this->isConfigEnabled($container, $config['graphql']);
  563.         $graphqlIntrospectionEnabled = $enabled && $this->isConfigEnabled($container, $config['graphql']['introspection']);
  565.         $graphiqlEnabled = $enabled && $this->isConfigEnabled($container, $config['graphql']['graphiql']);
  566.         $graphqlPlayGroundEnabled = $enabled && $this->isConfigEnabled($container, $config['graphql']['graphql_playground']);
  567.         if ($graphqlPlayGroundEnabled) {
  568.             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.');
  569.         }
  571.         $container->setParameter('api_platform.graphql.enabled', $enabled);
  572.         $container->setParameter('api_platform.graphql.introspection.enabled', $graphqlIntrospectionEnabled);
  573.         $container->setParameter('api_platform.graphql.graphiql.enabled', $graphiqlEnabled);
  574.         $container->setParameter('api_platform.graphql.graphql_playground.enabled', $graphqlPlayGroundEnabled);
  575.         $container->setParameter('api_platform.graphql.collection.pagination', $config['graphql']['collection']['pagination']);
  577.         if (!$enabled) {
  578.             return;
  579.         }
  581.         $container->setParameter('api_platform.graphql.default_ide', $config['graphql']['default_ide']);
  582.         $container->setParameter('api_platform.graphql.nesting_separator', $config['graphql']['nesting_separator']);
  584.         $loader->load('graphql.xml');
  586.         // @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
  587.         if (!class_exists(Environment::class) || !isset($container->getParameter('kernel.bundles')['TwigBundle'])) {
  588.             if ($graphiqlEnabled || $graphqlPlayGroundEnabled) {
  589.                 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')));
  590.             }
  591.             $container->removeDefinition('api_platform.graphql.action.graphiql');
  592.             $container->removeDefinition('api_platform.graphql.action.graphql_playground');
  593.         }
  595.         $container->registerForAutoconfiguration(QueryItemResolverInterface::class)
  596.             ->addTag('api_platform.graphql.resolver');
  597.         $container->registerForAutoconfiguration(QueryCollectionResolverInterface::class)
  598.             ->addTag('api_platform.graphql.resolver');
  599.         $container->registerForAutoconfiguration(MutationResolverInterface::class)
  600.             ->addTag('api_platform.graphql.resolver');
  601.         $container->registerForAutoconfiguration(GraphQlTypeInterface::class)
  602.             ->addTag('api_platform.graphql.type');
  603.         $container->registerForAutoconfiguration(ErrorHandlerInterface::class)
  604.             ->addTag('api_platform.graphql.error_handler');
  606.         /* TODO: remove these in 4.x only one resolver factory is used and we're using providers/processors */
  607.         if ($config['event_listeners_backward_compatibility_layer'] ?? true) {
  608.             // @TODO: API Platform 3.3 trigger_deprecation('api-platform/core', '3.3', 'In API Platform 4 only one factory "api_platform.graphql.resolver.factory.item" will remain. Stages are deprecated in favor of using a provider/processor.');
  609.             // + deprecate every service from legacy/graphql.xml
  610.             $loader->load('legacy/graphql.xml');
  612.             if (!$container->getParameter('kernel.debug')) {
  613.                 return;
  614.             }
  616.             $requestStack = new Reference('request_stack', ContainerInterface::NULL_ON_INVALID_REFERENCE);
  617.             $collectionDataCollectorResolverFactory = (new Definition(DataCollectorResolverFactory::class))
  618.                 ->setDecoratedService('api_platform.graphql.resolver.factory.collection')
  619.                 ->setArguments([new Reference('api_platform.graphql.data_collector.resolver.factory.collection.inner'), $requestStack]);
  621.             $itemDataCollectorResolverFactory = (new Definition(DataCollectorResolverFactory::class))
  622.                 ->setDecoratedService('api_platform.graphql.resolver.factory.item')
  623.                 ->setArguments([new Reference('api_platform.graphql.data_collector.resolver.factory.item.inner'), $requestStack]);
  625.             $itemMutationDataCollectorResolverFactory = (new Definition(DataCollectorResolverFactory::class))
  626.                 ->setDecoratedService('api_platform.graphql.resolver.factory.item_mutation')
  627.                 ->setArguments([new Reference('api_platform.graphql.data_collector.resolver.factory.item_mutation.inner'), $requestStack]);
  629.             $itemSubscriptionDataCollectorResolverFactory = (new Definition(DataCollectorResolverFactory::class))
  630.                 ->setDecoratedService('api_platform.graphql.resolver.factory.item_subscription')
  631.                 ->setArguments([new Reference('api_platform.graphql.data_collector.resolver.factory.item_subscription.inner'), $requestStack]);
  633.             $container->addDefinitions([
  634.                 'api_platform.graphql.data_collector.resolver.factory.collection' => $collectionDataCollectorResolverFactory,
  635.                 'api_platform.graphql.data_collector.resolver.factory.item' => $itemDataCollectorResolverFactory,
  636.                 'api_platform.graphql.data_collector.resolver.factory.item_mutation' => $itemMutationDataCollectorResolverFactory,
  637.                 'api_platform.graphql.data_collector.resolver.factory.item_subscription' => $itemSubscriptionDataCollectorResolverFactory,
  638.             ]);
  639.         }
  640.     }
  642.     private function registerCacheConfiguration(ContainerBuilder $container): void
  643.     {
  644.         if (!$container->hasParameter('kernel.debug') || !$container->getParameter('kernel.debug')) {
  645.             $container->removeDefinition('api_platform.cache_warmer.cache_pool_clearer');
  646.         }
  647.     }
  649.     private function registerDoctrineOrmConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  650.     {
  651.         if (!$this->isConfigEnabled($container, $config['doctrine'])) {
  652.             return;
  653.         }
  655.         // For older versions of doctrine bridge this allows autoconfiguration for filters
  656.         if (!$container->has(ManagerRegistry::class)) {
  657.             $container->setAlias(ManagerRegistry::class, 'doctrine');
  658.         }
  660.         $container->registerForAutoconfiguration(QueryItemExtensionInterface::class)
  661.             ->addTag('api_platform.doctrine.orm.query_extension.item');
  662.         $container->registerForAutoconfiguration(DoctrineQueryCollectionExtensionInterface::class)
  663.             ->addTag('api_platform.doctrine.orm.query_extension.collection');
  664.         $container->registerForAutoconfiguration(DoctrineOrmAbstractFilter::class);
  666.         $container->registerForAutoconfiguration(OrmLinksHandlerInterface::class)
  667.             ->addTag('api_platform.doctrine.orm.links_handler');
  669.         $loader->load('doctrine_orm.xml');
  671.         if ($this->isConfigEnabled($container, $config['eager_loading'])) {
  672.             return;
  673.         }
  675.         $container->removeAlias(EagerLoadingExtension::class);
  676.         $container->removeDefinition('api_platform.doctrine.orm.query_extension.eager_loading');
  677.         $container->removeAlias(FilterEagerLoadingExtension::class);
  678.         $container->removeDefinition('api_platform.doctrine.orm.query_extension.filter_eager_loading');
  679.     }
  681.     private function registerDoctrineMongoDbOdmConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  682.     {
  683.         if (!$this->isConfigEnabled($container, $config['doctrine_mongodb_odm'])) {
  684.             return;
  685.         }
  687.         $container->registerForAutoconfiguration(AggregationItemExtensionInterface::class)
  688.             ->addTag('api_platform.doctrine_mongodb.odm.aggregation_extension.item');
  689.         $container->registerForAutoconfiguration(AggregationCollectionExtensionInterface::class)
  690.             ->addTag('api_platform.doctrine_mongodb.odm.aggregation_extension.collection');
  691.         $container->registerForAutoconfiguration(DoctrineMongoDbOdmAbstractFilter::class)
  692.             ->setBindings(['$managerRegistry' => new Reference('doctrine_mongodb')]);
  693.         $container->registerForAutoconfiguration(OdmLinksHandlerInterface::class)
  694.             ->addTag('api_platform.doctrine.odm.links_handler');
  696.         $loader->load('doctrine_mongodb_odm.xml');
  697.     }
  699.     private function registerHttpCacheConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  700.     {
  701.         $loader->load('http_cache.xml');
  702.         $loader->load('legacy/http_cache.xml');
  704.         if (!$this->isConfigEnabled($container, $config['http_cache']['invalidation'])) {
  705.             return;
  706.         }
  708.         if ($this->isConfigEnabled($container, $config['doctrine'])) {
  709.             $loader->load('doctrine_orm_http_cache_purger.xml');
  710.         }
  712.         $loader->load('http_cache_purger.xml');
  713.         $loader->load('legacy/http_cache_purger.xml');
  715.         foreach ($config['http_cache']['invalidation']['scoped_clients'] as $client) {
  716.             $definition = $container->getDefinition($client);
  717.             $definition->addTag('api_platform.http_cache.http_client');
  718.         }
  720.         if (!($urls = $config['http_cache']['invalidation']['urls'])) {
  721.             $urls = $config['http_cache']['invalidation']['varnish_urls'];
  722.         }
  724.         foreach ($urls as $key => $url) {
  725.             $definition = new Definition(ScopingHttpClient::class, [new Reference('http_client'), $url, ['base_uri' => $url] + $config['http_cache']['invalidation']['request_options']]);
  726.             $definition->setFactory([ScopingHttpClient::class, 'forBaseUri']);
  727.             $definition->addTag('api_platform.http_cache.http_client');
  728.             $container->setDefinition('api_platform.invalidation_http_client.'.$key, $definition);
  729.         }
  731.         $serviceName = $config['http_cache']['invalidation']['purger'];
  733.         if (!$container->hasDefinition('api_platform.http_cache.purger')) {
  734.             $container->setAlias('api_platform.http_cache.purger', $serviceName);
  735.         }
  736.     }
  738.     /**
  739.      * Normalizes the format from config to the one accepted by Symfony HttpFoundation.
  740.      */
  741.     private function getFormats(array $configFormats): array
  742.     {
  743.         $formats = [];
  744.         foreach ($configFormats as $format => $value) {
  745.             foreach ($value['mime_types'] as $mimeType) {
  746.                 $formats[$format][] = $mimeType;
  747.             }
  748.         }
  750.         return $formats;
  751.     }
  753.     private function registerValidatorConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  754.     {
  755.         if (interface_exists(ValidatorInterface::class)) {
  756.             $loader->load('metadata/validator.xml');
  757.             $loader->load('symfony/validator.xml');
  759.             if ($this->isConfigEnabled($container, $config['graphql'])) {
  760.                 $loader->load('graphql/validator.xml');
  761.             }
  763.             $container->registerForAutoconfiguration(ValidationGroupsGeneratorInterface::class)
  764.                 ->addTag('api_platform.validation_groups_generator');
  765.             $container->registerForAutoconfiguration(PropertySchemaRestrictionMetadataInterface::class)
  766.                 ->addTag('api_platform.metadata.property_schema_restriction');
  768.             $loader->load('legacy/validator.xml');
  769.         }
  771.         if (!$config['validator']) {
  772.             return;
  773.         }
  775.         $container->setParameter('api_platform.validator.serialize_payload_fields', $config['validator']['serialize_payload_fields']);
  776.         $container->setParameter('api_platform.validator.query_parameter_validation', $config['validator']['query_parameter_validation']);
  778.         if (!$config['validator']['query_parameter_validation']) {
  779.             $container->removeDefinition('api_platform.listener.view.validate_query_parameters');
  780.             $container->removeDefinition('api_platform.validator.query_parameter_validator');
  781.         }
  782.     }
  784.     private function registerDataCollectorConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  785.     {
  786.         if (!$config['enable_profiler']) {
  787.             return;
  788.         }
  790.         $loader->load('data_collector.xml');
  792.         if ($container->hasParameter('kernel.debug') && $container->getParameter('kernel.debug')) {
  793.             $loader->load('debug.xml');
  794.         }
  795.     }
  797.     private function registerMercureConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  798.     {
  799.         if (!$this->isConfigEnabled($container, $config['mercure'])) {
  800.             return;
  801.         }
  803.         $container->setParameter('api_platform.mercure.include_type', $config['mercure']['include_type']);
  805.         $loader->load('legacy/mercure.xml');
  806.         $loader->load('mercure.xml');
  808.         if ($this->isConfigEnabled($container, $config['doctrine'])) {
  809.             $loader->load('doctrine_orm_mercure_publisher.xml');
  810.         }
  811.         if ($this->isConfigEnabled($container, $config['doctrine_mongodb_odm'])) {
  812.             $loader->load('doctrine_odm_mercure_publisher.xml');
  813.         }
  815.         if ($this->isConfigEnabled($container, $config['graphql'])) {
  816.             $loader->load('graphql_mercure.xml');
  817.         }
  818.     }
  820.     private function registerMessengerConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  821.     {
  822.         if (!$this->isConfigEnabled($container, $config['messenger'])) {
  823.             return;
  824.         }
  826.         $loader->load('messenger.xml');
  827.     }
  829.     private function registerElasticsearchConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  830.     {
  831.         $enabled = $this->isConfigEnabled($container, $config['elasticsearch']);
  833.         $container->setParameter('api_platform.elasticsearch.enabled', $enabled);
  835.         if (!$enabled) {
  836.             return;
  837.         }
  839.         $clientClass = class_exists(\Elasticsearch\Client::class) ? \Elasticsearch\Client::class : \Elastic\Elasticsearch\Client::class;
  841.         $clientDefinition = new Definition($clientClass);
  842.         $container->setDefinition('api_platform.elasticsearch.client', $clientDefinition);
  843.         $container->registerForAutoconfiguration(RequestBodySearchCollectionExtensionInterface::class)
  844.             ->addTag('api_platform.elasticsearch.request_body_search_extension.collection');
  845.         $container->setParameter('api_platform.elasticsearch.hosts', $config['elasticsearch']['hosts']);
  846.         $loader->load('elasticsearch.xml');
  848.         // @phpstan-ignore-next-line
  849.         if (\Elasticsearch\Client::class === $clientClass) {
  850.             $loader->load('legacy/elasticsearch.xml');
  851.             $container->setParameter('api_platform.elasticsearch.mapping', $config['elasticsearch']['mapping']);
  852.             $container->setDefinition('api_platform.elasticsearch.client_for_metadata', $clientDefinition);
  853.         }
  854.     }
  856.     private function registerSecurityConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  857.     {
  858.         /** @var string[] $bundles */
  859.         $bundles = $container->getParameter('kernel.bundles');
  861.         if (!isset($bundles['SecurityBundle'])) {
  862.             return;
  863.         }
  865.         $loader->load('security.xml');
  866.         $loader->load('legacy/security.xml');
  868.         if (interface_exists(ValidatorInterface::class)) {
  869.             $loader->load('symfony/security_validator.xml');
  870.         }
  872.         if ($this->isConfigEnabled($container, $config['graphql'])) {
  873.             $loader->load('graphql/security.xml');
  874.         }
  875.     }
  877.     private function registerOpenApiConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  878.     {
  879.         $container->setParameter('api_platform.openapi.termsOfService', $config['openapi']['termsOfService']);
  880.         $container->setParameter('api_platform.openapi.contact.name', $config['openapi']['contact']['name']);
  881.         $container->setParameter('api_platform.openapi.contact.url', $config['openapi']['contact']['url']);
  882.         $container->setParameter('api_platform.openapi.contact.email', $config['openapi']['contact']['email']);
  883.         $container->setParameter('api_platform.openapi.license.name', $config['openapi']['license']['name']);
  884.         $container->setParameter('api_platform.openapi.license.url', $config['openapi']['license']['url']);
  886.         $loader->load('json_schema.xml');
  887.     }
  889.     private function registerMakerConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void
  890.     {
  891.         if (!$this->isConfigEnabled($container, $config['maker'])) {
  892.             return;
  893.         }
  895.         $loader->load('maker.xml');
  896.     }
  898.     private function registerArgumentResolverConfiguration(XmlFileLoader $loader): void
  899.     {
  900.         $loader->load('argument_resolver.xml');
  901.     }
  903.     private function registerInflectorConfiguration(array $config): void
  904.     {
  905.         if ($config['keep_legacy_inflector']) {
  906.             Inflector::keepLegacyInflector(true);
  907.             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.');
  908.         } else {
  909.             Inflector::keepLegacyInflector(false);
  910.         }
  911.     }
  912. }