vendor/php-translation/symfony-bundle/DependencyInjection/Configuration.php line 37

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the PHP Translation package.
  5.  *
  6.  * (c) PHP Translation team <tobias.nyholm@gmail.com>
  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 Translation\Bundle\DependencyInjection;
  14. use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
  15. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  16. use Symfony\Component\Config\Definition\ConfigurationInterface;
  17. use Symfony\Component\DependencyInjection\ContainerBuilder;
  19. /**
  20.  * This is the class that validates and merges configuration from your app/config files.
  21.  */
  22. class Configuration implements ConfigurationInterface
  23. {
  24.     private $container;
  26.     public function __construct(ContainerBuilder $container)
  27.     {
  28.         $this->container = $container;
  29.     }
  31.     /**
  32.      * {@inheritdoc}
  33.      */
  34.     public function getConfigTreeBuilder()
  35.     {
  36.         $treeBuilder = new TreeBuilder();
  37.         $root = $treeBuilder->root('translation');
  39.         $this->configsNode($root);
  40.         $this->addAutoTranslateNode($root);
  41.         $this->addEditInPlaceNode($root);
  42.         $this->addWebUINode($root);
  44.         $debug = $this->container->getParameter('kernel.debug');
  45.         $root
  46.             ->children()
  47.                 ->arrayNode('locales')
  48.                     ->prototype('scalar')->end()
  49.                 ->end()
  50.                 ->scalarNode('default_locale')->info('Your default language or fallback locale. Default will be kernel.default_locale')->end()
  51.                 ->arrayNode('symfony_profiler')
  52.                     ->addDefaultsIfNotSet()
  53.                     ->treatFalseLike(['enabled' => false])
  54.                     ->treatTrueLike(['enabled' => true])
  55.                     ->treatNullLike(['enabled' => $debug])
  56.                     ->info('Extend the debug profiler with information about requests.')
  57.                     ->children()
  58.                         ->booleanNode('enabled')
  59.                             ->info('Turn the symfony profiler integration on or off. Defaults to kernel debug mode.')
  60.                             ->defaultValue($debug)
  61.                         ->end()
  62.                         ->scalarNode('formatter')->defaultNull()->end()
  63.                         ->integerNode('captured_body_length')
  64.                             ->defaultValue(0)
  65.                             ->info('Limit long HTTP message bodies to x characters. If set to 0 we do not read the message body. Only available with the default formatter (FullHttpMessageFormatter).')
  66.                         ->end()
  67.                     ->end()
  68.                     ->children()
  69.                         ->booleanNode('allow_edit')->defaultTrue()->end()
  70.                     ->end()
  71.                 ->end()
  72.                 ->arrayNode('auto_add_missing_translations')
  73.                     ->canBeEnabled()
  74.                     ->children()
  75.                         ->scalarNode('config_name')->defaultValue('default')->end()
  76.                     ->end()
  77.                 ->end()
  78.                 ->scalarNode('http_client')->cannotBeEmpty()->defaultValue('httplug.client')->end()
  79.                 ->scalarNode('message_factory')->cannotBeEmpty()->defaultValue('httplug.message_factory')->end()
  80.             ->end();
  82.         return $treeBuilder;
  83.     }
  85.     /**
  86.      * @param ArrayNodeDefinition $root
  87.      */
  88.     private function configsNode(ArrayNodeDefinition $root)
  89.     {
  90.         $container = $this->container;
  91.         $root->children()
  92.             ->arrayNode('configs')
  93.             ->addDefaultChildrenIfNoneSet('default')
  94.                 ->useAttributeAsKey('name')
  95.                 ->prototype('array')
  96.                     ->fixXmlConfig('dir', 'dirs')
  97.                     ->fixXmlConfig('excluded_dir')
  98.                     ->fixXmlConfig('excluded_name')
  99.                     ->fixXmlConfig('blacklist_domain')
  100.                     ->fixXmlConfig('external_translations_dir')
  101.                     ->fixXmlConfig('whitelist_domain')
  102.                     ->children()
  103.                         ->arrayNode('dirs')
  104.                             ->info('Directories we should scan for translations')
  105.                             ->prototype('scalar')
  106.                                 ->validate()
  107.                                     ->always(function ($value) use ($container) {
  108.                                         $value = str_replace(DIRECTORY_SEPARATOR, '/', $value);
  110.                                         if ('@' === $value[0]) {
  111.                                             if (false === $pos = strpos($value, '/')) {
  112.                                                 $bundleName = substr($value, 1);
  113.                                             } else {
  114.                                                 $bundleName = substr($value, 1, $pos - 2);
  115.                                             }
  117.                                             $bundles = $container->getParameter('kernel.bundles');
  118.                                             if (!isset($bundles[$bundleName])) {
  119.                                                 throw new \Exception(sprintf('The bundle "%s" does not exist. Available bundles: %s', $bundleName, array_keys($bundles)));
  120.                                             }
  122.                                             $ref = new \ReflectionClass($bundles[$bundleName]);
  123.                                             $value = false === $pos ? dirname($ref->getFileName()) : dirname($ref->getFileName()).substr($value, $pos);
  124.                                         }
  126.                                         if (!is_dir($value)) {
  127.                                             throw new \Exception(sprintf('The directory "%s" does not exist.', $value));
  128.                                         }
  130.                                         return $value;
  131.                                     })
  132.                                 ->end()
  133.                             ->end()
  134.                         ->end()
  135.                         ->arrayNode('excluded_dirs')
  136.                             ->prototype('scalar')->end()
  137.                         ->end()
  138.                         ->arrayNode('excluded_names')
  139.                             ->prototype('scalar')->end()
  140.                         ->end()
  141.                         ->arrayNode('external_translations_dirs')
  142.                             ->prototype('scalar')->end()
  143.                         ->end()
  144.                         ->enumNode('output_format')->values(['php', 'yml', 'xlf', 'po'])->defaultValue('xlf')->end()
  145.                         ->arrayNode('blacklist_domains')
  146.                             ->prototype('scalar')->end()
  147.                         ->end()
  148.                         ->arrayNode('whitelist_domains')
  149.                             ->prototype('scalar')->end()
  150.                         ->end()
  151.                         ->arrayNode('remote_storage')
  152.                             ->info('Service ids with to classes that supports remote storage of translations.')
  153.                             ->prototype('scalar')->end()
  154.                         ->end()
  155.                         ->arrayNode('local_storage')
  156.                             ->defaultValue(['php_translation.local_file_storage.abstract'])
  157.                             ->info('Service ids with to classes that supports local storage of translations.')
  158.                             ->prototype('scalar')->end()
  159.                         ->end()
  160.                         ->scalarNode('output_dir')->cannotBeEmpty()->defaultValue('%kernel.root_dir%/Resources/translations')->end()
  161.                         ->scalarNode('project_root')->info("The root dir of your project. By default this will be kernel_root's parent.")->end()
  162.                         ->scalarNode('xliff_version')->info('The version of XLIFF XML you want to use (if dumping to this format).')->defaultValue('2.0')->end()
  163.                         ->variableNode('local_file_storage_options')
  164.                             ->info('Options passed to the local file storage\'s dumper.')
  165.                             ->defaultValue([])
  166.                             ->validate()
  167.                                 ->ifTrue(function ($value) {
  168.                                     return !is_array($value);
  169.                                 })
  170.                                 ->thenInvalid('"local_file_storage_options" must be an array.')
  171.                             ->end()
  172.                         ->end()
  173.                     ->end()
  174.                 ->end()
  175.             ->end()
  176.         ->end();
  177.     }
  179.     private function addAutoTranslateNode(ArrayNodeDefinition $root)
  180.     {
  181.         $root->children()
  182.             ->arrayNode('fallback_translation')
  183.                 ->canBeEnabled()
  184.                 ->children()
  185.                     ->enumNode('service')->values(['google', 'yandex'])->defaultValue('google')->end()
  186.                     ->scalarNode('api_key')->defaultNull()->end()
  187.                 ->end()
  188.             ->end()
  189.         ->end();
  190.     }
  192.     private function addEditInPlaceNode(ArrayNodeDefinition $root)
  193.     {
  194.         $root->children()
  195.             ->arrayNode('edit_in_place')
  196.                 ->canBeEnabled()
  197.                 ->children()
  198.                     ->scalarNode('config_name')->defaultValue('default')->end()
  199.                     ->scalarNode('activator')->cannotBeEmpty()->defaultValue('php_translation.edit_in_place.activator')->end()
  200.                     ->scalarNode('show_untranslatable')->defaultTrue()->end()
  201.                 ->end()
  202.             ->end()
  203.         ->end();
  204.     }
  206.     private function addWebUINode(ArrayNodeDefinition $root)
  207.     {
  208.         $root->children()
  209.             ->arrayNode('webui')
  210.                 ->canBeEnabled()
  211.                 ->children()
  212.                     ->booleanNode('allow_create')->defaultTrue()->end()
  213.                     ->booleanNode('allow_delete')->defaultTrue()->end()
  214.                     ->scalarNode('file_base_path')->defaultNull()->info('Base path for SourceLocation\'s. Defaults to "%kernel.project_dir%".')->end()
  215.                 ->end()
  216.             ->end()
  217.         ->end();
  218.     }
  219. }