vendor/sonata-project/translation-bundle/src/DependencyInjection/Configuration.php line 124

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\TranslationBundle\DependencyInjection;
  16. use Sonata\TranslationBundle\Enum\TranslationFilterMode;
  17. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  18. use Symfony\Component\Config\Definition\ConfigurationInterface;
  20. /**
  21.  * @final since sonata-project/translation-bundle 2.7
  22.  *
  23.  * @author Nicolas Bastien <nbastien.pro@gmail.com>
  24.  */
  25. class Configuration implements ConfigurationInterface
  26. {
  27.     /**
  28.      * @psalm-suppress PossiblyNullReference, PossiblyUndefinedMethod
  29.      *
  30.      * @see https://github.com/psalm/psalm-plugin-symfony/issues/174
  31.      */
  32.     public function getConfigTreeBuilder()
  33.     {
  34.         $treeBuilder = new TreeBuilder('sonata_translation');
  36.         $rootNode = $treeBuilder->getRootNode();
  38.         $rootNode
  39.             ->children()
  40.                 ->arrayNode('locales')
  41.                     ->info('The list of your frontend locales in which your models will be translatable.')
  42.                     ->requiresAtLeastOneElement()
  43.                     ->prototype('scalar')->end()
  44.                 ->end()
  45.                 ->scalarNode('default_locale')
  46.                     ->defaultValue('en')
  47.                     ->info('The frontend locale that is used by default.')
  48.                 ->end()
  49.                 ->enumNode('default_filter_mode')
  50.                     ->values(TranslationFilterMode::AVAILABLE_FILTER_TYPES)
  51.                     ->defaultValue(TranslationFilterMode::GEDMO)
  52.                     ->info('The filter mode that is used by default.')
  53.                 ->end()
  54.                 ->arrayNode('gedmo')
  55.                     ->canBeEnabled()
  56.                     ->children()
  57.                         ->arrayNode('implements')
  58.                             ->requiresAtLeastOneElement()
  59.                             ->prototype('scalar')->end()
  60.                         ->end()
  61.                         ->arrayNode('instanceof')
  62.                             ->requiresAtLeastOneElement()
  63.                             ->prototype('scalar')->end()
  64.                         ->end()
  65.                         ->scalarNode('translatable_listener_service')
  66.                             ->info('Custom translatable listener service name when using gedmo/doctrine-extensions')
  67.                             // NEXT_MAJOR: Remove default value.
  68.                             ->defaultValue(static function (): string {
  69.                                 @trigger_error(
  70.                                     'Not specifying the translatable listener service when using'
  71.                                     .' gedmo/doctrine-extensions is deprecated since sonata-project/translation-bundle 2.8.'
  72.                                     .' If you are using a bundle that integrates this library, it is likely that it'
  73.                                     .' registers that service for you. In case of "stof/doctrine-extensions-bundle", it is:'
  74.                                     .' "stof_doctrine_extensions.listener.translatable".'
  75.                                 );
  77.                                 return 'stof_doctrine_extensions.listener.translatable';
  78.                             })
  79.                         ->end()
  80.                     ->end()
  81.                 ->end()
  82.                 ->arrayNode('knplabs')
  83.                     ->canBeEnabled()
  84.                     ->children()
  85.                         ->arrayNode('implements')
  86.                             ->requiresAtLeastOneElement()
  87.                             ->prototype('scalar')->end()
  88.                         ->end()
  89.                         ->arrayNode('instanceof')
  90.                             ->requiresAtLeastOneElement()
  91.                             ->prototype('scalar')->end()
  92.                         ->end()
  93.                     ->end()
  94.                 ->end()
  95.                 ->arrayNode('phpcr')
  96.                     ->canBeEnabled()
  97.                     ->children()
  98.                         ->arrayNode('implements')
  99.                             ->requiresAtLeastOneElement()
  100.                             ->prototype('scalar')->end()
  101.                         ->end()
  102.                         ->arrayNode('instanceof')
  103.                             ->requiresAtLeastOneElement()
  104.                             ->prototype('scalar')->end()
  105.                         ->end()
  106.                     ->end()
  107.                 ->end()
  108.                 ->booleanNode('locale_switcher')
  109.                     ->info('Enable the global locale switcher services.')
  110.                     ->defaultFalse()
  111.                 ->end()
  112.                 // NEXT_MAJOR: Fix locale to country flag mapping OR remove country flags entirely
  113.                 ->booleanNode('locale_switcher_show_country_flags')
  114.                     ->info('Whether the language switcher should show languages as flags')
  115.                     ->defaultTrue()
  116.                 ->end()
  117.             ->end()
  118.             ->beforeNormalization()
  119.                 ->ifTrue(static function ($v) {return !isset($v['locale_switcher_show_country_flags']) || true === $v['locale_switcher_show_country_flags']; })
  120.                 ->then(static function ($v) {
  121.                     @trigger_error(sprintf(
  122.                         'Showing the country flags is deprecated. The flags will be removed in the next major version. Please set "%s" to false to avoid this message.',
  123.                         'sonata_translation.locale_switcher_show_country_flags'
  124.                     ), \E_USER_DEPRECATED);
  125.                     $v['locale_switcher_show_country_flags'] = $v['locale_switcher_show_country_flags'] ?? true;
  127.                     return $v;
  128.                 })
  129.             ->end();
  131.         return $treeBuilder;
  132.     }
  133. }