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

  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 Elasticsearch\Client as ElasticsearchClient;
  29. use GraphQL\GraphQL;
  30. use Symfony\Bundle\FullStack;
  31. use Symfony\Bundle\MakerBundle\MakerBundle;
  32. use Symfony\Bundle\MercureBundle\MercureBundle;
  33. use Symfony\Bundle\TwigBundle\TwigBundle;
  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 <dunglas@gmail.com>
  47.  * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  48.  */
  49. final class Configuration implements ConfigurationInterface
  50. {
  51.     /**
  52.      * {@inheritdoc}
  53.      */
  54.     public function getConfigTreeBuilder(): TreeBuilder
  55.     {
  56.         $treeBuilder = new TreeBuilder('api_platform');
  57.         $rootNode = $treeBuilder->getRootNode();
  59.         $rootNode
  60.             ->beforeNormalization()
  61.                 ->ifTrue(static function ($v) {
  62.                     return false === ($v['enable_swagger'] ?? null);
  63.                 })
  64.                 ->then(static function ($v) {
  65.                     $v['swagger']['versions'] = [];
  67.                     return $v;
  68.                 })
  69.             ->end()
  70.             ->children()
  71.                 ->scalarNode('title')
  72.                     ->info('The title of the API.')
  73.                     ->cannotBeEmpty()
  74.                     ->defaultValue('')
  75.                 ->end()
  76.                 ->scalarNode('description')
  77.                     ->info('The description of the API.')
  78.                     ->cannotBeEmpty()
  79.                     ->defaultValue('')
  80.                 ->end()
  81.                 ->scalarNode('version')
  82.                     ->info('The version of the API.')
  83.                     ->cannotBeEmpty()
  84.                     ->defaultValue('0.0.0')
  85.                 ->end()
  86.                 ->booleanNode('show_webby')->defaultTrue()->info('If true, show Webby on the documentation page')->end()
  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.                 ->arrayNode('collection')
  113.                     ->addDefaultsIfNotSet()
  114.                     ->children()
  115.                         ->scalarNode('exists_parameter_name')->defaultValue('exists')->cannotBeEmpty()->info('The name of the query parameter to filter on nullable field values.')->end()
  116.                         ->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
  117.                         ->scalarNode('order_parameter_name')->defaultValue('order')->cannotBeEmpty()->info('The name of the query parameter to order results.')->end()
  118.                         ->enumNode('order_nulls_comparison')->defaultNull()->values(array_merge(array_keys(OrderFilterInterface::NULLS_DIRECTION_MAP), [null]))->info('The nulls comparison strategy.')->end()
  119.                         ->arrayNode('pagination')
  120.                             ->canBeDisabled()
  121.                             ->addDefaultsIfNotSet()
  122.                             ->children()
  123.                                 ->scalarNode('page_parameter_name')->defaultValue('page')->cannotBeEmpty()->info('The default name of the parameter handling the page number.')->end()
  124.                                 ->scalarNode('enabled_parameter_name')->defaultValue('pagination')->cannotBeEmpty()->info('The name of the query parameter to enable or disable pagination.')->end()
  125.                                 ->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()
  126.                                 ->scalarNode('partial_parameter_name')->defaultValue('partial')->cannotBeEmpty()->info('The name of the query parameter to enable or disable partial pagination.')->end()
  127.                             ->end()
  128.                         ->end()
  129.                     ->end()
  130.                 ->end()
  131.                 ->arrayNode('mapping')
  132.                     ->addDefaultsIfNotSet()
  133.                     ->children()
  134.                         ->arrayNode('paths')
  135.                             ->prototype('scalar')->end()
  136.                         ->end()
  137.                     ->end()
  138.                 ->end()
  139.                 ->arrayNode('resource_class_directories')
  140.                     ->prototype('scalar')->end()
  141.                 ->end()
  142.             ->end();
  144.         $this->addDoctrineOrmSection($rootNode);
  145.         $this->addDoctrineMongoDbOdmSection($rootNode);
  146.         $this->addOAuthSection($rootNode);
  147.         $this->addGraphQlSection($rootNode);
  148.         $this->addSwaggerSection($rootNode);
  149.         $this->addHttpCacheSection($rootNode);
  150.         $this->addMercureSection($rootNode);
  151.         $this->addMessengerSection($rootNode);
  152.         $this->addElasticsearchSection($rootNode);
  153.         $this->addOpenApiSection($rootNode);
  154.         $this->addMakerSection($rootNode);
  156.         $this->addExceptionToStatusSection($rootNode);
  158.         $this->addFormatSection($rootNode, 'formats', [
  159.             'jsonld' => ['mime_types' => ['application/ld+json']],
  160.             'json' => ['mime_types' => ['application/json']], // Swagger support
  161.             'html' => ['mime_types' => ['text/html']], // Swagger UI support
  162.         ]);
  163.         $this->addFormatSection($rootNode, 'patch_formats', [
  164.             'json' => ['mime_types' => ['application/merge-patch+json']],
  165.         ]);
  166.         $this->addFormatSection($rootNode, 'error_formats', [
  167.             'jsonproblem' => ['mime_types' => ['application/problem+json']],
  168.             'jsonld' => ['mime_types' => ['application/ld+json']],
  169.         ]);
  171.         $this->addDefaultsSection($rootNode);
  173.         return $treeBuilder;
  174.     }
  176.     private function addDoctrineOrmSection(ArrayNodeDefinition $rootNode): void
  177.     {
  178.         $rootNode
  179.             ->children()
  180.                 ->arrayNode('doctrine')
  181.                     ->{class_exists(DoctrineBundle::class) && interface_exists(EntityManagerInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  182.                 ->end()
  183.             ->end();
  184.     }
  186.     private function addDoctrineMongoDbOdmSection(ArrayNodeDefinition $rootNode): void
  187.     {
  188.         $rootNode
  189.             ->children()
  190.                 ->arrayNode('doctrine_mongodb_odm')
  191.                     ->{class_exists(DoctrineMongoDBBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  192.                 ->end()
  193.             ->end();
  194.     }
  196.     private function addOAuthSection(ArrayNodeDefinition $rootNode): void
  197.     {
  198.         $rootNode
  199.             ->children()
  200.                 ->arrayNode('oauth')
  201.                     ->canBeEnabled()
  202.                     ->addDefaultsIfNotSet()
  203.                     ->children()
  204.                         ->scalarNode('clientId')->defaultValue('')->info('The oauth client id.')->end()
  205.                         ->scalarNode('clientSecret')
  206.                             ->defaultValue('')
  207.                             ->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')
  208.                         ->end()
  209.                         ->booleanNode('pkce')->defaultFalse()->info('Enable the oauth PKCE.')->end()
  210.                         ->scalarNode('type')->defaultValue('oauth2')->info('The oauth type.')->end()
  211.                         ->scalarNode('flow')->defaultValue('application')->info('The oauth flow grant type.')->end()
  212.                         ->scalarNode('tokenUrl')->defaultValue('')->info('The oauth token url.')->end()
  213.                         ->scalarNode('authorizationUrl')->defaultValue('')->info('The oauth authentication url.')->end()
  214.                         ->scalarNode('refreshUrl')->defaultValue('')->info('The oauth refresh url.')->end()
  215.                         ->arrayNode('scopes')
  216.                             ->prototype('scalar')->end()
  217.                         ->end()
  218.                     ->end()
  219.                 ->end()
  220.             ->end();
  221.     }
  223.     private function addGraphQlSection(ArrayNodeDefinition $rootNode): void
  224.     {
  225.         $rootNode
  226.             ->children()
  227.                 ->arrayNode('graphql')
  228.                     ->{class_exists(GraphQL::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  229.                     ->addDefaultsIfNotSet()
  230.                     ->children()
  231.                         ->scalarNode('default_ide')->defaultValue('graphiql')->end()
  232.                         ->arrayNode('graphiql')
  233.                             ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  234.                         ->end()
  235.                         ->arrayNode('graphql_playground')
  236.                             ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  237.                         ->end()
  238.                         ->scalarNode('nesting_separator')->defaultValue('_')->info('The separator to use to filter nested fields.')->end()
  239.                         ->arrayNode('collection')
  240.                             ->addDefaultsIfNotSet()
  241.                             ->children()
  242.                                 ->arrayNode('pagination')
  243.                                     ->canBeDisabled()
  244.                                 ->end()
  245.                             ->end()
  246.                         ->end()
  247.                     ->end()
  248.                 ->end()
  249.             ->end();
  250.     }
  252.     private function addSwaggerSection(ArrayNodeDefinition $rootNode): void
  253.     {
  254.         $supportedVersions = [3];
  256.         $rootNode
  257.             ->children()
  258.                 ->arrayNode('swagger')
  259.                     ->addDefaultsIfNotSet()
  260.                     ->children()
  261.                         ->arrayNode('versions')
  262.                             ->info('The active versions of OpenAPI to be exported or used in Swagger UI. The first value is the default.')
  263.                             ->defaultValue($supportedVersions)
  264.                             ->beforeNormalization()
  265.                                 ->always(static function ($v): array {
  266.                                     if (!\is_array($v)) {
  267.                                         $v = [$v];
  268.                                     }
  270.                                     foreach ($v as &$version) {
  271.                                         $version = (int) $version;
  272.                                     }
  274.                                     return $v;
  275.                                 })
  276.                             ->end()
  277.                             ->validate()
  278.                                 ->ifTrue(static fn($v): bool => $v !== array_intersect($v, $supportedVersions))
  279.                                 ->thenInvalid(sprintf('Only the versions %s are supported. Got %s.', implode(' and ', $supportedVersions), '%s'))
  280.                             ->end()
  281.                             ->prototype('scalar')->end()
  282.                         ->end()
  283.                         ->arrayNode('api_keys')
  284.                             ->useAttributeAsKey('key')
  285.                             ->prototype('array')
  286.                                 ->children()
  287.                                     ->scalarNode('name')
  288.                                         ->info('The name of the header or query parameter containing the api key.')
  289.                                     ->end()
  290.                                     ->enumNode('type')
  291.                                         ->info('Whether the api key should be a query parameter or a header.')
  292.                                         ->values(['query', 'header'])
  293.                                     ->end()
  294.                                 ->end()
  295.                             ->end()
  296.                         ->end()
  297.                         ->variableNode('swagger_ui_extra_configuration')
  298.                             ->defaultValue([])
  299.                             ->validate()
  300.                                 ->ifTrue(static fn($v): bool => false === \is_array($v))
  301.                                 ->thenInvalid('The swagger_ui_extra_configuration parameter must be an array.')
  302.                             ->end()
  303.                             ->info('To pass extra configuration to Swagger UI, like docExpansion or filter.')
  304.                         ->end()
  305.                     ->end()
  306.                 ->end()
  307.             ->end();
  308.     }
  310.     private function addHttpCacheSection(ArrayNodeDefinition $rootNode): void
  311.     {
  312.         $rootNode
  313.             ->children()
  314.                 ->arrayNode('http_cache')
  315.                     ->addDefaultsIfNotSet()
  316.                     ->children()
  317.                         ->booleanNode('public')->defaultNull()->info('To make all responses public by default.')->end()
  318.                         ->arrayNode('invalidation')
  319.                             ->info('Enable the tags-based cache invalidation system.')
  320.                             ->canBeEnabled()
  321.                             ->children()
  322.                                 ->arrayNode('varnish_urls')
  323.                                     ->setDeprecated('api-platform/core', '3.0', 'The "varnish_urls" configuration is deprecated, use "urls" or "scoped_clients".')
  324.                                     ->defaultValue([])
  325.                                     ->prototype('scalar')->end()
  326.                                     ->info('URLs of the Varnish servers to purge using cache tags when a resource is updated.')
  327.                                 ->end()
  328.                                 ->arrayNode('urls')
  329.                                     ->defaultValue([])
  330.                                     ->prototype('scalar')->end()
  331.                                     ->info('URLs of the Varnish servers to purge using cache tags when a resource is updated.')
  332.                                 ->end()
  333.                                 ->arrayNode('scoped_clients')
  334.                                     ->defaultValue([])
  335.                                     ->prototype('scalar')->end()
  336.                                     ->info('Service names of scoped client to use by the cache purger.')
  337.                                 ->end()
  338.                                 ->integerNode('max_header_length')
  339.                                     ->defaultValue(7500)
  340.                                     ->info('Max header length supported by the cache server.')
  341.                                 ->end()
  342.                                 ->variableNode('request_options')
  343.                                     ->defaultValue([])
  344.                                     ->validate()
  345.                                         ->ifTrue(static fn($v): bool => false === \is_array($v))
  346.                                         ->thenInvalid('The request_options parameter must be an array.')
  347.                                     ->end()
  348.                                     ->info('To pass options to the client charged with the request.')
  349.                                 ->end()
  350.                                 ->scalarNode('purger')
  351.                                     ->defaultValue('api_platform.http_cache.purger.varnish')
  352.                                     ->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").')
  353.                                 ->end()
  354.                                 ->arrayNode('xkey')
  355.                                     ->setDeprecated('api-platform/core', '3.0', 'The "xkey" configuration is deprecated, use your own purger to customize surrogate keys or the appropriate paramters.')
  356.                                     ->addDefaultsIfNotSet()
  357.                                     ->children()
  358.                                         ->scalarNode('glue')
  359.                                         ->defaultValue(' ')
  360.                                         ->info('xkey glue between keys')
  361.                                         ->end()
  362.                                     ->end()
  363.                                 ->end()
  364.                             ->end()
  365.                         ->end()
  366.                     ->end()
  367.                 ->end()
  368.             ->end();
  369.     }
  371.     private function addMercureSection(ArrayNodeDefinition $rootNode): void
  372.     {
  373.         $rootNode
  374.             ->children()
  375.                 ->arrayNode('mercure')
  376.                     ->{class_exists(MercureBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  377.                     ->children()
  378.                         ->scalarNode('hub_url')
  379.                             ->defaultNull()
  380.                             ->info('The URL sent in the Link HTTP header. If not set, will default to the URL for MercureBundle\'s default hub.')
  381.                         ->end()
  382.                         ->booleanNode('include_type')
  383.                             ->defaultFalse()
  384.                             ->info('Always include @type in updates (including delete ones).')
  385.                         ->end()
  386.                     ->end()
  387.                 ->end()
  388.             ->end();
  389.     }
  391.     private function addMessengerSection(ArrayNodeDefinition $rootNode): void
  392.     {
  393.         $rootNode
  394.             ->children()
  395.                 ->arrayNode('messenger')
  396.                     ->{!class_exists(FullStack::class) && interface_exists(MessageBusInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  397.                 ->end()
  398.             ->end();
  399.     }
  401.     private function addElasticsearchSection(ArrayNodeDefinition $rootNode): void
  402.     {
  403.         $rootNode
  404.             ->children()
  405.                 ->arrayNode('elasticsearch')
  406.                     ->canBeEnabled()
  407.                     ->addDefaultsIfNotSet()
  408.                     ->children()
  409.                         ->booleanNode('enabled')
  410.                             ->defaultFalse()
  411.                             ->validate()
  412.                                 ->ifTrue()
  413.                                 ->then(static function (bool $v): bool {
  414.                                     if (!class_exists(ElasticsearchClient::class)) {
  415.                                         throw new InvalidConfigurationException('The elasticsearch/elasticsearch package is required for Elasticsearch support.');
  416.                                     }
  418.                                     return $v;
  419.                                 })
  420.                             ->end()
  421.                         ->end()
  422.                         ->arrayNode('hosts')
  423.                             ->beforeNormalization()->castToArray()->end()
  424.                             ->defaultValue([])
  425.                             ->prototype('scalar')->end()
  426.                         ->end()
  427.                         ->arrayNode('mapping')
  428.                             ->setDeprecated('api-platform/core', '3.1', sprintf('The "%%node%%" option is deprecated. Configure an %s as $stateOptions.', Options::class))
  429.                             ->normalizeKeys(false)
  430.                             ->useAttributeAsKey('resource_class')
  431.                             ->prototype('array')
  432.                                 ->children()
  433.                                     ->scalarNode('index')->defaultNull()->end()
  434.                                     ->scalarNode('type')->defaultValue(DocumentMetadata::DEFAULT_TYPE)->end()
  435.                                 ->end()
  436.                             ->end()
  437.                         ->end()
  438.                     ->end()
  439.                 ->end()
  440.             ->end();
  441.     }
  443.     private function addOpenApiSection(ArrayNodeDefinition $rootNode): void
  444.     {
  445.         $rootNode
  446.             ->children()
  447.                 ->arrayNode('openapi')
  448.                     ->addDefaultsIfNotSet()
  449.                         ->children()
  450.                         ->arrayNode('contact')
  451.                         ->addDefaultsIfNotSet()
  452.                             ->children()
  453.                                 ->scalarNode('name')->defaultNull()->info('The identifying name of the contact person/organization.')->end()
  454.                                 ->scalarNode('url')->defaultNull()->info('The URL pointing to the contact information. MUST be in the format of a URL.')->end()
  455.                                 ->scalarNode('email')->defaultNull()->info('The email address of the contact person/organization. MUST be in the format of an email address.')->end()
  456.                             ->end()
  457.                         ->end()
  458.                         ->scalarNode('termsOfService')->defaultNull()->info('A URL to the Terms of Service for the API. MUST be in the format of a URL.')->end()
  459.                         ->arrayNode('license')
  460.                         ->addDefaultsIfNotSet()
  461.                             ->children()
  462.                                 ->scalarNode('name')->defaultNull()->info('The license name used for the API.')->end()
  463.                                 ->scalarNode('url')->defaultNull()->info('URL to the license used for the API. MUST be in the format of a URL.')->end()
  464.                             ->end()
  465.                         ->end()
  466.                         ->variableNode('swagger_ui_extra_configuration')
  467.                             ->defaultValue([])
  468.                             ->validate()
  469.                                 ->ifTrue(static fn($v): bool => false === \is_array($v))
  470.                                 ->thenInvalid('The swagger_ui_extra_configuration parameter must be an array.')
  471.                             ->end()
  472.                             ->info('To pass extra configuration to Swagger UI, like docExpansion or filter.')
  473.                         ->end()
  474.                     ->end()
  475.                 ->end()
  476.             ->end();
  477.     }
  479.     /**
  480.      * @throws InvalidConfigurationException
  481.      */
  482.     private function addExceptionToStatusSection(ArrayNodeDefinition $rootNode): void
  483.     {
  484.         $rootNode
  485.             ->children()
  486.                 ->arrayNode('exception_to_status')
  487.                     ->defaultValue([
  488.                         SerializerExceptionInterface::class => Response::HTTP_BAD_REQUEST,
  489.                         InvalidArgumentException::class => Response::HTTP_BAD_REQUEST,
  490.                         FilterValidationException::class => Response::HTTP_BAD_REQUEST,
  491.                         OptimisticLockException::class => Response::HTTP_CONFLICT,
  492.                     ])
  493.                     ->info('The list of exceptions mapped to their HTTP status code.')
  494.                     ->normalizeKeys(false)
  495.                     ->useAttributeAsKey('exception_class')
  496.                     ->prototype('integer')->end()
  497.                     ->validate()
  498.                         ->ifArray()
  499.                         ->then(static function (array $exceptionToStatus): array {
  500.                             foreach ($exceptionToStatus as $httpStatusCode) {
  501.                                 if ($httpStatusCode < 100 || $httpStatusCode >= 600) {
  502.                                     throw new InvalidConfigurationException(sprintf('The HTTP status code "%s" is not valid.', $httpStatusCode));
  503.                                 }
  504.                             }
  506.                             return $exceptionToStatus;
  507.                         })
  508.                     ->end()
  509.                 ->end()
  510.             ->end();
  511.     }
  513.     private function addFormatSection(ArrayNodeDefinition $rootNode, string $key, array $defaultValue): void
  514.     {
  515.         $rootNode
  516.             ->children()
  517.                 ->arrayNode($key)
  518.                     ->defaultValue($defaultValue)
  519.                     ->info('The list of enabled formats. The first one will be the default.')
  520.                     ->normalizeKeys(false)
  521.                     ->useAttributeAsKey('format')
  522.                     ->beforeNormalization()
  523.                         ->ifArray()
  524.                         ->then(static function ($v) {
  525.                             foreach ($v as $format => $value) {
  526.                                 if (isset($value['mime_types'])) {
  527.                                     continue;
  528.                                 }
  530.                                 $v[$format] = ['mime_types' => $value];
  531.                             }
  533.                             return $v;
  534.                         })
  535.                     ->end()
  536.                     ->prototype('array')
  537.                         ->children()
  538.                             ->arrayNode('mime_types')->prototype('scalar')->end()->end()
  539.                         ->end()
  540.                     ->end()
  541.                 ->end()
  542.             ->end();
  543.     }
  545.     private function addDefaultsSection(ArrayNodeDefinition $rootNode): void
  546.     {
  547.         $nameConverter = new CamelCaseToSnakeCaseNameConverter();
  548.         $defaultsNode = $rootNode->children()->arrayNode('defaults');
  550.         $defaultsNode
  551.             ->ignoreExtraKeys(false)
  552.             ->beforeNormalization()
  553.             ->always(static function (array $defaults) use ($nameConverter): array {
  554.                 $normalizedDefaults = [];
  555.                 foreach ($defaults as $option => $value) {
  556.                     $option = $nameConverter->normalize($option);
  557.                     $normalizedDefaults[$option] = $value;
  558.                 }
  560.                 return $normalizedDefaults;
  561.             });
  563.         $this->defineDefault($defaultsNode, new \ReflectionClass(ApiResource::class), $nameConverter);
  564.         $this->defineDefault($defaultsNode, new \ReflectionClass(Put::class), $nameConverter);
  565.         $this->defineDefault($defaultsNode, new \ReflectionClass(Post::class), $nameConverter);
  566.     }
  568.     private function addMakerSection(ArrayNodeDefinition $rootNode): void
  569.     {
  570.         $rootNode
  571.             ->children()
  572.                 ->arrayNode('maker')
  573.                     ->{class_exists(MakerBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  574.                 ->end()
  575.             ->end();
  576.     }
  578.     private function defineDefault(ArrayNodeDefinition $defaultsNode, \ReflectionClass $reflectionClass, CamelCaseToSnakeCaseNameConverter $nameConverter)
  579.     {
  580.         foreach ($reflectionClass->getConstructor()->getParameters() as $parameter) {
  581.             $defaultsNode->children()->variableNode($nameConverter->normalize($parameter->getName()));
  582.         }
  583.     }
  584. }