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

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\Core\Bridge\Symfony\Bundle\DependencyInjection;
  16. use ApiPlatform\Core\Bridge\Elasticsearch\Metadata\Document\DocumentMetadata;
  17. use ApiPlatform\Core\Exception\FilterValidationException;
  18. use ApiPlatform\Core\Exception\InvalidArgumentException;
  19. use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
  20. use Doctrine\Bundle\MongoDBBundle\DoctrineMongoDBBundle;
  21. use Doctrine\ORM\OptimisticLockException;
  22. use Doctrine\ORM\Version as DoctrineOrmVersion;
  23. use Elasticsearch\Client as ElasticsearchClient;
  24. use FOS\UserBundle\FOSUserBundle;
  25. use GraphQL\GraphQL;
  26. use Symfony\Bundle\FullStack;
  27. use Symfony\Bundle\MercureBundle\MercureBundle;
  28. use Symfony\Bundle\TwigBundle\TwigBundle;
  29. use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
  30. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  31. use Symfony\Component\Config\Definition\ConfigurationInterface;
  32. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  33. use Symfony\Component\HttpFoundation\Response;
  34. use Symfony\Component\Messenger\MessageBusInterface;
  35. use Symfony\Component\Serializer\Exception\ExceptionInterface as SerializerExceptionInterface;
  37. /**
  38.  * The configuration of the bundle.
  39.  *
  40.  * @author Kévin Dunglas <[email protected]>
  41.  * @author Baptiste Meyer <[email protected]>
  42.  */
  43. final class Configuration implements ConfigurationInterface
  44. {
  45.     /**
  46.      * {@inheritdoc}
  47.      */
  48.     public function getConfigTreeBuilder()
  49.     {
  50.         if (method_exists(TreeBuilder::class, 'getRootNode')) {
  51.             $treeBuilder = new TreeBuilder('api_platform');
  52.             $rootNode = $treeBuilder->getRootNode();
  53.         } else {
  54.             $treeBuilder = new TreeBuilder();
  55.             $rootNode = $treeBuilder->root('api_platform');
  56.         }
  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.                 ->scalarNode('default_operation_path_resolver')
  87.                     ->defaultValue('api_platform.operation_path_resolver.underscore')
  88.                     ->setDeprecated('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.')
  89.                     ->info('Specify the default operation path resolver to use for generating resources operations path.')
  90.                 ->end()
  91.                 ->scalarNode('name_converter')->defaultNull()->info('Specify a name converter to use.')->end()
  92.                 ->scalarNode('path_segment_name_generator')->defaultValue('api_platform.path_segment_name_generator.underscore')->info('Specify a path name generator to use.')->end()
  93.                 ->booleanNode('allow_plain_identifiers')->defaultFalse()->info('Allow plain identifiers, for example "id" instead of "@id" when denormalizing a relation.')->end()
  94.                 ->arrayNode('validator')
  95.                     ->addDefaultsIfNotSet()
  96.                     ->children()
  97.                         ->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()
  98.                     ->end()
  99.                 ->end()
  100.                 ->arrayNode('eager_loading')
  101.                     ->canBeDisabled()
  102.                     ->addDefaultsIfNotSet()
  103.                     ->children()
  104.                         ->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()
  105.                         ->integerNode('max_joins')->defaultValue(30)->info('Max number of joined relations before EagerLoading throws a RuntimeException')->end()
  106.                         ->booleanNode('force_eager')->defaultTrue()->info('Force join on every relation. If disabled, it will only join relations having the EAGER fetch mode.')->end()
  107.                     ->end()
  108.                 ->end()
  109.                 ->booleanNode('enable_fos_user')->defaultValue(class_exists(FOSUserBundle::class))->info('Enable the FOSUserBundle integration.')->end()
  110.                 ->booleanNode('enable_nelmio_api_doc')
  111.                     ->defaultFalse()
  112.                     ->setDeprecated('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.')
  113.                     ->info('Enable the NelmioApiDocBundle integration.')
  114.                 ->end()
  115.                 ->booleanNode('enable_swagger')->defaultTrue()->info('Enable the Swagger documentation and export.')->end()
  116.                 ->booleanNode('enable_swagger_ui')->defaultValue(class_exists(TwigBundle::class))->info('Enable Swagger UI')->end()
  117.                 ->booleanNode('enable_re_doc')->defaultValue(class_exists(TwigBundle::class))->info('Enable ReDoc')->end()
  118.                 ->booleanNode('enable_entrypoint')->defaultTrue()->info('Enable the entrypoint')->end()
  119.                 ->booleanNode('enable_docs')->defaultTrue()->info('Enable the docs')->end()
  120.                 ->booleanNode('enable_profiler')->defaultTrue()->info('Enable the data collector and the WebProfilerBundle integration.')->end()
  121.                 ->arrayNode('collection')
  122.                     ->addDefaultsIfNotSet()
  123.                     ->children()
  124.                         ->scalarNode('exists_parameter_name')->defaultValue('exists')->cannotBeEmpty()->info('The name of the query parameter to filter on nullable field values.')->end()
  125.                         ->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
  126.                         ->scalarNode('order_parameter_name')->defaultValue('order')->cannotBeEmpty()->info('The name of the query parameter to order results.')->end()
  127.                         ->arrayNode('pagination')
  128.                             ->canBeDisabled()
  129.                             ->addDefaultsIfNotSet()
  130.                             ->children()
  131.                                 ->booleanNode('enabled')->defaultTrue()->info('To enable or disable pagination for all resource collections by default.')->end()
  132.                                 ->booleanNode('partial')->defaultFalse()->info('To enable or disable partial pagination for all resource collections by default when pagination is enabled.')->end()
  133.                                 ->booleanNode('client_enabled')->defaultFalse()->info('To allow the client to enable or disable the pagination.')->end()
  134.                                 ->booleanNode('client_items_per_page')->defaultFalse()->info('To allow the client to set the number of items per page.')->end()
  135.                                 ->booleanNode('client_partial')->defaultFalse()->info('To allow the client to enable or disable partial pagination.')->end()
  136.                                 ->integerNode('items_per_page')->defaultValue(30)->info('The default number of items per page.')->end()
  137.                                 ->integerNode('maximum_items_per_page')->defaultNull()->info('The maximum number of items per page.')->end()
  138.                                 ->scalarNode('page_parameter_name')->defaultValue('page')->cannotBeEmpty()->info('The default name of the parameter handling the page number.')->end()
  139.                                 ->scalarNode('enabled_parameter_name')->defaultValue('pagination')->cannotBeEmpty()->info('The name of the query parameter to enable or disable pagination.')->end()
  140.                                 ->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()
  141.                                 ->scalarNode('partial_parameter_name')->defaultValue('partial')->cannotBeEmpty()->info('The name of the query parameter to enable or disable partial pagination.')->end()
  142.                             ->end()
  143.                         ->end()
  144.                     ->end()
  145.                 ->end()
  146.                 ->arrayNode('mapping')
  147.                     ->addDefaultsIfNotSet()
  148.                     ->children()
  149.                         ->arrayNode('paths')
  150.                             ->prototype('scalar')->end()
  151.                         ->end()
  152.                     ->end()
  153.                 ->end()
  154.                 ->arrayNode('resource_class_directories')
  155.                     ->prototype('scalar')->end()
  156.                 ->end()
  157.             ->end();
  159.         $this->addDoctrineOrmSection($rootNode);
  160.         $this->addDoctrineMongoDbOdmSection($rootNode);
  161.         $this->addOAuthSection($rootNode);
  162.         $this->addGraphQlSection($rootNode);
  163.         $this->addSwaggerSection($rootNode);
  164.         $this->addHttpCacheSection($rootNode);
  165.         $this->addMercureSection($rootNode);
  166.         $this->addMessengerSection($rootNode);
  167.         $this->addElasticsearchSection($rootNode);
  169.         $this->addExceptionToStatusSection($rootNode);
  171.         $this->addFormatSection($rootNode, 'formats', [
  172.             'jsonld' => ['mime_types' => ['application/ld+json']],
  173.             'json' => ['mime_types' => ['application/json']], // Swagger support
  174.             'html' => ['mime_types' => ['text/html']], // Swagger UI support
  175.         ]);
  176.         $this->addFormatSection($rootNode, 'patch_formats', []);
  177.         $this->addFormatSection($rootNode, 'error_formats', [
  178.             'jsonproblem' => ['mime_types' => ['application/problem+json']],
  179.             'jsonld' => ['mime_types' => ['application/ld+json']],
  180.         ]);
  182.         return $treeBuilder;
  183.     }
  185.     private function addDoctrineOrmSection(ArrayNodeDefinition $rootNode): void
  186.     {
  187.         $rootNode
  188.             ->children()
  189.                 ->arrayNode('doctrine')
  190.                     ->{class_exists(DoctrineBundle::class) && class_exists(DoctrineOrmVersion::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  191.                 ->end()
  192.             ->end();
  193.     }
  195.     private function addDoctrineMongoDbOdmSection(ArrayNodeDefinition $rootNode): void
  196.     {
  197.         $rootNode
  198.             ->children()
  199.                 ->arrayNode('doctrine_mongodb_odm')
  200.                     ->{class_exists(DoctrineMongoDBBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  201.                 ->end()
  202.             ->end();
  203.     }
  205.     private function addOAuthSection(ArrayNodeDefinition $rootNode): void
  206.     {
  207.         $rootNode
  208.             ->children()
  209.                 ->arrayNode('oauth')
  210.                     ->canBeEnabled()
  211.                     ->addDefaultsIfNotSet()
  212.                     ->children()
  213.                         ->scalarNode('clientId')->defaultValue('')->info('The oauth client id.')->end()
  214.                         ->scalarNode('clientSecret')->defaultValue('')->info('The oauth client secret.')->end()
  215.                         ->scalarNode('type')->defaultValue('oauth2')->info('The oauth client secret.')->end()
  216.                         ->scalarNode('flow')->defaultValue('application')->info('The oauth flow grant type.')->end()
  217.                         ->scalarNode('tokenUrl')->defaultValue('/oauth/v2/token')->info('The oauth token url.')->end()
  218.                         ->scalarNode('authorizationUrl')->defaultValue('/oauth/v2/auth')->info('The oauth authentication url.')->end()
  219.                         ->arrayNode('scopes')
  220.                             ->prototype('scalar')->end()
  221.                         ->end()
  222.                     ->end()
  223.                 ->end()
  224.             ->end();
  225.     }
  227.     private function addGraphQlSection(ArrayNodeDefinition $rootNode): void
  228.     {
  229.         $rootNode
  230.             ->children()
  231.                 ->arrayNode('graphql')
  232.                     ->{class_exists(GraphQL::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  233.                     ->addDefaultsIfNotSet()
  234.                     ->children()
  235.                         ->scalarNode('default_ide')->defaultValue('graphiql')->end()
  236.                         ->arrayNode('graphiql')
  237.                             ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  238.                         ->end()
  239.                         ->arrayNode('graphql_playground')
  240.                             ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  241.                         ->end()
  242.                         ->scalarNode('nesting_separator')->defaultValue('_')->info('The separator to use to filter nested fields.')->end()
  243.                         ->arrayNode('collection')
  244.                             ->addDefaultsIfNotSet()
  245.                             ->children()
  246.                                 ->arrayNode('pagination')
  247.                                     ->canBeDisabled()
  248.                                 ->end()
  249.                             ->end()
  250.                         ->end()
  251.                     ->end()
  252.                 ->end()
  253.             ->end();
  254.     }
  256.     private function addSwaggerSection(ArrayNodeDefinition $rootNode): void
  257.     {
  258.         $defaultVersions = [2, 3];
  260.         $rootNode
  261.             ->children()
  262.                 ->arrayNode('swagger')
  263.                     ->addDefaultsIfNotSet()
  264.                     ->children()
  265.                         ->arrayNode('versions')
  266.                             ->info('The active versions of OpenAPI to be exported or used in the swagger_ui. The first value is the default.')
  267.                             ->defaultValue($defaultVersions)
  268.                             ->beforeNormalization()
  269.                                 ->always(static function ($v) {
  270.                                     if (!\is_array($v)) {
  271.                                         $v = [$v];
  272.                                     }
  274.                                     foreach ($v as &$version) {
  275.                                         $version = (int) $version;
  276.                                     }
  278.                                     return $v;
  279.                                 })
  280.                             ->end()
  281.                             ->validate()
  282.                                 ->ifTrue(function ($v) use ($defaultVersions) {
  283.                                     return $v !== array_intersect($v, $defaultVersions);
  284.                                 })
  285.                                 ->thenInvalid(sprintf('Only the versions %s are supported. Got %s.', implode(' and ', $defaultVersions), '%s'))
  286.                             ->end()
  287.                             ->prototype('scalar')->end()
  288.                         ->end()
  289.                         ->arrayNode('api_keys')
  290.                             ->prototype('array')
  291.                                 ->children()
  292.                                     ->scalarNode('name')
  293.                                         ->info('The name of the header or query parameter containing the api key.')
  294.                                     ->end()
  295.                                     ->enumNode('type')
  296.                                         ->info('Whether the api key should be a query parameter or a header.')
  297.                                         ->values(['query', 'header'])
  298.                                     ->end()
  299.                                 ->end()
  300.                             ->end()
  301.                         ->end()
  302.                     ->end()
  303.                 ->end()
  304.             ->end();
  305.     }
  307.     private function addHttpCacheSection(ArrayNodeDefinition $rootNode): void
  308.     {
  309.         $rootNode
  310.             ->children()
  311.                 ->arrayNode('http_cache')
  312.                     ->addDefaultsIfNotSet()
  313.                     ->children()
  314.                         ->booleanNode('etag')->defaultTrue()->info('Automatically generate etags for API responses.')->end()
  315.                         ->integerNode('max_age')->defaultNull()->info('Default value for the response max age.')->end()
  316.                         ->integerNode('shared_max_age')->defaultNull()->info('Default value for the response shared (proxy) max age.')->end()
  317.                         ->arrayNode('vary')
  318.                             ->defaultValue(['Accept'])
  319.                             ->prototype('scalar')->end()
  320.                             ->info('Default values of the "Vary" HTTP header.')
  321.                         ->end()
  322.                         ->booleanNode('public')->defaultNull()->info('To make all responses public by default.')->end()
  323.                         ->arrayNode('invalidation')
  324.                             ->info('Enable the tags-based cache invalidation system.')
  325.                             ->canBeEnabled()
  326.                             ->children()
  327.                                 ->arrayNode('varnish_urls')
  328.                                     ->defaultValue([])
  329.                                     ->prototype('scalar')->end()
  330.                                     ->info('URLs of the Varnish servers to purge using cache tags when a resource is updated.')
  331.                                 ->end()
  332.                                 ->variableNode('request_options')
  333.                                     ->defaultValue([])
  334.                                     ->validate()
  335.                                         ->ifTrue(function ($v) { return false === \is_array($v); })
  336.                                         ->thenInvalid('The request_options parameter must be an array.')
  337.                                     ->end()
  338.                                     ->info('To pass options to the client charged with the request.')
  339.                                 ->end()
  340.                             ->end()
  341.                         ->end()
  342.                     ->end()
  343.                 ->end()
  344.             ->end();
  345.     }
  347.     private function addMercureSection(ArrayNodeDefinition $rootNode): void
  348.     {
  349.         $rootNode
  350.             ->children()
  351.                 ->arrayNode('mercure')
  352.                     ->{class_exists(MercureBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  353.                     ->children()
  354.                         ->scalarNode('hub_url')
  355.                             ->defaultNull()
  356.                             ->info('The URL sent in the Link HTTP header. If not set, will default to the URL for MercureBundle\'s default hub.')
  357.                         ->end()
  358.                     ->end()
  359.                 ->end()
  360.             ->end();
  361.     }
  363.     private function addMessengerSection(ArrayNodeDefinition $rootNode): void
  364.     {
  365.         $rootNode
  366.             ->children()
  367.                 ->arrayNode('messenger')
  368.                     ->{!class_exists(FullStack::class) && interface_exists(MessageBusInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  369.                 ->end()
  370.             ->end();
  371.     }
  373.     private function addElasticsearchSection(ArrayNodeDefinition $rootNode): void
  374.     {
  375.         $rootNode
  376.             ->children()
  377.                 ->arrayNode('elasticsearch')
  378.                     ->canBeEnabled()
  379.                     ->addDefaultsIfNotSet()
  380.                     ->children()
  381.                         ->booleanNode('enabled')
  382.                             ->defaultFalse()
  383.                             ->validate()
  384.                                 ->ifTrue()
  385.                                 ->then(static function (bool $v): bool {
  386.                                     if (!class_exists(ElasticsearchClient::class)) {
  387.                                         throw new InvalidConfigurationException('The elasticsearch/elasticsearch package is required for Elasticsearch support.');
  388.                                     }
  390.                                     return $v;
  391.                                 })
  392.                             ->end()
  393.                         ->end()
  394.                         ->arrayNode('hosts')
  395.                             ->beforeNormalization()->castToArray()->end()
  396.                             ->defaultValue([])
  397.                             ->prototype('scalar')->end()
  398.                         ->end()
  399.                         ->arrayNode('mapping')
  400.                             ->normalizeKeys(false)
  401.                             ->useAttributeAsKey('resource_class')
  402.                             ->prototype('array')
  403.                                 ->children()
  404.                                     ->scalarNode('index')->defaultNull()->end()
  405.                                     ->scalarNode('type')->defaultValue(DocumentMetadata::DEFAULT_TYPE)->end()
  406.                                 ->end()
  407.                             ->end()
  408.                         ->end()
  409.                     ->end()
  410.                 ->end()
  411.             ->end();
  412.     }
  414.     /**
  415.      * @throws InvalidConfigurationException
  416.      */
  417.     private function addExceptionToStatusSection(ArrayNodeDefinition $rootNode): void
  418.     {
  419.         $rootNode
  420.             ->children()
  421.                 ->arrayNode('exception_to_status')
  422.                     ->defaultValue([
  423.                         SerializerExceptionInterface::class => Response::HTTP_BAD_REQUEST,
  424.                         InvalidArgumentException::class => Response::HTTP_BAD_REQUEST,
  425.                         FilterValidationException::class => Response::HTTP_BAD_REQUEST,
  426.                         OptimisticLockException::class => Response::HTTP_CONFLICT,
  427.                     ])
  428.                     ->info('The list of exceptions mapped to their HTTP status code.')
  429.                     ->normalizeKeys(false)
  430.                     ->useAttributeAsKey('exception_class')
  431.                     ->beforeNormalization()
  432.                         ->ifArray()
  433.                         ->then(function (array $exceptionToStatus) {
  434.                             foreach ($exceptionToStatus as &$httpStatusCode) {
  435.                                 if (\is_int($httpStatusCode)) {
  436.                                     continue;
  437.                                 }
  439.                                 if (\defined($httpStatusCodeConstant = sprintf('%s::%s', Response::class, $httpStatusCode))) {
  440.                                     @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);
  442.                                     $httpStatusCode = \constant($httpStatusCodeConstant);
  443.                                 }
  444.                             }
  446.                             return $exceptionToStatus;
  447.                         })
  448.                     ->end()
  449.                     ->prototype('integer')->end()
  450.                     ->validate()
  451.                         ->ifArray()
  452.                         ->then(function (array $exceptionToStatus) {
  453.                             foreach ($exceptionToStatus as $httpStatusCode) {
  454.                                 if ($httpStatusCode < 100 || $httpStatusCode >= 600) {
  455.                                     throw new InvalidConfigurationException(sprintf('The HTTP status code "%s" is not valid.', $httpStatusCode));
  456.                                 }
  457.                             }
  459.                             return $exceptionToStatus;
  460.                         })
  461.                     ->end()
  462.                 ->end()
  463.             ->end();
  464.     }
  466.     private function addFormatSection(ArrayNodeDefinition $rootNode, string $key, array $defaultValue): void
  467.     {
  468.         $rootNode
  469.             ->children()
  470.                 ->arrayNode($key)
  471.                     ->defaultValue($defaultValue)
  472.                     ->info('The list of enabled formats. The first one will be the default.')
  473.                     ->normalizeKeys(false)
  474.                     ->useAttributeAsKey('format')
  475.                     ->beforeNormalization()
  476.                         ->ifArray()
  477.                         ->then(function ($v) {
  478.                             foreach ($v as $format => $value) {
  479.                                 if (isset($value['mime_types'])) {
  480.                                     continue;
  481.                                 }
  483.                                 $v[$format] = ['mime_types' => $value];
  484.                             }
  486.                             return $v;
  487.                         })
  488.                     ->end()
  489.                     ->prototype('array')
  490.                         ->children()
  491.                             ->arrayNode('mime_types')->prototype('scalar')->end()->end()
  492.                         ->end()
  493.                     ->end()
  494.                 ->end()
  495.             ->end();
  496.     }
  497. }