Completed
Push — master ( f96c7c...8d3ead )
by Mathieu
02:17 queued 10s
created

TranslationExtension::enableWebUi()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 17

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 10
CRAP Score 3.0067

Importance

Changes 0
Metric Value
dl 0
loc 17
ccs 10
cts 11
cp 0.9091
rs 9.7
c 0
b 0
f 0
cc 3
nc 3
nop 2
crap 3.0067
1
<?php
2
3
/*
4
 * This file is part of the PHP Translation package.
5
 *
6
 * (c) PHP Translation team <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Translation\Bundle\DependencyInjection;
13
14
use Symfony\Component\Config\FileLocator;
15
use Symfony\Component\DependencyInjection\Alias;
16
use Symfony\Component\DependencyInjection\ChildDefinition;
17
use Symfony\Component\DependencyInjection\ContainerBuilder;
18
use Symfony\Component\DependencyInjection\DefinitionDecorator;
19
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
20
use Symfony\Component\DependencyInjection\Loader;
21
use Symfony\Component\DependencyInjection\Reference;
22
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
23
use Symfony\Component\HttpKernel\Kernel;
24
use Translation\Bundle\Model\Configuration as ConfigurationModel;
25
26
/**
27
 * This is the class that loads and manages your bundle configuration.
28
 *
29
 * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
30
 */
31
class TranslationExtension extends Extension
32
{
33
    /**
34
     * {@inheritdoc}
35
     */
36 8
    public function load(array $configs, ContainerBuilder $container): void
37
    {
38 8
        $configuration = new Configuration($container);
39 8
        $config = $this->processConfiguration($configuration, $configs);
40 8
        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
41
42 8
        $loader->load('services.yml');
43 8
        $loader->load('extractors.yml');
44
45
        // Add major version to extractor
46 8
        $container->getDefinition('php_translation.extractor.php.visitor.FormTypeChoices')
47 8
            ->addMethodCall('setSymfonyMajorVersion', [Kernel::MAJOR_VERSION]);
48
49 8
        $container->setParameter('php_translation.locales', $config['locales']);
50 8
        $container->setParameter('php_translation.default_locale',
51 8
            $config['default_locale'] ?? $container->getParameter('kernel.default_locale'));
52 8
        $this->handleConfigNode($container, $config);
53
54 8
        if ($config['webui']['enabled']) {
55 1
            $this->enableWebUi($container, $config);
56
        } else {
57 7
            $container->setParameter('php_translation.webui.enabled', false);
58
        }
59
60 8
        if ($config['symfony_profiler']['enabled']) {
61 8
            $loader->load('symfony_profiler.yml');
62 8
            $this->enableSymfonyProfiler($container, $config);
63
        }
64
65 8
        if ($config['edit_in_place']['enabled']) {
66 1
            $loader->load('edit_in_place.yml');
67 1
            $this->enableEditInPlace($container, $config);
68
        }
69
70 8
        if ($config['auto_add_missing_translations']['enabled']) {
71 1
            $loader->load('auto_add.yml');
72 1
            $container->getDefinition('php_translator.auto_adder')
73 1
                ->replaceArgument(0, new Reference('php_translation.storage.'.$config['auto_add_missing_translations']['config_name']));
74
        }
75
76 8
        if ($config['fallback_translation']['enabled']) {
77 1
            $loader->load('auto_translation.yml');
78 1
            $this->enableFallbackAutoTranslator($container, $config);
79
        }
80
81 8
        if ('test' === \getenv('ENV')) {
82 8
            $loader->load('services_test.yml');
83
        }
84
85 8
        $loader->load('console.yml');
86 8
    }
87
88
    /**
89
     * Handle the config node to prepare the config manager.
90
     */
91 8
    private function handleConfigNode(ContainerBuilder $container, array $config): void
92
    {
93 8
        $storageManager = $container->getDefinition('php_translation.storage_manager');
94 8
        $configurationManager = $container->getDefinition('php_translation.configuration_manager');
95
        // $first will be the "default" configuration.
96 8
        $first = null;
97 8
        foreach ($config['configs'] as $name => &$c) {
98 8
            if (null === $first || 'default' === $name) {
99 8
                $first = $name;
100
            }
101 8
            if (empty($c['project_root'])) {
102
                // Add a project root of none is set.
103 8
                $c['project_root'] = \dirname($container->getParameter('kernel.root_dir'));
104
            }
105 8
            $c['name'] = $name;
106 8
            $c['locales'] = $config['locales'];
107 8
            $configurationServiceId = 'php_translation.configuration.'.$name;
108 8
            $configDef = $container->register($configurationServiceId, ConfigurationModel::class);
109 8
            $configDef->setPublic(false)->addArgument($c);
110 8
            $configurationManager->addMethodCall('addConfiguration', [$name, new Reference($configurationServiceId)]);
111
112
            /*
113
             * Configure storage chain service
114
             */
115 8
            $storageDefinition = $this->createChildDefinition('php_translation.storage.abstract');
116 8
            $storageDefinition->replaceArgument(2, new Reference($configurationServiceId));
117 8
            $storageDefinition->setPublic(true);
118 8
            $container->setDefinition('php_translation.storage.'.$name, $storageDefinition);
119 8
            $storageManager->addMethodCall('addStorage', [$name, new Reference('php_translation.storage.'.$name)]);
120
121
            // Add storages
122 8
            foreach ($c['remote_storage'] as $serviceId) {
123
                $storageDefinition->addMethodCall('addRemoteStorage', [new Reference($serviceId)]);
124
            }
125
126 8
            foreach ($c['local_storage'] as $serviceId) {
127 8
                if ('php_translation.local_file_storage.abstract' !== $serviceId) {
128
                    $storageDefinition->addMethodCall('addLocalStorage', [new Reference($serviceId)]);
129
130
                    continue;
131
                }
132
133 8
                $def = $this->createChildDefinition($serviceId);
134 8
                $def->replaceArgument(2, [$c['output_dir']])
135 8
                    ->replaceArgument(3, $c['local_file_storage_options'])
136 8
                    ->addTag('php_translation.storage', ['type' => 'local', 'name' => $name]);
137 8
                $container->setDefinition('php_translation.single_storage.file.'.$name, $def);
138
            }
139
        }
140
141 8
        if (null !== $first) {
142
            // Create some aliases for the default storage
143 8
            $container->setAlias('php_translation.storage', new Alias('php_translation.storage.'.$first, true));
144 8
            if ('default' !== $first) {
145
                $container->setAlias('php_translation.storage.default', new Alias('php_translation.storage.'.$first, true));
146
            }
147
        }
148 8
    }
149
150
    /**
151
     * Handle config for WebUI.
152
     */
153 1
    private function enableWebUi(ContainerBuilder $container, array $config): void
154
    {
155 1
        $container->setParameter('php_translation.webui.enabled', true);
156 1
        $container->setParameter('php_translation.webui.allow_create', $config['webui']['allow_create']);
157 1
        $container->setParameter('php_translation.webui.allow_delete', $config['webui']['allow_delete']);
158
159 1
        $path = $config['webui']['file_base_path'];
160 1
        if (null === $path) {
161 1
            if ($container->hasParameter('kernel.project_dir')) {
162
                $path = $container->getParameter('kernel.project_dir');
163
            } else {
164 1
                $path = $container->getParameter('kernel.root_dir').'/..';
165
            }
166
        }
167
168 1
        $container->setParameter('php_translation.webui.file_base_path', \rtrim($path, '/').'/');
169 1
    }
170
171
    /**
172
     * Handle config for EditInPlace.
173
     */
174 1
    private function enableEditInPlace(ContainerBuilder $container, array $config): void
175
    {
176 1
        $name = $config['edit_in_place']['config_name'];
177
178 1
        if ('default' !== $name && !isset($config['configs'][$name])) {
179
            throw new InvalidArgumentException(\sprintf('There is no config named "%s".', $name));
180
        }
181
182 1
        $activatorRef = new Reference($config['edit_in_place']['activator']);
183
184 1
        $def = $container->getDefinition('php_translation.edit_in_place.response_listener');
185 1
        $def->replaceArgument(0, $activatorRef);
186 1
        $def->replaceArgument(3, $name);
187 1
        $def->replaceArgument(4, $config['edit_in_place']['show_untranslatable']);
188
189 1
        $def = $container->getDefinition('php_translator.edit_in_place.xtrans_html_translator');
190 1
        $def->replaceArgument(1, $activatorRef);
191
192 1
        $def = $container->getDefinition('php_translation.edit_in_place.extension.trans');
193 1
        $def->addMethodCall('setActivator', [$activatorRef]);
194 1
    }
195
196
    /**
197
     * Handle config for Symfony Profiler.
198
     */
199 8
    private function enableSymfonyProfiler(ContainerBuilder $container, array $config): void
200
    {
201 8
        $container->setParameter('php_translation.toolbar.allow_edit', $config['symfony_profiler']['allow_edit']);
202 8
    }
203
204
    /**
205
     * Handle config for fallback auto translate.
206
     */
207 1
    private function enableFallbackAutoTranslator(ContainerBuilder $container, array $config): void
208
    {
209 1
        $externalTranslatorId = 'php_translation.translator_service.'.$config['fallback_translation']['service'];
210 1
        $externalTranslatorDef = $container->getDefinition($externalTranslatorId);
211 1
        $externalTranslatorDef->addTag('php_translation.external_translator');
212 1
        $externalTranslatorDef->addArgument(new Reference($config['http_client']));
213 1
        $externalTranslatorDef->addArgument(new Reference($config['message_factory']));
214
215 1
        $container->setParameter('php_translation.translator_service.api_key', $config['fallback_translation']['api_key']);
216 1
    }
217
218
    /**
219
     * {@inheritdoc}
220
     */
221 8
    public function getAlias(): string
222
    {
223 8
        return 'translation';
224
    }
225
226
    /**
227
     * To avoid BC break for Symfony 3.3+.
228
     *
229
     * @return ChildDefinition|DefinitionDecorator
230
     */
231 8
    private function createChildDefinition(string $parent)
232
    {
233 8
        if (\class_exists(ChildDefinition::class)) {
234 8
            return new ChildDefinition($parent);
235
        }
236
237
        return new DefinitionDecorator($parent);
238
    }
239
240
    /**
241
     * {@inheritdoc}
242
     */
243
    public function getConfiguration(array $config, ContainerBuilder $container): Configuration
244
    {
245
        return new Configuration($container);
246
    }
247
}
248