vendor/vich/uploader-bundle/DependencyInjection/Configuration.php line 28

Open in your IDE?
  1. <?php
  3. namespace Vich\UploaderBundle\DependencyInjection;
  5. use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
  6. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  7. use Symfony\Component\Config\Definition\ConfigurationInterface;
  8. use Symfony\Component\HttpKernel\Kernel;
  10. /**
  11.  * Configuration.
  12.  *
  13.  * @author Dustin Dobervich <ddobervich@gmail.com>
  14.  */
  15. class Configuration implements ConfigurationInterface
  16. {
  17.     protected $supportedDbDrivers = ['orm', 'mongodb', 'propel', 'phpcr'];
  19.     protected $supportedStorages = ['gaufrette', 'flysystem', 'file_system'];
  21.     public function getConfigTreeBuilder(): TreeBuilder
  22.     {
  23.         if (Kernel::VERSION_ID >= 40200) {
  24.             $builder = new TreeBuilder('vich_uploader');
  25.         } else {
  26.             $builder = new TreeBuilder();
  27.         }
  28.         $root = $builder->root('vich_uploader');
  29.         $this->addGeneralSection($root);
  30.         $this->addMetadataSection($root);
  31.         $this->addMappingsSection($root);
  33.         return $builder;
  34.     }
  36.     protected function addGeneralSection(ArrayNodeDefinition $node): void
  37.     {
  38.         $node
  39.             ->children()
  40.                 ->scalarNode('default_filename_attribute_suffix')
  41.                     ->defaultValue('_name')
  42.                 ->end()
  43.                 ->scalarNode('db_driver')
  44.                     ->isRequired()
  45.                     ->beforeNormalization()
  46.                         ->ifString()
  47.                         ->then(function ($v) {
  48.                             return \strtolower($v);
  49.                         })
  50.                     ->end()
  51.                     ->validate()
  52.                         ->ifNotInArray($this->supportedDbDrivers)
  53.                         ->thenInvalid('The db driver %s is not supported. Please choose one of '.\implode(', ', $this->supportedDbDrivers))
  54.                     ->end()
  55.                 ->end()
  56.                 ->scalarNode('storage')
  57.                     ->defaultValue('file_system')
  58.                     ->beforeNormalization()
  59.                         ->ifString()
  60.                         ->then(function ($v) {
  61.                             return \strtolower($v);
  62.                         })
  63.                     ->end()
  64.                     ->validate()
  65.                         ->ifTrue(function ($storage) {
  66.                             return 0 !== \strpos($storage, '@') && !\in_array($storage, $this->supportedStorages, true);
  67.                         })
  68.                         ->thenInvalid('The storage %s is not supported. Please choose one of '.\implode(', ', $this->supportedStorages).' or provide a service name prefixed with "@".')
  69.                     ->end()
  70.                 ->end()
  71.             ->scalarNode('templating')->defaultTrue()->end()
  72.             ->scalarNode('twig')->defaultTrue()->info('twig requires templating')->end()
  73.             ->scalarNode('form')->defaultTrue()->end()
  74.             ->end()
  75.         ;
  76.     }
  78.     protected function addMetadataSection(ArrayNodeDefinition $node): void
  79.     {
  80.         $node
  81.             ->children()
  82.                 ->arrayNode('metadata')
  83.                     ->addDefaultsIfNotSet()
  84.                     ->fixXmlConfig('directory', 'directories')
  85.                     ->children()
  86.                         ->scalarNode('cache')->defaultValue('file')->end()
  87.                         ->arrayNode('file_cache')
  88.                             ->addDefaultsIfNotSet()
  89.                             ->children()
  90.                                 ->scalarNode('dir')->defaultValue('%kernel.cache_dir%/vich_uploader')->end()
  91.                             ->end()
  92.                         ->end()
  93.                         ->booleanNode('auto_detection')->defaultTrue()->end()
  94.                         ->arrayNode('directories')
  95.                             ->prototype('array')
  96.                                 ->children()
  97.                                     ->scalarNode('path')->isRequired()->end()
  98.                                     ->scalarNode('namespace_prefix')->defaultValue('')->end()
  99.                                 ->end()
  100.                             ->end()
  101.                         ->end()
  102.                     ->end()
  103.                 ->end()
  104.             ->end();
  105.     }
  107.     protected function addMappingsSection(ArrayNodeDefinition $node): void
  108.     {
  109.         $node
  110.             ->children()
  111.                 ->arrayNode('mappings')
  112.                     ->useAttributeAsKey('id')
  113.                     ->prototype('array')
  114.                         ->children()
  115.                             ->scalarNode('uri_prefix')->defaultValue('/uploads')->end()
  116.                             ->scalarNode('upload_destination')->isRequired()->end()
  117.                             ->arrayNode('namer')
  118.                                 ->addDefaultsIfNotSet()
  119.                                 ->beforeNormalization()
  120.                                     ->ifString()
  121.                                     ->then(function ($v) {
  122.                                         return ['service' => $v, 'options' => []];
  123.                                     })
  124.                                 ->end()
  125.                                 ->children()
  126.                                 ->scalarNode('service')->defaultNull()->end()
  127.                                 ->variableNode('options')->defaultNull()->end()
  128.                                 ->end()
  129.                             ->end()
  130.                             ->arrayNode('directory_namer')
  131.                                 ->addDefaultsIfNotSet()
  132.                                 ->beforeNormalization()
  133.                                     ->ifString()
  134.                                     ->then(function ($v) {
  135.                                         return ['service' => $v, 'options' => []];
  136.                                     })
  137.                                 ->end()
  138.                                 ->children()
  139.                                 ->scalarNode('service')->defaultNull()->end()
  140.                                 ->variableNode('options')->defaultNull()->end()
  141.                                 ->end()
  142.                             ->end()
  143.                             ->scalarNode('delete_on_remove')->defaultTrue()->end()
  144.                             ->scalarNode('delete_on_update')->defaultTrue()->end()
  145.                             ->scalarNode('inject_on_load')->defaultFalse()->end()
  146.                             ->scalarNode('db_driver')
  147.                                 ->defaultNull()
  148.                                 ->beforeNormalization()
  149.                                     ->ifString()
  150.                                     ->then(function ($v) {
  151.                                         return \strtolower($v);
  152.                                     })
  153.                                 ->end()
  154.                                 ->validate()
  155.                                     ->ifNotInArray($this->supportedDbDrivers)
  156.                                     ->thenInvalid('The db driver %s is not supported. Please choose one of '.\implode(', ', $this->supportedDbDrivers))
  157.                                 ->end()
  158.                             ->end()
  159.                         ->end()
  160.                     ->end()
  161.                 ->end()
  162.             ->end();
  163.     }
  164. }