php-translation / symfony-bundle

DependencyInjection/Configuration.php

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <tobias.nyholm@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Translation\Bundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Translation\Bundle\EditInPlace\Activator;

/**
 * This is the class that validates and merges configuration from your app/config files.
 */
class Configuration implements ConfigurationInterface
{
    private $container;

    public function __construct(ContainerBuilder $container)
    {
        $this->container = $container;
    }

    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder(): TreeBuilder
    {
        $treeBuilder = new TreeBuilder('translation');
        // Keep compatibility with symfony/config < 4.2
        if (!\method_exists($treeBuilder, 'getRootNode')) {
            $root = $treeBuilder->root('translation');

The method root() does not exist on Symfony\Component\Config\Definition\Builder\TreeBuilder.

        } else {
            $root = $treeBuilder->getRootNode();
        }

        $this->configsNode($root);
        $this->addAutoTranslateNode($root);
        $this->addEditInPlaceNode($root);
        $this->addWebUINode($root);

        $isProfilerEnabled = $this->container->getParameter('kernel.debug') && $this->container->has('profiler');

        $root
            ->children()
                ->arrayNode('locales')
                    ->prototype('scalar')->end()
                ->end()
                ->scalarNode('default_locale')->info('Your default language or fallback locale. Default will be kernel.default_locale')->end()
                ->arrayNode('symfony_profiler')
                    ->addDefaultsIfNotSet()
                    ->treatFalseLike(['enabled' => false])
                    ->treatTrueLike(['enabled' => true])
                    ->treatNullLike(['enabled' => $isProfilerEnabled])
                    ->info('Extend the debug profiler with information about requests.')
                    ->children()
                        ->booleanNode('enabled')
                            ->info('Turn the symfony profiler integration on or off. Defaults to kernel debug mode.')
                            ->defaultValue($isProfilerEnabled)
                        ->end()
                        ->scalarNode('formatter')->defaultNull()->end()
                        ->integerNode('captured_body_length')
                            ->defaultValue(0)
                            ->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).')
                        ->end()
                    ->end()
                    ->children()
                        ->booleanNode('allow_edit')->defaultTrue()->end()
                    ->end()
                ->end()
                ->arrayNode('auto_add_missing_translations')
                    ->canBeEnabled()
                    ->children()
                        ->scalarNode('config_name')->defaultValue('default')->end()
                    ->end()
                ->end()
                ->scalarNode('http_client')->cannotBeEmpty()->defaultValue('httplug.client')->end()
                ->scalarNode('message_factory')->cannotBeEmpty()->defaultValue('httplug.message_factory')->end()
            ->end();

        return $treeBuilder;
    }

    private function configsNode(ArrayNodeDefinition $root): void
    {
        $container = $this->container;
        $root->children()
            ->arrayNode('configs')
            ->addDefaultChildrenIfNoneSet('default')
                ->useAttributeAsKey('name')
                ->prototype('array')
                    ->fixXmlConfig('dir', 'dirs')
                    ->fixXmlConfig('excluded_dir')
                    ->fixXmlConfig('excluded_name')
                    ->fixXmlConfig('blacklist_domain')
                    ->fixXmlConfig('external_translations_dir')
                    ->fixXmlConfig('whitelist_domain')
                    ->children()
                        ->arrayNode('dirs')
                            ->info('Directories we should scan for translations')
                            ->prototype('scalar')
                                ->validate()
                                    ->always(function ($value) use ($container) {
                                        $value = \str_replace(\DIRECTORY_SEPARATOR, '/', $value);

                                        if ('@' === $value[0]) {
                                            if (false === $pos = \strpos($value, '/')) {
                                                $bundleName = \substr($value, 1);
                                            } else {
                                                $bundleName = \substr($value, 1, $pos - 2);
                                            }

                                            $bundles = $container->getParameter('kernel.bundles');
                                            if (!isset($bundles[$bundleName])) {
                                                throw new \Exception(\sprintf('The bundle "%s" does not exist. Available bundles: %s', $bundleName, \array_keys($bundles)));
                                            }

                                            $ref = new \ReflectionClass($bundles[$bundleName]);
                                            $value = false === $pos ? \dirname($ref->getFileName()) : \dirname($ref->getFileName()).\substr($value, $pos);
                                        }

                                        if (!\is_dir($value)) {
                                            throw new \Exception(\sprintf('The directory "%s" does not exist.', $value));
                                        }

                                        return $value;
                                    })
                                ->end()
                            ->end()
                        ->end()
                        ->arrayNode('excluded_dirs')
                            ->prototype('scalar')->end()
                        ->end()
                        ->arrayNode('excluded_names')
                            ->prototype('scalar')->end()
                        ->end()
                        ->arrayNode('external_translations_dirs')
                            ->prototype('scalar')->end()
                        ->end()
                        ->scalarNode('output_format')->defaultValue('xlf')->end()
                        ->arrayNode('blacklist_domains')
                            ->prototype('scalar')->end()
                        ->end()
                        ->arrayNode('whitelist_domains')
                            ->prototype('scalar')->end()
                        ->end()
                        ->arrayNode('remote_storage')
                            ->info('Service ids with to classes that supports remote storage of translations.')
                            ->prototype('scalar')->end()
                        ->end()
                        ->arrayNode('local_storage')
                            ->defaultValue(['php_translation.local_file_storage.abstract'])
                            ->info('Service ids with to classes that supports local storage of translations.')
                            ->prototype('scalar')->end()
                        ->end()
                        ->scalarNode('output_dir')->cannotBeEmpty()->defaultValue('%kernel.project_dir%/Resources/translations')->end()
                        ->scalarNode('project_root')->info("The root dir of your project. By default this will be kernel_root's parent.")->end()
                        ->scalarNode('xliff_version')->info('The version of XLIFF XML you want to use (if dumping to this format).')->defaultValue('2.0')->end()
                        ->variableNode('local_file_storage_options')
                            ->info('Options passed to the local file storage\'s dumper.')
                            ->defaultValue([])
                            ->validate()
                                ->ifTrue(function ($value) {
                                    return !\is_array($value);
                                })
                                ->thenInvalid('"local_file_storage_options" must be an array.')
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end()
        ->end();
    }

    private function addAutoTranslateNode(ArrayNodeDefinition $root): void
    {
        $root->children()
            ->arrayNode('fallback_translation')
                ->canBeEnabled()
                ->children()
                    ->enumNode('service')->values(['google', 'yandex', 'bing'])->defaultValue('google')->end()
                    ->scalarNode('api_key')->defaultNull()->end()
                ->end()
            ->end()
        ->end();
    }

    private function addEditInPlaceNode(ArrayNodeDefinition $root): void
    {
        $root->children()
            ->arrayNode('edit_in_place')
                ->canBeEnabled()
                ->children()
                    ->scalarNode('config_name')->defaultValue('default')->end()
                    ->scalarNode('activator')->cannotBeEmpty()->defaultValue(Activator::class)->end()
                    ->scalarNode('show_untranslatable')->defaultTrue()->end()
                ->end()
            ->end()
        ->end();
    }

    private function addWebUINode(ArrayNodeDefinition $root): void
    {
        $root->children()
            ->arrayNode('webui')
                ->canBeEnabled()
                ->children()
                    ->booleanNode('allow_create')->defaultTrue()->end()
                    ->booleanNode('allow_delete')->defaultTrue()->end()
                    ->scalarNode('file_base_path')->defaultNull()->info('Base path for SourceLocation\'s. Defaults to "%kernel.project_dir%".')->end()
                ->end()
            ->end()
        ->end();
    }
}