vendor/api-platform/core/src/Symfony/Bundle/DependencyInjection/Configuration.php line 570

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <[email protected]>
  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\Core\Annotation\ApiResource as LegacyApiResource;
  17. use ApiPlatform\Doctrine\Common\Filter\OrderFilterInterface;
  18. use ApiPlatform\Elasticsearch\Metadata\Document\DocumentMetadata;
  19. use ApiPlatform\Exception\FilterValidationException;
  20. use ApiPlatform\Exception\InvalidArgumentException;
  21. use ApiPlatform\Metadata\ApiResource;
  22. use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
  23. use Doctrine\Bundle\MongoDBBundle\DoctrineMongoDBBundle;
  24. use Doctrine\ORM\EntityManagerInterface;
  25. use Doctrine\ORM\OptimisticLockException;
  26. use Elasticsearch\Client as ElasticsearchClient;
  27. use FOS\UserBundle\FOSUserBundle;
  28. use GraphQL\GraphQL;
  29. use Symfony\Bundle\FullStack;
  30. use Symfony\Bundle\MakerBundle\MakerBundle;
  31. use Symfony\Bundle\MercureBundle\MercureBundle;
  32. use Symfony\Bundle\TwigBundle\TwigBundle;
  33. use Symfony\Component\Config\Definition\BaseNode;
  34. use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
  35. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  36. use Symfony\Component\Config\Definition\ConfigurationInterface;
  37. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  38. use Symfony\Component\HttpFoundation\Response;
  39. use Symfony\Component\Messenger\MessageBusInterface;
  40. use Symfony\Component\Serializer\Exception\ExceptionInterface as SerializerExceptionInterface;
  41. use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
  43. /**
  44.  * The configuration of the bundle.
  45.  *
  46.  * @author Kévin Dunglas <[email protected]>
  47.  * @author Baptiste Meyer <[email protected]>
  48.  */
  49. final class Configuration implements ConfigurationInterface
  50. {
  51.     /**
  52.      * {@inheritdoc}
  53.      */
  54.     public function getConfigTreeBuilder(): TreeBuilder
  55.     {
  56.         if (method_exists(TreeBuilder::class, 'getRootNode')) {
  57.             $treeBuilder = new TreeBuilder('api_platform');
  58.             $rootNode = $treeBuilder->getRootNode();
  59.         } else {
  60.             $treeBuilder = new TreeBuilder();
  61.             $rootNode = $treeBuilder->root('api_platform');
  62.         }
  64.         $rootNode
  65.             ->beforeNormalization()
  66.                 ->ifTrue(static function ($v) {
  67.                     return false === ($v['enable_swagger'] ?? null);
  68.                 })
  69.                 ->then(static function ($v) {
  70.                     $v['swagger']['versions'] = [];
  72.                     return $v;
  73.                 })
  74.             ->end()
  75.             ->children()
  76.                 ->scalarNode('title')
  77.                     ->info('The title of the API.')
  78.                     ->cannotBeEmpty()
  79.                     ->defaultValue('')
  80.                 ->end()
  81.                 ->scalarNode('description')
  82.                     ->info('The description of the API.')
  83.                     ->cannotBeEmpty()
  84.                     ->defaultValue('')
  85.                 ->end()
  86.                 ->scalarNode('version')
  87.                     ->info('The version of the API.')
  88.                     ->cannotBeEmpty()
  89.                     ->defaultValue('0.0.0')
  90.                 ->end()
  91.                 ->booleanNode('show_webby')->defaultTrue()->info('If true, show Webby on the documentation page')->end()
  92.                 ->booleanNode('metadata_backward_compatibility_layer')->defaultTrue()->info('If true, declared services are using legacy interfaces for the following services: "api_platform.iri_converter", "api_platform.openapi.factory", "api_platform.identifiers_extractor".')->end()
  93.                 ->scalarNode('default_operation_path_resolver')
  94.                     ->defaultValue('api_platform.operation_path_resolver.underscore')
  95.                     ->setDeprecated(...$this->buildDeprecationArgs('2.1', 'The use of the `default_operation_path_resolver` has been deprecated in 2.1 and will be removed in 3.0. Use `path_segment_name_generator` instead.'))
  96.                     ->info('Specify the default operation path resolver to use for generating resources operations path.')
  97.                 ->end()
  98.                 ->scalarNode('name_converter')->defaultNull()->info('Specify a name converter to use.')->end()
  99.                 ->scalarNode('asset_package')->defaultNull()->info('Specify an asset package name to use.')->end()
  100.                 ->scalarNode('path_segment_name_generator')->defaultValue('api_platform.path_segment_name_generator.underscore')->info('Specify a path name generator to use.')->end()
  101.                 ->booleanNode('allow_plain_identifiers')
  102.                     ->defaultFalse()
  103.                     ->info('Allow plain identifiers, for example "id" instead of "@id" when denormalizing a relation.')
  104.                     ->setDeprecated(...$this->buildDeprecationArgs('2.7', 'The use of `allow_plain_identifiers` has been deprecated in 2.7 and will be removed in 3.0.'))
  105.                 ->end()
  106.                 ->arrayNode('validator')
  107.                     ->addDefaultsIfNotSet()
  108.                     ->children()
  109.                         ->variableNode('serialize_payload_fields')->defaultValue([])->info('Set to null to serialize all payload fields when a validation error is thrown, or set the fields you want to include explicitly.')->end()
  110.                         ->booleanNode('query_parameter_validation')->defaultValue(true)->end()
  111.                     ->end()
  112.                 ->end()
  113.                 ->arrayNode('eager_loading')
  114.                     ->canBeDisabled()
  115.                     ->addDefaultsIfNotSet()
  116.                     ->children()
  117.                         ->booleanNode('fetch_partial')->defaultFalse()->info('Fetch only partial data according to serialization groups. If enabled, Doctrine ORM entities will not work as expected if any of the other fields are used.')->end()
  118.                         ->integerNode('max_joins')->defaultValue(30)->info('Max number of joined relations before EagerLoading throws a RuntimeException')->end()
  119.                         ->booleanNode('force_eager')->defaultTrue()->info('Force join on every relation. If disabled, it will only join relations having the EAGER fetch mode.')->end()
  120.                     ->end()
  121.                 ->end()
  122.                 ->booleanNode('enable_fos_user')
  123.                     ->defaultValue(class_exists(FOSUserBundle::class))
  124.                     ->setDeprecated(...$this->buildDeprecationArgs('2.5', 'FOSUserBundle is not actively maintained anymore. Enabling the FOSUserBundle integration has been deprecated in 2.5 and will be removed in 3.0.'))
  125.                     ->info('Enable the FOSUserBundle integration.')
  126.                 ->end()
  127.                 ->booleanNode('enable_nelmio_api_doc')
  128.                     ->defaultFalse()
  129.                     ->setDeprecated(...$this->buildDeprecationArgs('2.2', 'Enabling the NelmioApiDocBundle integration has been deprecated in 2.2 and will be removed in 3.0. NelmioApiDocBundle 3 has native support for API Platform.'))
  130.                     ->info('Enable the NelmioApiDocBundle integration.')
  131.                 ->end()
  132.                 ->booleanNode('enable_swagger')->defaultTrue()->info('Enable the Swagger documentation and export.')->end()
  133.                 ->booleanNode('enable_swagger_ui')->defaultValue(class_exists(TwigBundle::class))->info('Enable Swagger UI')->end()
  134.                 ->booleanNode('enable_re_doc')->defaultValue(class_exists(TwigBundle::class))->info('Enable ReDoc')->end()
  135.                 ->booleanNode('enable_entrypoint')->defaultTrue()->info('Enable the entrypoint')->end()
  136.                 ->booleanNode('enable_docs')->defaultTrue()->info('Enable the docs')->end()
  137.                 ->booleanNode('enable_profiler')->defaultTrue()->info('Enable the data collector and the WebProfilerBundle integration.')->end()
  138.                 ->arrayNode('collection')
  139.                     ->addDefaultsIfNotSet()
  140.                     ->children()
  141.                         ->scalarNode('exists_parameter_name')->defaultValue('exists')->cannotBeEmpty()->info('The name of the query parameter to filter on nullable field values.')->end()
  142.                         ->scalarNode('order')->defaultValue('ASC')->info('The default order of results.')->end() // Default ORDER is required for postgresql and mysql >= 5.7 when using LIMIT/OFFSET request
  143.                         ->scalarNode('order_parameter_name')->defaultValue('order')->cannotBeEmpty()->info('The name of the query parameter to order results.')->end()
  144.                         ->enumNode('order_nulls_comparison')->defaultNull()->values(array_merge(array_keys(OrderFilterInterface::NULLS_DIRECTION_MAP), [null]))->info('The nulls comparison strategy.')->end()
  145.                         ->arrayNode('pagination')
  146.                             ->canBeDisabled()
  147.                             ->addDefaultsIfNotSet()
  148.                             ->children()
  149.                                 ->booleanNode('enabled')
  150.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.enabled` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_enabled` instead.'))
  151.                                     ->defaultTrue()
  152.                                     ->info('To enable or disable pagination for all resource collections by default.')
  153.                                 ->end()
  154.                                 ->booleanNode('partial')
  155.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.partial` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_partial` instead.'))
  156.                                     ->defaultFalse()
  157.                                     ->info('To enable or disable partial pagination for all resource collections by default when pagination is enabled.')
  158.                                 ->end()
  159.                                 ->booleanNode('client_enabled')
  160.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.client_enabled` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_client_enabled` instead.'))
  161.                                     ->defaultFalse()
  162.                                     ->info('To allow the client to enable or disable the pagination.')
  163.                                 ->end()
  164.                                 ->booleanNode('client_items_per_page')
  165.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.client_items_per_page` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_client_items_per_page` instead.'))
  166.                                     ->defaultFalse()
  167.                                     ->info('To allow the client to set the number of items per page.')
  168.                                 ->end()
  169.                                 ->booleanNode('client_partial')
  170.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.client_partial` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_client_partial` instead.'))
  171.                                     ->defaultFalse()
  172.                                     ->info('To allow the client to enable or disable partial pagination.')
  173.                                 ->end()
  174.                                 ->integerNode('items_per_page')
  175.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.items_per_page` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_items_per_page` instead.'))
  176.                                     ->defaultValue(30)
  177.                                     ->info('The default number of items per page.')
  178.                                 ->end()
  179.                                 ->integerNode('maximum_items_per_page')
  180.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.maximum_items_per_page` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_maximum_items_per_page` instead.'))
  181.                                     ->defaultNull()
  182.                                     ->info('The maximum number of items per page.')
  183.                                 ->end()
  184.                                 ->scalarNode('page_parameter_name')->defaultValue('page')->cannotBeEmpty()->info('The default name of the parameter handling the page number.')->end()
  185.                                 ->scalarNode('enabled_parameter_name')->defaultValue('pagination')->cannotBeEmpty()->info('The name of the query parameter to enable or disable pagination.')->end()
  186.                                 ->scalarNode('items_per_page_parameter_name')->defaultValue('itemsPerPage')->cannotBeEmpty()->info('The name of the query parameter to set the number of items per page.')->end()
  187.                                 ->scalarNode('partial_parameter_name')->defaultValue('partial')->cannotBeEmpty()->info('The name of the query parameter to enable or disable partial pagination.')->end()
  188.                             ->end()
  189.                         ->end()
  190.                     ->end()
  191.                 ->end()
  192.                 ->arrayNode('mapping')
  193.                     ->addDefaultsIfNotSet()
  194.                     ->children()
  195.                         ->arrayNode('paths')
  196.                             ->prototype('scalar')->end()
  197.                         ->end()
  198.                     ->end()
  199.                 ->end()
  200.                 ->arrayNode('resource_class_directories')
  201.                     ->prototype('scalar')->end()
  202.                 ->end()
  203.             ->end();
  205.         $this->addDoctrineOrmSection($rootNode);
  206.         $this->addDoctrineMongoDbOdmSection($rootNode);
  207.         $this->addOAuthSection($rootNode);
  208.         $this->addGraphQlSection($rootNode);
  209.         $this->addSwaggerSection($rootNode);
  210.         $this->addHttpCacheSection($rootNode);
  211.         $this->addMercureSection($rootNode);
  212.         $this->addMessengerSection($rootNode);
  213.         $this->addElasticsearchSection($rootNode);
  214.         $this->addOpenApiSection($rootNode);
  215.         $this->addMakerSection($rootNode);
  217.         $this->addExceptionToStatusSection($rootNode);
  219.         $this->addFormatSection($rootNode, 'formats', [
  220.             'jsonld' => ['mime_types' => ['application/ld+json']],
  221.             'json' => ['mime_types' => ['application/json']], // Swagger support
  222.             'html' => ['mime_types' => ['text/html']], // Swagger UI support
  223.         ]);
  224.         $this->addFormatSection($rootNode, 'patch_formats', []);
  225.         $this->addFormatSection($rootNode, 'error_formats', [
  226.             'jsonproblem' => ['mime_types' => ['application/problem+json']],
  227.             'jsonld' => ['mime_types' => ['application/ld+json']],
  228.         ]);
  230.         $this->addDefaultsSection($rootNode);
  232.         return $treeBuilder;
  233.     }
  235.     private function addDoctrineOrmSection(ArrayNodeDefinition $rootNode): void
  236.     {
  237.         $rootNode
  238.             ->children()
  239.                 ->arrayNode('doctrine')
  240.                     ->{class_exists(DoctrineBundle::class) && interface_exists(EntityManagerInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  241.                 ->end()
  242.             ->end();
  243.     }
  245.     private function addDoctrineMongoDbOdmSection(ArrayNodeDefinition $rootNode): void
  246.     {
  247.         $rootNode
  248.             ->children()
  249.                 ->arrayNode('doctrine_mongodb_odm')
  250.                     ->{class_exists(DoctrineMongoDBBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  251.                 ->end()
  252.             ->end();
  253.     }
  255.     private function addOAuthSection(ArrayNodeDefinition $rootNode): void
  256.     {
  257.         $rootNode
  258.             ->children()
  259.                 ->arrayNode('oauth')
  260.                     ->canBeEnabled()
  261.                     ->addDefaultsIfNotSet()
  262.                     ->children()
  263.                         ->scalarNode('clientId')->defaultValue('')->info('The oauth client id.')->end()
  264.                         ->scalarNode('clientSecret')
  265.                             ->defaultValue('')
  266.                             ->info('The OAuth client secret. Never use this parameter in your production environment. It exposes crucial security information. This feature is intended for dev/test environments only. Enable "oauth.pkce" instead')
  267.                         ->end()
  268.                         ->booleanNode('pkce')->defaultFalse()->info('Enable the oauth PKCE.')->end()
  269.                         ->scalarNode('type')->defaultValue('oauth2')->info('The oauth type.')->end()
  270.                         ->scalarNode('flow')->defaultValue('application')->info('The oauth flow grant type.')->end()
  271.                         ->scalarNode('tokenUrl')->defaultValue('')->info('The oauth token url.')->end()
  272.                         ->scalarNode('authorizationUrl')->defaultValue('')->info('The oauth authentication url.')->end()
  273.                         ->scalarNode('refreshUrl')->defaultValue('')->info('The oauth refresh url.')->end()
  274.                         ->arrayNode('scopes')
  275.                             ->prototype('scalar')->end()
  276.                         ->end()
  277.                     ->end()
  278.                 ->end()
  279.             ->end();
  280.     }
  282.     private function addGraphQlSection(ArrayNodeDefinition $rootNode): void
  283.     {
  284.         $rootNode
  285.             ->children()
  286.                 ->arrayNode('graphql')
  287.                     ->{class_exists(GraphQL::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  288.                     ->addDefaultsIfNotSet()
  289.                     ->children()
  290.                         ->scalarNode('default_ide')->defaultValue('graphiql')->end()
  291.                         ->arrayNode('graphiql')
  292.                             ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  293.                         ->end()
  294.                         ->arrayNode('graphql_playground')
  295.                             ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  296.                         ->end()
  297.                         ->scalarNode('nesting_separator')->defaultValue('_')->info('The separator to use to filter nested fields.')->end()
  298.                         ->arrayNode('collection')
  299.                             ->addDefaultsIfNotSet()
  300.                             ->children()
  301.                                 ->arrayNode('pagination')
  302.                                     ->canBeDisabled()
  303.                                 ->end()
  304.                             ->end()
  305.                         ->end()
  306.                     ->end()
  307.                 ->end()
  308.             ->end();
  309.     }
  311.     private function addSwaggerSection(ArrayNodeDefinition $rootNode): void
  312.     {
  313.         $defaultVersions = [2, 3];
  315.         $rootNode
  316.             ->children()
  317.                 ->arrayNode('swagger')
  318.                     ->addDefaultsIfNotSet()
  319.                     ->children()
  320.                         ->arrayNode('versions')
  321.                             ->info('The active versions of Open API to be exported or used in the swagger_ui. The first value is the default.')
  322.                             ->defaultValue($defaultVersions)
  323.                             ->beforeNormalization()
  324.                                 ->always(static function ($v) {
  325.                                     if (!\is_array($v)) {
  326.                                         $v = [$v];
  327.                                     }
  329.                                     foreach ($v as &$version) {
  330.                                         $version = (int) $version;
  331.                                     }
  333.                                     return $v;
  334.                                 })
  335.                             ->end()
  336.                             ->validate()
  337.                                 ->ifTrue(static function ($v) use ($defaultVersions) {
  338.                                     return $v !== array_intersect($v, $defaultVersions);
  339.                                 })
  340.                                 ->thenInvalid(sprintf('Only the versions %s are supported. Got %s.', implode(' and ', $defaultVersions), '%s'))
  341.                             ->end()
  342.                             ->prototype('scalar')->end()
  343.                         ->end()
  344.                         ->arrayNode('api_keys')
  345.                             ->prototype('array')
  346.                                 ->children()
  347.                                     ->scalarNode('name')
  348.                                         ->info('The name of the header or query parameter containing the api key.')
  349.                                     ->end()
  350.                                     ->enumNode('type')
  351.                                         ->info('Whether the api key should be a query parameter or a header.')
  352.                                         ->values(['query', 'header'])
  353.                                     ->end()
  354.                                 ->end()
  355.                             ->end()
  356.                         ->end()
  357.                         ->variableNode('swagger_ui_extra_configuration')
  358.                             ->defaultValue([])
  359.                             ->validate()
  360.                                 ->ifTrue(static function ($v) { return false === \is_array($v); })
  361.                                 ->thenInvalid('The swagger_ui_extra_configuration parameter must be an array.')
  362.                             ->end()
  363.                             ->info('To pass extra configuration to Swagger UI, like docExpansion or filter.')
  364.                         ->end()
  365.                     ->end()
  366.                 ->end()
  367.             ->end();
  368.     }
  370.     private function addHttpCacheSection(ArrayNodeDefinition $rootNode): void
  371.     {
  372.         $rootNode
  373.             ->children()
  374.                 ->arrayNode('http_cache')
  375.                     ->addDefaultsIfNotSet()
  376.                     ->children()
  377.                         ->booleanNode('etag')
  378.                             ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `http_cache.etag` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.cache_headers.etag` instead.'))
  379.                             ->defaultTrue()
  380.                             ->info('Automatically generate etags for API responses.')
  381.                         ->end()
  382.                         ->integerNode('max_age')
  383.                             ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `http_cache.max_age` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.cache_headers.max_age` instead.'))
  384.                             ->defaultNull()
  385.                             ->info('Default value for the response max age.')
  386.                         ->end()
  387.                         ->integerNode('shared_max_age')
  388.                             ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `http_cache.shared_max_age` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.cache_headers.shared_max_age` instead.'))
  389.                             ->defaultNull()
  390.                             ->info('Default value for the response shared (proxy) max age.')
  391.                         ->end()
  392.                         ->arrayNode('vary')
  393.                             ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `http_cache.vary` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.cache_headers.vary` instead.'))
  394.                             ->defaultValue(['Accept'])
  395.                             ->prototype('scalar')->end()
  396.                             ->info('Default values of the "Vary" HTTP header.')
  397.                         ->end()
  398.                         ->booleanNode('public')->defaultNull()->info('To make all responses public by default.')->end()
  399.                         ->arrayNode('invalidation')
  400.                             ->info('Enable the tags-based cache invalidation system.')
  401.                             ->canBeEnabled()
  402.                             ->children()
  403.                                 ->arrayNode('varnish_urls')
  404.                                     ->defaultValue([])
  405.                                     ->prototype('scalar')->end()
  406.                                     ->info('URLs of the Varnish servers to purge using cache tags when a resource is updated.')
  407.                                 ->end()
  408.                                 ->integerNode('max_header_length')
  409.                                     ->defaultValue(7500)
  410.                                     ->info('Max header length supported by the server')
  411.                                 ->end()
  412.                                 ->variableNode('request_options')
  413.                                     ->defaultValue([])
  414.                                     ->validate()
  415.                                         ->ifTrue(static function ($v) { return false === \is_array($v); })
  416.                                         ->thenInvalid('The request_options parameter must be an array.')
  417.                                     ->end()
  418.                                     ->info('To pass options to the client charged with the request.')
  419.                                 ->end()
  420.                                 ->scalarNode('purger')
  421.                                     ->defaultValue('api_platform.http_cache.purger.varnish')
  422.                                     ->info('Specify a varnish purger to use (available values: "api_platform.http_cache.purger.varnish.ban" or "api_platform.http_cache.purger.varnish.xkey").')
  423.                                 ->end()
  424.                                 ->arrayNode('xkey')
  425.                                     ->addDefaultsIfNotSet()
  426.                                     ->children()
  427.                                         ->scalarNode('glue')
  428.                                         ->defaultValue(' ')
  429.                                         ->info('xkey glue between keys')
  430.                                         ->end()
  431.                                     ->end()
  432.                                 ->end()
  433.                             ->end()
  434.                         ->end()
  435.                     ->end()
  436.                 ->end()
  437.             ->end();
  438.     }
  440.     private function addMercureSection(ArrayNodeDefinition $rootNode): void
  441.     {
  442.         $rootNode
  443.             ->children()
  444.                 ->arrayNode('mercure')
  445.                     ->{class_exists(MercureBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  446.                     ->children()
  447.                         ->scalarNode('hub_url')
  448.                             ->defaultNull()
  449.                             ->info('The URL sent in the Link HTTP header. If not set, will default to the URL for MercureBundle\'s default hub.')
  450.                         ->end()
  451.                     ->end()
  452.                 ->end()
  453.             ->end();
  454.     }
  456.     private function addMessengerSection(ArrayNodeDefinition $rootNode): void
  457.     {
  458.         $rootNode
  459.             ->children()
  460.                 ->arrayNode('messenger')
  461.                     ->{!class_exists(FullStack::class) && interface_exists(MessageBusInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  462.                 ->end()
  463.             ->end();
  464.     }
  466.     private function addElasticsearchSection(ArrayNodeDefinition $rootNode): void
  467.     {
  468.         $rootNode
  469.             ->children()
  470.                 ->arrayNode('elasticsearch')
  471.                     ->canBeEnabled()
  472.                     ->addDefaultsIfNotSet()
  473.                     ->children()
  474.                         ->booleanNode('enabled')
  475.                             ->defaultFalse()
  476.                             ->validate()
  477.                                 ->ifTrue()
  478.                                 ->then(static function (bool $v): bool {
  479.                                     if (!class_exists(ElasticsearchClient::class)) {
  480.                                         throw new InvalidConfigurationException('The elasticsearch/elasticsearch package is required for Elasticsearch support.');
  481.                                     }
  483.                                     return $v;
  484.                                 })
  485.                             ->end()
  486.                         ->end()
  487.                         ->arrayNode('hosts')
  488.                             ->beforeNormalization()->castToArray()->end()
  489.                             ->defaultValue([])
  490.                             ->prototype('scalar')->end()
  491.                         ->end()
  492.                         ->arrayNode('mapping')
  493.                             ->normalizeKeys(false)
  494.                             ->useAttributeAsKey('resource_class')
  495.                             ->prototype('array')
  496.                                 ->children()
  497.                                     ->scalarNode('index')->defaultNull()->end()
  498.                                     ->scalarNode('type')->defaultValue(DocumentMetadata::DEFAULT_TYPE)->end()
  499.                                 ->end()
  500.                             ->end()
  501.                         ->end()
  502.                     ->end()
  503.                 ->end()
  504.             ->end();
  505.     }
  507.     private function addOpenApiSection(ArrayNodeDefinition $rootNode): void
  508.     {
  509.         $rootNode
  510.             ->children()
  511.                 ->arrayNode('openapi')
  512.                     ->addDefaultsIfNotSet()
  513.                         ->children()
  514.                         ->arrayNode('contact')
  515.                         ->addDefaultsIfNotSet()
  516.                             ->children()
  517.                                 ->scalarNode('name')->defaultNull()->info('The identifying name of the contact person/organization.')->end()
  518.                                 ->scalarNode('url')->defaultNull()->info('The URL pointing to the contact information. MUST be in the format of a URL.')->end()
  519.                                 ->scalarNode('email')->defaultNull()->info('The email address of the contact person/organization. MUST be in the format of an email address.')->end()
  520.                             ->end()
  521.                         ->end()
  522.                         ->booleanNode('backward_compatibility_layer')->defaultTrue()->info('Enable this to decorate the "api_platform.swagger.normalizer.documentation" instead of decorating the OpenAPI factory.')->end()
  523.                         ->scalarNode('termsOfService')->defaultNull()->info('A URL to the Terms of Service for the API. MUST be in the format of a URL.')->end()
  524.                         ->arrayNode('license')
  525.                         ->addDefaultsIfNotSet()
  526.                             ->children()
  527.                                 ->scalarNode('name')->defaultNull()->info('The license name used for the API.')->end()
  528.                                 ->scalarNode('url')->defaultNull()->info('URL to the license used for the API. MUST be in the format of a URL.')->end()
  529.                             ->end()
  530.                         ->end()
  531.                         ->variableNode('swagger_ui_extra_configuration')
  532.                             ->defaultValue([])
  533.                             ->validate()
  534.                                 ->ifTrue(static function ($v) { return false === \is_array($v); })
  535.                                 ->thenInvalid('The swagger_ui_extra_configuration parameter must be an array.')
  536.                             ->end()
  537.                             ->info('To pass extra configuration to Swagger UI, like docExpansion or filter.')
  538.                         ->end()
  539.                     ->end()
  540.                 ->end()
  541.             ->end();
  542.     }
  544.     /**
  545.      * @throws InvalidConfigurationException
  546.      */
  547.     private function addExceptionToStatusSection(ArrayNodeDefinition $rootNode): void
  548.     {
  549.         $rootNode
  550.             ->children()
  551.                 ->arrayNode('exception_to_status')
  552.                     ->defaultValue([
  553.                         SerializerExceptionInterface::class => Response::HTTP_BAD_REQUEST,
  554.                         InvalidArgumentException::class => Response::HTTP_BAD_REQUEST,
  555.                         FilterValidationException::class => Response::HTTP_BAD_REQUEST,
  556.                         OptimisticLockException::class => Response::HTTP_CONFLICT,
  557.                     ])
  558.                     ->info('The list of exceptions mapped to their HTTP status code.')
  559.                     ->normalizeKeys(false)
  560.                     ->useAttributeAsKey('exception_class')
  561.                     ->beforeNormalization()
  562.                         ->ifArray()
  563.                         ->then(static function (array $exceptionToStatus) {
  564.                             foreach ($exceptionToStatus as &$httpStatusCode) {
  565.                                 if (\is_int($httpStatusCode)) {
  566.                                     continue;
  567.                                 }
  569.                                 if (\defined($httpStatusCodeConstant = sprintf('%s::%s', Response::class, $httpStatusCode))) {
  570.                                     @trigger_error(sprintf('Using a string "%s" as a constant of the "%s" class is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3. Use the Symfony\'s custom YAML extension for PHP constants instead (i.e. "!php/const %s").', $httpStatusCode, Response::class, $httpStatusCodeConstant), \E_USER_DEPRECATED);
  572.                                     $httpStatusCode = \constant($httpStatusCodeConstant);
  573.                                 }
  574.                             }
  576.                             return $exceptionToStatus;
  577.                         })
  578.                     ->end()
  579.                     ->prototype('integer')->end()
  580.                     ->validate()
  581.                         ->ifArray()
  582.                         ->then(static function (array $exceptionToStatus) {
  583.                             foreach ($exceptionToStatus as $httpStatusCode) {
  584.                                 if ($httpStatusCode < 100 || $httpStatusCode >= 600) {
  585.                                     throw new InvalidConfigurationException(sprintf('The HTTP status code "%s" is not valid.', $httpStatusCode));
  586.                                 }
  587.                             }
  589.                             return $exceptionToStatus;
  590.                         })
  591.                     ->end()
  592.                 ->end()
  593.             ->end();
  594.     }
  596.     private function addFormatSection(ArrayNodeDefinition $rootNode, string $key, array $defaultValue): void
  597.     {
  598.         $rootNode
  599.             ->children()
  600.                 ->arrayNode($key)
  601.                     ->defaultValue($defaultValue)
  602.                     ->info('The list of enabled formats. The first one will be the default.')
  603.                     ->normalizeKeys(false)
  604.                     ->useAttributeAsKey('format')
  605.                     ->beforeNormalization()
  606.                         ->ifArray()
  607.                         ->then(static function ($v) {
  608.                             foreach ($v as $format => $value) {
  609.                                 if (isset($value['mime_types'])) {
  610.                                     continue;
  611.                                 }
  613.                                 $v[$format] = ['mime_types' => $value];
  614.                             }
  616.                             return $v;
  617.                         })
  618.                     ->end()
  619.                     ->prototype('array')
  620.                         ->children()
  621.                             ->arrayNode('mime_types')->prototype('scalar')->end()->end()
  622.                         ->end()
  623.                     ->end()
  624.                 ->end()
  625.             ->end();
  626.     }
  628.     private function addDefaultsSection(ArrayNodeDefinition $rootNode): void
  629.     {
  630.         $nameConverter = new CamelCaseToSnakeCaseNameConverter();
  631.         $defaultsNode = $rootNode->children()->arrayNode('defaults');
  633.         $defaultsNode
  634.             ->ignoreExtraKeys(false)
  635.             ->beforeNormalization()
  636.             ->always(static function (array $defaults) use ($nameConverter) {
  637.                 $normalizedDefaults = [];
  638.                 foreach ($defaults as $option => $value) {
  639.                     $option = $nameConverter->normalize($option);
  640.                     $normalizedDefaults[$option] = $value;
  641.                 }
  643.                 return $normalizedDefaults;
  644.             });
  646.         // TODO: test defaults with things that are no in the constructor
  647.         if (class_exists(ApiResource::class)) {
  648.             $reflection = new \ReflectionClass(ApiResource::class);
  649.             foreach ($reflection->getConstructor()->getParameters() as $parameter) {
  650.                 $defaultsNode->children()->variableNode($nameConverter->normalize($parameter->getName()));
  651.             }
  653.             return;
  654.         }
  656.         [$publicProperties, $configurableAttributes] = LegacyApiResource::getConfigMetadata();
  657.         foreach (array_merge($publicProperties, $configurableAttributpies) as $attribute => $_) {
  658.             $snakeCased = $nameConverter->normalize($attribute);
  659.             $defaultsNode->children()->variableNode($snakeCased);
  660.         }
  661.     }
  663.     private function addMakerSection(ArrayNodeDefinition $rootNode): void
  664.     {
  665.         $rootNode
  666.             ->children()
  667.                 ->arrayNode('maker')
  668.                     ->{class_exists(MakerBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  669.                 ->end()
  670.             ->end();
  671.     }
  673.     private function buildDeprecationArgs(string $version, string $message): array
  674.     {
  675.         return method_exists(BaseNode::class, 'getDeprecation')
  676.             ? ['api-platform/core', $version, $message]
  677.             : [$message];
  678.     }
  679. }
  681. class_alias(Configuration::class, \ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Configuration::class);