vendor/nelmio/api-doc-bundle/DependencyInjection/Configuration.php line 38

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the NelmioApiDocBundle package.
  5.  *
  6.  * (c) Nelmio
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Nelmio\ApiDocBundle\DependencyInjection;
  14. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  15. use Symfony\Component\Config\Definition\ConfigurationInterface;
  17. final class Configuration implements ConfigurationInterface
  18. {
  19.     public function getConfigTreeBuilder()
  20.     {
  21.         $treeBuilder = new TreeBuilder('nelmio_api_doc');
  23.         if (method_exists($treeBuilder, 'getRootNode')) {
  24.             $rootNode = $treeBuilder->getRootNode();
  25.         } else {
  26.             // symfony < 4.2 support
  27.             $rootNode = $treeBuilder->root('nelmio_api_doc');
  28.         }
  30.         $rootNode
  31.             ->beforeNormalization()
  32.                 ->ifTrue(function ($v) {
  33.                     return !isset($v['areas']) && isset($v['routes']);
  34.                 })
  35.                 ->then(function ($v) {
  36.                     $v['areas'] = $v['routes'];
  37.                     unset($v['routes']);
  38.                     @trigger_error('The `nelmio_api_doc.routes` config option is deprecated. Please use `nelmio_api_doc.areas` instead (just replace `routes` by `areas` in your config).', E_USER_DEPRECATED);
  40.                     return $v;
  41.                 })
  42.             ->end()
  43.             ->beforeNormalization()
  44.                 ->ifTrue(function ($v) {
  45.                     return isset($v['routes']);
  46.                 })
  47.                 ->thenInvalid('You must not use both `nelmio_api_doc.areas` and `nelmio_api_doc.routes` config options. Please update your config to only use `nelmio_api_doc.areas`.')
  48.             ->end()
  49.             ->children()
  50.                 ->arrayNode('documentation')
  51.                     ->useAttributeAsKey('key')
  52.                     ->info('The documentation used as base')
  53.                     ->example(['info' => ['title' => 'My App']])
  54.                     ->prototype('variable')->end()
  55.                 ->end()
  56.                 ->arrayNode('areas')
  57.                     ->info('Filter the routes that are documented')
  58.                     ->defaultValue(
  59.                         [
  60.                             'default' => [
  61.                                 'path_patterns' => [],
  62.                                 'host_patterns' => [],
  63.                                 'with_annotation' => false,
  64.                                 'documentation' => [],
  65.                             ],
  66.                         ]
  67.                     )
  68.                     ->beforeNormalization()
  69.                         ->ifTrue(function ($v) {
  70.                             return 0 === count($v) || isset($v['path_patterns']) || isset($v['host_patterns']) || isset($v['documentation']);
  71.                         })
  72.                         ->then(function ($v) {
  73.                             return ['default' => $v];
  74.                         })
  75.                     ->end()
  76.                     ->validate()
  77.                         ->ifTrue(function ($v) {
  78.                             return !isset($v['default']);
  79.                         })
  80.                         ->thenInvalid('You must specify a `default` area under `nelmio_api_doc.areas`.')
  81.                     ->end()
  82.                     ->useAttributeAsKey('name')
  83.                     ->prototype('array')
  84.                         ->addDefaultsIfNotSet()
  85.                         ->children()
  86.                             ->arrayNode('path_patterns')
  87.                                 ->defaultValue([])
  88.                                 ->example(['^/api', '^/api(?!/admin)'])
  89.                                 ->prototype('scalar')->end()
  90.                             ->end()
  91.                             ->arrayNode('host_patterns')
  92.                                 ->defaultValue([])
  93.                                 ->example(['^api\.'])
  94.                                 ->prototype('scalar')->end()
  95.                             ->end()
  96.                             ->booleanNode('with_annotation')
  97.                                 ->defaultFalse()
  98.                                 ->info('whether to filter by annotation')
  99.                             ->end()
  100.                             ->arrayNode('documentation')
  101.                                 ->useAttributeAsKey('key')
  102.                                 ->defaultValue([])
  103.                                 ->info('The documentation used for area')
  104.                                 ->example(['info' => ['title' => 'My App']])
  105.                                 ->prototype('variable')->end()
  106.                             ->end()
  107.                         ->end()
  108.                     ->end()
  109.                 ->end()
  110.                 ->arrayNode('models')
  111.                     ->addDefaultsIfNotSet()
  112.                     ->children()
  113.                         ->booleanNode('use_jms')->defaultFalse()->end()
  114.                     ->end()
  115.                     ->children()
  116.                         ->arrayNode('names')
  117.                             ->prototype('array')
  118.                                 ->children()
  119.                                     ->scalarNode('alias')->isRequired()->end()
  120.                                     ->scalarNode('type')->isRequired()->end()
  121.                                     ->variableNode('groups')
  122.                                         ->defaultValue(null)
  123.                                         ->validate()
  124.                                             ->ifTrue(function ($v) { return null !== $v && !is_array($v); })
  125.                                             ->thenInvalid('Model groups must be either `null` or an array.')
  126.                                         ->end()
  127.                                     ->end()
  128.                                     ->arrayNode('areas')
  129.                                         ->defaultValue([])
  130.                                         ->prototype('scalar')->end()
  131.                                     ->end()
  132.                                 ->end()
  133.                         ->end()
  134.                     ->end()
  135.                 ->end()
  136.             ->end();
  138.         return $treeBuilder;
  139.     }
  140. }