vendor/nelmio/api-doc-bundle/Nelmio/ApiDocBundle/DependencyInjection/Configuration.php line 23

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the NelmioApiDocBundle.
  5.  *
  6.  * (c) Nelmio <hello@nelm.io>
  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. class Configuration implements ConfigurationInterface
  18. {
  19.     public function getConfigTreeBuilder()
  20.     {
  21.         $treeBuilder = new TreeBuilder();
  22.         $treeBuilder
  23.             ->root('nelmio_api_doc')
  24.             ->children()
  25.                 ->scalarNode('name')->defaultValue('API documentation')->end()
  26.                 ->arrayNode('exclude_sections')
  27.                     ->prototype('scalar')
  28.                     ->end()
  29.                 ->end()
  30.                 ->booleanNode('default_sections_opened')->defaultTrue()->end()
  31.                 ->arrayNode('motd')
  32.                     ->addDefaultsIfNotSet()
  33.                     ->children()
  34.                         ->scalarNode('template')->defaultValue('@NelmioApiDoc/Components/motd.html.twig')->end()
  35.                     ->end()
  36.                 ->end()
  37.                 ->arrayNode('request_listener')
  38.                     ->beforeNormalization()
  39.                         ->ifTrue(function ($a) { return is_bool($a); })
  40.                         ->then(function ($a) { return array('enabled' => $a); })
  41.                     ->end()
  42.                     ->addDefaultsIfNotSet()
  43.                     ->children()
  44.                         ->booleanNode('enabled')->defaultTrue()->end()
  45.                         ->scalarNode('parameter')->defaultValue('_doc')->end()
  46.                     ->end()
  47.                 ->end()
  48.                 ->arrayNode('sandbox')
  49.                     ->addDefaultsIfNotSet()
  50.                     ->children()
  51.                         ->scalarNode('enabled')->defaultTrue()->end()
  52.                         ->scalarNode('endpoint')->defaultNull()->end()
  53.                         ->scalarNode('accept_type')->defaultNull()->end()
  54.                         ->arrayNode('body_format')
  55.                             ->addDefaultsIfNotSet()
  56.                             ->beforeNormalization()
  57.                                 ->ifString()
  58.                                 ->then(function ($v) { return array('default_format' => $v); })
  59.                             ->end()
  60.                             ->children()
  61.                                 ->arrayNode('formats')
  62.                                     ->defaultValue(array('form', 'json'))
  63.                                     ->prototype('scalar')->end()
  64.                                 ->end()
  65.                                 ->enumNode('default_format')
  66.                                     ->values(array('form', 'json'))
  67.                                     ->defaultValue('form')
  68.                                 ->end()
  69.                             ->end()
  70.                         ->end()
  71.                         ->arrayNode('request_format')
  72.                             ->addDefaultsIfNotSet()
  73.                             ->children()
  74.                                 ->arrayNode('formats')
  75.                                     ->defaultValue(array(
  76.                                         'json' => 'application/json',
  77.                                         'xml' => 'application/xml'
  78.                                     ))
  79.                                     ->prototype('scalar')->end()
  80.                                 ->end()
  81.                                 ->enumNode('method')
  82.                                     ->values(array('format_param', 'accept_header'))
  83.                                     ->defaultValue('format_param')
  84.                                 ->end()
  85.                                 ->scalarNode('default_format')->defaultValue('json')->end()
  86.                             ->end()
  87.                         ->end()
  88.                         ->arrayNode('authentication')
  89.                             ->children()
  90.                                 ->scalarNode('delivery')
  91.                                     ->isRequired()
  92.                                     ->validate()
  93.                                         ->ifNotInArray(array('query', 'http', 'header'))
  94.                                         ->thenInvalid("Unknown authentication delivery type '%s'.")
  95.                                     ->end()
  96.                                 ->end()
  97.                                 ->scalarNode('name')->isRequired()->end()
  98.                                 ->enumNode('type')
  99.                                     ->info('Required if http delivery is selected.')
  100.                                     ->values(array('basic', 'bearer'))
  101.                                 ->end()
  102.                                 ->booleanNode('custom_endpoint')->defaultFalse()->end()
  103.                             ->end()
  104.                             ->validate()
  105.                                 ->ifTrue(function ($v) {
  106.                                     return 'http' === $v['delivery'] && !$v['type'] ;
  107.                                 })
  108.                                 ->thenInvalid('"type" is required when using http delivery.')
  109.                             ->end()
  110.                             # http_basic BC
  111.                             ->beforeNormalization()
  112.                                 ->ifTrue(function ($v) {
  113.                                     return 'http_basic' === $v['delivery'];
  114.                                 })
  115.                                 ->then(function ($v) {
  116.                                     $v['delivery'] = 'http';
  117.                                     $v['type'] = 'basic';
  119.                                     return $v;
  120.                                 })
  121.                             ->end()
  122.                             ->beforeNormalization()
  123.                                 ->ifTrue(function ($v) {
  124.                                     return 'http' === $v['delivery'];
  125.                                 })
  126.                                 ->then(function ($v) {
  127.                                     if ('http' === $v['delivery'] && !isset($v['name'])) {
  128.                                         $v['name'] = 'Authorization';
  129.                                     }
  131.                                     return $v;
  132.                                 })
  133.                             ->end()
  134.                         ->end()
  135.                         ->booleanNode('entity_to_choice')->defaultTrue()->end()
  136.                     ->end()
  137.                 ->end()
  138.                 ->arrayNode('swagger')
  139.                     ->addDefaultsIfNotSet()
  140.                     ->children()
  141.                         ->scalarNode('model_naming_strategy')->defaultValue('dot_notation')->end()
  142.                         ->scalarNode('api_base_path')->defaultValue('/api')->end()
  143.                         ->scalarNode('swagger_version')->defaultValue('1.2')->end()
  144.                         ->scalarNode('api_version')->defaultValue('0.1')->end()
  145.                         ->arrayNode('info')
  146.                             ->addDefaultsIfNotSet()
  147.                                 ->children()
  148.                                     ->scalarNode('title')->defaultValue('Symfony2')->end()
  149.                                     ->scalarNode('description')->defaultValue('My awesome Symfony2 app!')->end()
  150.                                     ->scalarNode('TermsOfServiceUrl')->defaultNull()->end()
  151.                                     ->scalarNode('contact')->defaultNull()->end()
  152.                                     ->scalarNode('license')->defaultNull()->end()
  153.                                     ->scalarNode('licenseUrl')->defaultNull()->end()
  154.                                 ->end()
  155.                         ->end()
  156.                     ->end()
  157.                 ->end()
  158.                 ->arrayNode('cache')
  159.                     ->addDefaultsIfNotSet()
  160.                     ->children()
  161.                         ->booleanNode('enabled')->defaultFalse()->end()
  162.                         ->scalarNode('file')->defaultValue('%kernel.cache_dir%/api-doc.cache')->end()
  163.                     ->end()
  164.                 ->end()
  165.             ->end();
  167.         return $treeBuilder;
  168.     }
  169. }