vendor/sonata-project/exporter/src/Bridge/Symfony/DependencyInjection/Configuration.php line 29

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the Sonata Project package.
  7.  *
  8.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Sonata\Exporter\Bridge\Symfony\DependencyInjection;
  16. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  17. use Symfony\Component\Config\Definition\ConfigurationInterface;
  19. /**
  20.  * This is the class that validates and merges configuration from your app/config files.
  21.  *
  22.  * @author Grégoire Paris <postmaster@greg0ire.fr>
  23.  */
  24. final class Configuration implements ConfigurationInterface
  25. {
  26.     public function getConfigTreeBuilder(): TreeBuilder
  27.     {
  28.         $treeBuilder = new TreeBuilder();
  29.         $rootNode = $treeBuilder->root('sonata_exporter');
  31.         $rootNode
  32.             ->children()
  33.                 ->arrayNode('exporter')
  34.                     ->addDefaultsIfNotSet()
  35.                     ->children()
  36.                         ->arrayNode('default_writers')
  37.                             ->defaultValue(['csv', 'json', 'xls', 'xml'])
  38.                             ->prototype('scalar')->end()
  39.                         ->end()
  40.                     ->end()
  41.                 ->end()
  42.                 ->arrayNode('writers')
  43.                     ->addDefaultsIfNotSet()
  44.                     ->children()
  45.                         ->arrayNode('csv')
  46.                             ->addDefaultsIfNotSet()
  47.                             ->children()
  48.                                 ->scalarNode('filename')
  49.                                     ->defaultValue('php://output')
  50.                                     ->info('path to the output file')
  51.                                 ->end()
  52.                                 ->scalarNode('delimiter')
  53.                                     ->defaultValue(',')
  54.                                     ->info('delimits csv values')
  55.                                 ->end()
  56.                                 ->scalarNode('enclosure')
  57.                                     ->defaultValue('"')
  58.                                     ->info('will be used when a value contains the delimiter')
  59.                                 ->end()
  60.                                 ->scalarNode('escape')
  61.                                     ->defaultValue('\\')
  62.                                     ->info('will be used when a value contains the enclosure')
  63.                                 ->end()
  64.                                 ->booleanNode('show_headers')
  65.                                     ->defaultValue(true)
  66.                                     ->info('add column names as the first line')
  67.                                 ->end()
  68.                                 ->booleanNode('with_bom')
  69.                                     ->defaultValue(false)
  70.                                     ->info('include the byte order mark')
  71.                                 ->end()
  72.                             ->end()
  73.                         ->end()
  74.                         ->arrayNode('json')
  75.                             ->addDefaultsIfNotSet()
  76.                             ->children()
  77.                                 ->scalarNode('filename')
  78.                                     ->defaultValue('php://output')
  79.                                     ->info('path to the output file')
  80.                                 ->end()
  81.                             ->end()
  82.                         ->end()
  83.                         ->arrayNode('xls')
  84.                             ->addDefaultsIfNotSet()
  85.                             ->children()
  86.                                 ->scalarNode('filename')
  87.                                     ->defaultValue('php://output')
  88.                                     ->info('path to the output file')
  89.                                 ->end()
  90.                                 ->booleanNode('show_headers')
  91.                                     ->defaultValue(true)
  92.                                     ->info('add column names as the first line')
  93.                                 ->end()
  94.                             ->end()
  95.                         ->end()
  96.                         ->arrayNode('xml')
  97.                             ->addDefaultsIfNotSet()
  98.                             ->children()
  99.                                 ->scalarNode('filename')
  100.                                     ->defaultValue('php://output')
  101.                                     ->info('path to the output file')
  102.                                 ->end()
  103.                                 ->booleanNode('show_headers')
  104.                                     ->defaultValue(true)
  105.                                     ->info('add column names as the first line')
  106.                                 ->end()
  107.                                 ->scalarNode('main_element')
  108.                                     ->defaultValue('datas')
  109.                                     ->info('name of the wrapping element')
  110.                                 ->end()
  111.                                 ->scalarNode('child_element')
  112.                                     ->defaultValue('data')
  113.                                     ->info('name of elements corresponding to rows')
  114.                                 ->end()
  115.                             ->end()
  116.                         ->end()
  117.                     ->end()
  118.                 ->end()
  119.             ->end()
  120.         ;
  122.         return $treeBuilder;
  123.     }
  124. }