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

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();
  22.         $treeBuilder
  23.             ->root('nelmio_api_doc')
  24.             ->beforeNormalization()
  25.                 ->ifTrue(function ($v) {
  26.                     return !isset($v['areas']) && isset($v['routes']);
  27.                 })
  28.                 ->then(function ($v) {
  29.                     $v['areas'] = $v['routes'];
  30.                     unset($v['routes']);
  31.                     @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);
  33.                     return $v;
  34.                 })
  35.             ->end()
  36.             ->beforeNormalization()
  37.                 ->ifTrue(function ($v) {
  38.                     return isset($v['routes']);
  39.                 })
  40.                 ->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`.')
  41.             ->end()
  42.             ->children()
  43.                 ->arrayNode('documentation')
  44.                     ->useAttributeAsKey('key')
  45.                     ->info('The documentation used as base')
  46.                     ->example(['info' => ['title' => 'My App']])
  47.                     ->prototype('variable')->end()
  48.                 ->end()
  49.                 ->arrayNode('areas')
  50.                     ->info('Filter the routes that are documented')
  51.                     ->defaultValue(['default' => ['path_patterns' => []]])
  52.                     ->beforeNormalization()
  53.                         ->ifTrue(function ($v) {
  54.                             return empty($v) or isset($v['path_patterns']);
  55.                         })
  56.                         ->then(function ($v) {
  57.                             return ['default' => $v];
  58.                         })
  59.                     ->end()
  60.                     ->validate()
  61.                         ->ifTrue(function ($v) {
  62.                             return !isset($v['default']);
  63.                         })
  64.                         ->thenInvalid('You must specify a `default` area under `nelmio_api_doc.areas`.')
  65.                     ->end()
  66.                     ->useAttributeAsKey('name')
  67.                     ->prototype('array')
  68.                         ->addDefaultsIfNotSet()
  69.                         ->children()
  70.                             ->arrayNode('path_patterns')
  71.                                 ->example(['^/api', '^/api(?!/admin)'])
  72.                                 ->prototype('scalar')->end()
  73.                             ->end()
  74.                         ->end()
  75.                     ->end()
  76.                 ->end()
  77.                 ->arrayNode('models')
  78.                     ->addDefaultsIfNotSet()
  79.                     ->children()
  80.                         ->booleanNode('use_jms')->defaultFalse()->end()
  81.                     ->end()
  82.                 ->end()
  83.             ->end();
  85.         return $treeBuilder;
  86.     }
  87. }