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

  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\Doctrine\Common\Filter\OrderFilterInterface;
  17. use ApiPlatform\Elasticsearch\Metadata\Document\DocumentMetadata;
  18. use ApiPlatform\Elasticsearch\State\Options;
  19. use ApiPlatform\Exception\FilterValidationException;
  20. use ApiPlatform\Exception\InvalidArgumentException;
  21. use ApiPlatform\Metadata\ApiResource;
  22. use ApiPlatform\Metadata\Post;
  23. use ApiPlatform\Metadata\Put;
  24. use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
  25. use Doctrine\Bundle\MongoDBBundle\DoctrineMongoDBBundle;
  26. use Doctrine\ORM\EntityManagerInterface;
  27. use Doctrine\ORM\OptimisticLockException;
  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\Builder\ArrayNodeDefinition;
  34. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  35. use Symfony\Component\Config\Definition\ConfigurationInterface;
  36. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  37. use Symfony\Component\HttpFoundation\Response;
  38. use Symfony\Component\Messenger\MessageBusInterface;
  39. use Symfony\Component\Serializer\Exception\ExceptionInterface as SerializerExceptionInterface;
  40. use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
  42. /**
  43.  * The configuration of the bundle.
  44.  *
  45.  * @author Kévin Dunglas <dunglas@gmail.com>
  46.  * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  47.  */
  48. final class Configuration implements ConfigurationInterface
  49. {
  50.     /**
  51.      * {@inheritdoc}
  52.      */
  53.     public function getConfigTreeBuilder(): TreeBuilder
  54.     {
  55.         $treeBuilder = new TreeBuilder('api_platform');
  56.         $rootNode = $treeBuilder->getRootNode();
  58.         $rootNode
  59.             ->beforeNormalization()
  60.                 ->ifTrue(static function ($v) {
  61.                     return false === ($v['enable_swagger'] ?? null);
  62.                 })
  63.                 ->then(static function ($v) {
  64.                     $v['swagger']['versions'] = [];
  66.                     return $v;
  67.                 })
  68.             ->end()
  69.             ->children()
  70.                 ->scalarNode('title')
  71.                     ->info('The title of the API.')
  72.                     ->cannotBeEmpty()
  73.                     ->defaultValue('')
  74.                 ->end()
  75.                 ->scalarNode('description')
  76.                     ->info('The description of the API.')
  77.                     ->cannotBeEmpty()
  78.                     ->defaultValue('')
  79.                 ->end()
  80.                 ->scalarNode('version')
  81.                     ->info('The version of the API.')
  82.                     ->cannotBeEmpty()
  83.                     ->defaultValue('0.0.0')
  84.                 ->end()
  85.                 ->booleanNode('show_webby')->defaultTrue()->info('If true, show Webby on the documentation page')->end()
  86.                 ->booleanNode('event_listeners_backward_compatibility_layer')->defaultTrue()->info('If true API Platform uses Symfony event listeners instead of providers and processors.')->end() // TODO: Add link to the documentation
  87.                 ->scalarNode('name_converter')->defaultNull()->info('Specify a name converter to use.')->end()
  88.                 ->scalarNode('asset_package')->defaultNull()->info('Specify an asset package name to use.')->end()
  89.                 ->scalarNode('path_segment_name_generator')->defaultValue('api_platform.metadata.path_segment_name_generator.underscore')->info('Specify a path name generator to use.')->end()
  90.                 ->arrayNode('validator')
  91.                     ->addDefaultsIfNotSet()
  92.                     ->children()
  93.                         ->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()
  94.                         ->booleanNode('query_parameter_validation')->defaultValue(true)->end()
  95.                     ->end()
  96.                 ->end()
  97.                 ->arrayNode('eager_loading')
  98.                     ->canBeDisabled()
  99.                     ->addDefaultsIfNotSet()
  100.                     ->children()
  101.                         ->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()
  102.                         ->integerNode('max_joins')->defaultValue(30)->info('Max number of joined relations before EagerLoading throws a RuntimeException')->end()
  103.                         ->booleanNode('force_eager')->defaultTrue()->info('Force join on every relation. If disabled, it will only join relations having the EAGER fetch mode.')->end()
  104.                     ->end()
  105.                 ->end()
  106.                 ->booleanNode('enable_swagger')->defaultTrue()->info('Enable the Swagger documentation and export.')->end()
  107.                 ->booleanNode('enable_swagger_ui')->defaultValue(class_exists(TwigBundle::class))->info('Enable Swagger UI')->end()
  108.                 ->booleanNode('enable_re_doc')->defaultValue(class_exists(TwigBundle::class))->info('Enable ReDoc')->end()
  109.                 ->booleanNode('enable_entrypoint')->defaultTrue()->info('Enable the entrypoint')->end()
  110.                 ->booleanNode('enable_docs')->defaultTrue()->info('Enable the docs')->end()
  111.                 ->booleanNode('enable_profiler')->defaultTrue()->info('Enable the data collector and the WebProfilerBundle integration.')->end()
  112.                 ->booleanNode('keep_legacy_inflector')->defaultTrue()->info('Keep doctrine/inflector instead of symfony/string to generate plurals for routes.')->end()
  113.                 ->arrayNode('collection')
  114.                     ->addDefaultsIfNotSet()
  115.                     ->children()
  116.                         ->scalarNode('exists_parameter_name')->defaultValue('exists')->cannotBeEmpty()->info('The name of the query parameter to filter on nullable field values.')->end()
  117.                         ->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
  118.                         ->scalarNode('order_parameter_name')->defaultValue('order')->cannotBeEmpty()->info('The name of the query parameter to order results.')->end()
  119.                         ->enumNode('order_nulls_comparison')->defaultNull()->values(array_merge(array_keys(OrderFilterInterface::NULLS_DIRECTION_MAP), [null]))->info('The nulls comparison strategy.')->end()
  120.                         ->arrayNode('pagination')
  121.                             ->canBeDisabled()
  122.                             ->addDefaultsIfNotSet()
  123.                             ->children()
  124.                                 ->scalarNode('page_parameter_name')->defaultValue('page')->cannotBeEmpty()->info('The default name of the parameter handling the page number.')->end()
  125.                                 ->scalarNode('enabled_parameter_name')->defaultValue('pagination')->cannotBeEmpty()->info('The name of the query parameter to enable or disable pagination.')->end()
  126.                                 ->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()
  127.                                 ->scalarNode('partial_parameter_name')->defaultValue('partial')->cannotBeEmpty()->info('The name of the query parameter to enable or disable partial pagination.')->end()
  128.                             ->end()
  129.                         ->end()
  130.                     ->end()
  131.                 ->end()
  132.                 ->arrayNode('mapping')
  133.                     ->addDefaultsIfNotSet()
  134.                     ->children()
  135.                         ->arrayNode('paths')
  136.                             ->prototype('scalar')->end()
  137.                         ->end()
  138.                     ->end()
  139.                 ->end()
  140.                 ->arrayNode('resource_class_directories')
  141.                     ->prototype('scalar')->end()
  142.                 ->end()
  143.             ->end();
  145.         $this->addDoctrineOrmSection($rootNode);
  146.         $this->addDoctrineMongoDbOdmSection($rootNode);
  147.         $this->addOAuthSection($rootNode);
  148.         $this->addGraphQlSection($rootNode);
  149.         $this->addSwaggerSection($rootNode);
  150.         $this->addHttpCacheSection($rootNode);
  151.         $this->addMercureSection($rootNode);
  152.         $this->addMessengerSection($rootNode);
  153.         $this->addElasticsearchSection($rootNode);
  154.         $this->addOpenApiSection($rootNode);
  155.         $this->addMakerSection($rootNode);
  157.         $this->addExceptionToStatusSection($rootNode);
  159.         $this->addFormatSection($rootNode, 'formats', [
  160.         ]);
  161.         $this->addFormatSection($rootNode, 'patch_formats', [
  162.             'json' => ['mime_types' => ['application/merge-patch+json']],
  163.         ]);
  164.         $this->addFormatSection($rootNode, 'docs_formats', [
  165.             'jsonopenapi' => ['mime_types' => ['application/vnd.openapi+json']],
  166.             'yamlopenapi' => ['mime_types' => ['application/vnd.openapi+yaml']],
  167.             'json' => ['mime_types' => ['application/json']], // this is only for legacy reasons, use jsonopenapi instead
  168.             'jsonld' => ['mime_types' => ['application/ld+json']],
  169.             'html' => ['mime_types' => ['text/html']],
  170.         ]);
  171.         $this->addFormatSection($rootNode, 'error_formats', [
  172.             'jsonld' => ['mime_types' => ['application/ld+json']],
  173.             'jsonproblem' => ['mime_types' => ['application/problem+json']],
  174.             'json' => ['mime_types' => ['application/problem+json', 'application/json']],
  175.         ]);
  177.         $this->addDefaultsSection($rootNode);
  179.         return $treeBuilder;
  180.     }
  182.     private function addDoctrineOrmSection(ArrayNodeDefinition $rootNode): void
  183.     {
  184.         $rootNode
  185.             ->children()
  186.                 ->arrayNode('doctrine')
  187.                     ->{class_exists(DoctrineBundle::class) && interface_exists(EntityManagerInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  188.                 ->end()
  189.             ->end();
  190.     }
  192.     private function addDoctrineMongoDbOdmSection(ArrayNodeDefinition $rootNode): void
  193.     {
  194.         $rootNode
  195.             ->children()
  196.                 ->arrayNode('doctrine_mongodb_odm')
  197.                     ->{class_exists(DoctrineMongoDBBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  198.                 ->end()
  199.             ->end();
  200.     }
  202.     private function addOAuthSection(ArrayNodeDefinition $rootNode): void
  203.     {
  204.         $rootNode
  205.             ->children()
  206.                 ->arrayNode('oauth')
  207.                     ->canBeEnabled()
  208.                     ->addDefaultsIfNotSet()
  209.                     ->children()
  210.                         ->scalarNode('clientId')->defaultValue('')->info('The oauth client id.')->end()
  211.                         ->scalarNode('clientSecret')
  212.                             ->defaultValue('')
  213.                             ->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')
  214.                         ->end()
  215.                         ->booleanNode('pkce')->defaultFalse()->info('Enable the oauth PKCE.')->end()
  216.                         ->scalarNode('type')->defaultValue('oauth2')->info('The oauth type.')->end()
  217.                         ->scalarNode('flow')->defaultValue('application')->info('The oauth flow grant type.')->end()
  218.                         ->scalarNode('tokenUrl')->defaultValue('')->info('The oauth token url.')->end()
  219.                         ->scalarNode('authorizationUrl')->defaultValue('')->info('The oauth authentication url.')->end()
  220.                         ->scalarNode('refreshUrl')->defaultValue('')->info('The oauth refresh url.')->end()
  221.                         ->arrayNode('scopes')
  222.                             ->prototype('scalar')->end()
  223.                         ->end()
  224.                     ->end()
  225.                 ->end()
  226.             ->end();
  227.     }
  229.     private function addGraphQlSection(ArrayNodeDefinition $rootNode): void
  230.     {
  231.         $rootNode
  232.             ->children()
  233.                 ->arrayNode('graphql')
  234.                     ->{class_exists(GraphQL::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  235.                     ->addDefaultsIfNotSet()
  236.                     ->children()
  237.                         ->scalarNode('default_ide')->defaultValue('graphiql')->end()
  238.                         ->arrayNode('graphiql')
  239.                             ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  240.                         ->end()
  241.                         ->arrayNode('graphql_playground')
  242.                             ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  243.                         ->end()
  244.                         ->arrayNode('introspection')
  245.                             ->canBeDisabled()
  246.                         ->end()
  247.                         ->scalarNode('nesting_separator')->defaultValue('_')->info('The separator to use to filter nested fields.')->end()
  248.                         ->arrayNode('collection')
  249.                             ->addDefaultsIfNotSet()
  250.                             ->children()
  251.                                 ->arrayNode('pagination')
  252.                                     ->canBeDisabled()
  253.                                 ->end()
  254.                             ->end()
  255.                         ->end()
  256.                     ->end()
  257.                 ->end()
  258.             ->end();
  259.     }
  261.     private function addSwaggerSection(ArrayNodeDefinition $rootNode): void
  262.     {
  263.         $supportedVersions = [3];
  265.         $rootNode
  266.             ->children()
  267.                 ->arrayNode('swagger')
  268.                     ->addDefaultsIfNotSet()
  269.                     ->children()
  270.                         ->arrayNode('versions')
  271.                             ->info('The active versions of OpenAPI to be exported or used in Swagger UI. The first value is the default.')
  272.                             ->defaultValue($supportedVersions)
  273.                             ->beforeNormalization()
  274.                                 ->always(static function ($v): array {
  275.                                     if (!\is_array($v)) {
  276.                                         $v = [$v];
  277.                                     }
  279.                                     foreach ($v as &$version) {
  280.                                         $version = (int) $version;
  281.                                     }
  283.                                     return $v;
  284.                                 })
  285.                             ->end()
  286.                             ->validate()
  287.                                 ->ifTrue(static fn($v): bool => $v !== array_intersect($v, $supportedVersions))
  288.                                 ->thenInvalid(sprintf('Only the versions %s are supported. Got %s.', implode(' and ', $supportedVersions), '%s'))
  289.                             ->end()
  290.                             ->prototype('scalar')->end()
  291.                         ->end()
  292.                         ->arrayNode('api_keys')
  293.                             ->useAttributeAsKey('key')
  294.                             ->validate()
  295.                                 ->ifTrue(static fn($v): bool => (bool) array_filter(array_keys($v), fn($item) => !preg_match('/^[a-zA-Z0-9._-]+$/', $item)))
  296.                                 ->thenInvalid('The api keys "key" is not valid according to the pattern enforced by OpenAPI 3.1 ^[a-zA-Z0-9._-]+$.')
  297.                             ->end()
  298.                             ->prototype('array')
  299.                                 ->children()
  300.                                     ->scalarNode('name')
  301.                                         ->info('The name of the header or query parameter containing the api key.')
  302.                                     ->end()
  303.                                     ->enumNode('type')
  304.                                         ->info('Whether the api key should be a query parameter or a header.')
  305.                                         ->values(['query', 'header'])
  306.                                     ->end()
  307.                                 ->end()
  308.                             ->end()
  309.                         ->end()
  310.                         ->variableNode('swagger_ui_extra_configuration')
  311.                             ->defaultValue([])
  312.                             ->validate()
  313.                                 ->ifTrue(static fn($v): bool => false === \is_array($v))
  314.                                 ->thenInvalid('The swagger_ui_extra_configuration parameter must be an array.')
  315.                             ->end()
  316.                             ->info('To pass extra configuration to Swagger UI, like docExpansion or filter.')
  317.                         ->end()
  318.                     ->end()
  319.                 ->end()
  320.             ->end();
  321.     }
  323.     private function addHttpCacheSection(ArrayNodeDefinition $rootNode): void
  324.     {
  325.         $rootNode
  326.             ->children()
  327.                 ->arrayNode('http_cache')
  328.                     ->addDefaultsIfNotSet()
  329.                     ->children()
  330.                         ->booleanNode('public')->defaultNull()->info('To make all responses public by default.')->end()
  331.                         ->arrayNode('invalidation')
  332.                             ->info('Enable the tags-based cache invalidation system.')
  333.                             ->canBeEnabled()
  334.                             ->children()
  335.                                 ->arrayNode('varnish_urls')
  336.                                     ->setDeprecated('api-platform/core', '3.0', 'The "varnish_urls" configuration is deprecated, use "urls" or "scoped_clients".')
  337.                                     ->defaultValue([])
  338.                                     ->prototype('scalar')->end()
  339.                                     ->info('URLs of the Varnish servers to purge using cache tags when a resource is updated.')
  340.                                 ->end()
  341.                                 ->arrayNode('urls')
  342.                                     ->defaultValue([])
  343.                                     ->prototype('scalar')->end()
  344.                                     ->info('URLs of the Varnish servers to purge using cache tags when a resource is updated.')
  345.                                 ->end()
  346.                                 ->arrayNode('scoped_clients')
  347.                                     ->defaultValue([])
  348.                                     ->prototype('scalar')->end()
  349.                                     ->info('Service names of scoped client to use by the cache purger.')
  350.                                 ->end()
  351.                                 ->integerNode('max_header_length')
  352.                                     ->defaultValue(7500)
  353.                                     ->info('Max header length supported by the cache server.')
  354.                                 ->end()
  355.                                 ->variableNode('request_options')
  356.                                     ->defaultValue([])
  357.                                     ->validate()
  358.                                         ->ifTrue(static fn($v): bool => false === \is_array($v))
  359.                                         ->thenInvalid('The request_options parameter must be an array.')
  360.                                     ->end()
  361.                                     ->info('To pass options to the client charged with the request.')
  362.                                 ->end()
  363.                                 ->scalarNode('purger')
  364.                                     ->defaultValue('api_platform.http_cache.purger.varnish')
  365.                                     ->info('Specify a purger to use (available values: "api_platform.http_cache.purger.varnish.ban", "api_platform.http_cache.purger.varnish.xkey", "api_platform.http_cache.purger.souin").')
  366.                                 ->end()
  367.                                 ->arrayNode('xkey')
  368.                                     ->setDeprecated('api-platform/core', '3.0', 'The "xkey" configuration is deprecated, use your own purger to customize surrogate keys or the appropriate paramters.')
  369.                                     ->addDefaultsIfNotSet()
  370.                                     ->children()
  371.                                         ->scalarNode('glue')
  372.                                         ->defaultValue(' ')
  373.                                         ->info('xkey glue between keys')
  374.                                         ->end()
  375.                                     ->end()
  376.                                 ->end()
  377.                             ->end()
  378.                         ->end()
  379.                     ->end()
  380.                 ->end()
  381.             ->end();
  382.     }
  384.     private function addMercureSection(ArrayNodeDefinition $rootNode): void
  385.     {
  386.         $rootNode
  387.             ->children()
  388.                 ->arrayNode('mercure')
  389.                     ->{class_exists(MercureBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  390.                     ->children()
  391.                         ->scalarNode('hub_url')
  392.                             ->defaultNull()
  393.                             ->info('The URL sent in the Link HTTP header. If not set, will default to the URL for MercureBundle\'s default hub.')
  394.                         ->end()
  395.                         ->booleanNode('include_type')
  396.                             ->defaultFalse()
  397.                             ->info('Always include @type in updates (including delete ones).')
  398.                         ->end()
  399.                     ->end()
  400.                 ->end()
  401.             ->end();
  402.     }
  404.     private function addMessengerSection(ArrayNodeDefinition $rootNode): void
  405.     {
  406.         $rootNode
  407.             ->children()
  408.                 ->arrayNode('messenger')
  409.                     ->{!class_exists(FullStack::class) && interface_exists(MessageBusInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  410.                 ->end()
  411.             ->end();
  412.     }
  414.     private function addElasticsearchSection(ArrayNodeDefinition $rootNode): void
  415.     {
  416.         $rootNode
  417.             ->children()
  418.                 ->arrayNode('elasticsearch')
  419.                     ->canBeEnabled()
  420.                     ->addDefaultsIfNotSet()
  421.                     ->children()
  422.                         ->booleanNode('enabled')
  423.                             ->defaultFalse()
  424.                             ->validate()
  425.                                 ->ifTrue()
  426.                                 ->then(static function (bool $v): bool {
  427.                                     if (!(class_exists(\Elasticsearch\Client::class) || class_exists(\Elastic\Elasticsearch\Client::class))) {
  428.                                         throw new InvalidConfigurationException('The elasticsearch/elasticsearch package is required for Elasticsearch support.');
  429.                                     }
  431.                                     return $v;
  432.                                 })
  433.                             ->end()
  434.                         ->end()
  435.                         ->arrayNode('hosts')
  436.                             ->beforeNormalization()->castToArray()->end()
  437.                             ->defaultValue([])
  438.                             ->prototype('scalar')->end()
  439.                         ->end()
  440.                         ->arrayNode('mapping')
  441.                             ->setDeprecated('api-platform/core', '3.1', sprintf('The "%%node%%" option is deprecated. Configure an %s as $stateOptions.', Options::class))
  442.                             ->normalizeKeys(false)
  443.                             ->useAttributeAsKey('resource_class')
  444.                             ->prototype('array')
  445.                                 ->children()
  446.                                     ->scalarNode('index')->defaultNull()->end()
  447.                                     ->scalarNode('type')->defaultValue(DocumentMetadata::DEFAULT_TYPE)->end()
  448.                                 ->end()
  449.                             ->end()
  450.                         ->end()
  451.                     ->end()
  452.                 ->end()
  453.             ->end();
  454.     }
  456.     private function addOpenApiSection(ArrayNodeDefinition $rootNode): void
  457.     {
  458.         $rootNode
  459.             ->children()
  460.                 ->arrayNode('openapi')
  461.                     ->addDefaultsIfNotSet()
  462.                         ->children()
  463.                         ->arrayNode('contact')
  464.                         ->addDefaultsIfNotSet()
  465.                             ->children()
  466.                                 ->scalarNode('name')->defaultNull()->info('The identifying name of the contact person/organization.')->end()
  467.                                 ->scalarNode('url')->defaultNull()->info('The URL pointing to the contact information. MUST be in the format of a URL.')->end()
  468.                                 ->scalarNode('email')->defaultNull()->info('The email address of the contact person/organization. MUST be in the format of an email address.')->end()
  469.                             ->end()
  470.                         ->end()
  471.                         ->scalarNode('termsOfService')->defaultNull()->info('A URL to the Terms of Service for the API. MUST be in the format of a URL.')->end()
  472.                         ->arrayNode('license')
  473.                         ->addDefaultsIfNotSet()
  474.                             ->children()
  475.                                 ->scalarNode('name')->defaultNull()->info('The license name used for the API.')->end()
  476.                                 ->scalarNode('url')->defaultNull()->info('URL to the license used for the API. MUST be in the format of a URL.')->end()
  477.                             ->end()
  478.                         ->end()
  479.                         ->variableNode('swagger_ui_extra_configuration')
  480.                             ->defaultValue([])
  481.                             ->validate()
  482.                                 ->ifTrue(static fn($v): bool => false === \is_array($v))
  483.                                 ->thenInvalid('The swagger_ui_extra_configuration parameter must be an array.')
  484.                             ->end()
  485.                             ->info('To pass extra configuration to Swagger UI, like docExpansion or filter.')
  486.                         ->end()
  487.                     ->end()
  488.                 ->end()
  489.             ->end();
  490.     }
  492.     /**
  493.      * @throws InvalidConfigurationException
  494.      */
  495.     private function addExceptionToStatusSection(ArrayNodeDefinition $rootNode): void
  496.     {
  497.         $rootNode
  498.             ->children()
  499.                 ->arrayNode('exception_to_status')
  500.                     ->defaultValue([
  501.                         SerializerExceptionInterface::class => Response::HTTP_BAD_REQUEST,
  502.                         InvalidArgumentException::class => Response::HTTP_BAD_REQUEST,
  503.                         FilterValidationException::class => Response::HTTP_BAD_REQUEST,
  504.                         OptimisticLockException::class => Response::HTTP_CONFLICT,
  505.                     ])
  506.                     ->info('The list of exceptions mapped to their HTTP status code.')
  507.                     ->normalizeKeys(false)
  508.                     ->useAttributeAsKey('exception_class')
  509.                     ->prototype('integer')->end()
  510.                     ->validate()
  511.                         ->ifArray()
  512.                         ->then(static function (array $exceptionToStatus): array {
  513.                             foreach ($exceptionToStatus as $httpStatusCode) {
  514.                                 if ($httpStatusCode < 100 || $httpStatusCode >= 600) {
  515.                                     throw new InvalidConfigurationException(sprintf('The HTTP status code "%s" is not valid.', $httpStatusCode));
  516.                                 }
  517.                             }
  519.                             return $exceptionToStatus;
  520.                         })
  521.                     ->end()
  522.                 ->end()
  523.             ->end();
  524.     }
  526.     private function addFormatSection(ArrayNodeDefinition $rootNode, string $key, array $defaultValue): void
  527.     {
  528.         $rootNode
  529.             ->children()
  530.                 ->arrayNode($key)
  531.                     ->defaultValue($defaultValue)
  532.                     ->info('The list of enabled formats. The first one will be the default.')
  533.                     ->normalizeKeys(false)
  534.                     ->useAttributeAsKey('format')
  535.                     ->beforeNormalization()
  536.                         ->ifArray()
  537.                         ->then(static function ($v) {
  538.                             foreach ($v as $format => $value) {
  539.                                 if (isset($value['mime_types'])) {
  540.                                     continue;
  541.                                 }
  543.                                 $v[$format] = ['mime_types' => $value];
  544.                             }
  546.                             return $v;
  547.                         })
  548.                     ->end()
  549.                     ->prototype('array')
  550.                         ->children()
  551.                             ->arrayNode('mime_types')->prototype('scalar')->end()->end()
  552.                         ->end()
  553.                     ->end()
  554.                 ->end()
  555.             ->end();
  556.     }
  558.     private function addDefaultsSection(ArrayNodeDefinition $rootNode): void
  559.     {
  560.         $nameConverter = new CamelCaseToSnakeCaseNameConverter();
  561.         $defaultsNode = $rootNode->children()->arrayNode('defaults');
  563.         $defaultsNode
  564.             ->ignoreExtraKeys(false)
  565.             ->beforeNormalization()
  566.             ->always(static function (array $defaults) use ($nameConverter): array {
  567.                 $normalizedDefaults = [];
  568.                 foreach ($defaults as $option => $value) {
  569.                     $option = $nameConverter->normalize($option);
  570.                     $normalizedDefaults[$option] = $value;
  571.                 }
  573.                 return $normalizedDefaults;
  574.             });
  576.         $this->defineDefault($defaultsNode, new \ReflectionClass(ApiResource::class), $nameConverter);
  577.         $this->defineDefault($defaultsNode, new \ReflectionClass(Put::class), $nameConverter);
  578.         $this->defineDefault($defaultsNode, new \ReflectionClass(Post::class), $nameConverter);
  579.     }
  581.     private function addMakerSection(ArrayNodeDefinition $rootNode): void
  582.     {
  583.         $rootNode
  584.             ->children()
  585.                 ->arrayNode('maker')
  586.                     ->{class_exists(MakerBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  587.                 ->end()
  588.             ->end();
  589.     }
  591.     private function defineDefault(ArrayNodeDefinition $defaultsNode, \ReflectionClass $reflectionClass, CamelCaseToSnakeCaseNameConverter $nameConverter)
  592.     {
  593.         foreach ($reflectionClass->getConstructor()->getParameters() as $parameter) {
  594.             $defaultsNode->children()->variableNode($nameConverter->normalize($parameter->getName()));
  595.         }
  596.     }
  597. }