Completed
Push — master ( fba80d...62bf5d )
by Tobias
05:54
created

TranslationExtension::getAlias()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 0
loc 4
rs 10
ccs 0
cts 0
cp 0
cc 1
eloc 2
nc 1
nop 0
crap 2
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\DependencyInjection\ContainerBuilder;
15
use Symfony\Component\Config\FileLocator;
16
use Symfony\Component\DependencyInjection\DefinitionDecorator;
17
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
18
use Symfony\Component\DependencyInjection\Reference;
19
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
20
use Symfony\Component\DependencyInjection\Loader;
21
use Symfony\Component\HttpKernel\Kernel;
22
use Translation\Bundle\Service\StorageService;
23
24
/**
25
 * This is the class that loads and manages your bundle configuration.
26
 *
27
 * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
28
 */
29
class TranslationExtension extends Extension
30
{
31
    /**
32
     * {@inheritdoc}
33
     */
34 1
    public function load(array $configs, ContainerBuilder $container)
35
    {
36 1
        $configuration = new Configuration($container);
37 1
        $config = $this->processConfiguration($configuration, $configs);
38 1
        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
39
40 1
        $loader->load('services.yml');
41 1
        $loader->load('extractors.yml');
42
43
        // Add major version to extractor
44 1
        $container->getDefinition('php_translation.extractor.php.visitor.FormTypeChoices')
45 1
            ->addMethodCall('setSymfonyMajorVersion', [Kernel::MAJOR_VERSION]);
46
47 1
        $container->setParameter('php_translation.locales', $config['locales']);
48 1
        $container->setParameter('php_translation.default_locale', isset($config['default_locale']) ? $config['default_locale'] : $container->getParameter('kernel.default_locale'));
49 1
        $this->handleConfigNode($container, $config);
50
51 1
        if ($config['webui']['enabled']) {
52 1
            $this->enableWebUi($container, $config);
53 1
        } else {
54
            $container->setParameter('php_translation.webui.enabled', false);
55
        }
56
57 1
        if ($config['symfony_profiler']['enabled']) {
58
            $loader->load('symfony_profiler.yml');
59
            $this->enableSymfonyProfiler($container, $config);
60
        }
61
62 1
        if ($config['edit_in_place']['enabled']) {
63 1
            $loader->load('edit_in_place.yml');
64 1
            $this->enableEditInPlace($container, $config);
65 1
        }
66
67 1
        if ($config['auto_add_missing_translations']['enabled']) {
68
            $loader->load('auto_add.yml');
69
            $container->getDefinition('php_translator.auto_adder')
70
                ->replaceArgument(0, new Reference('php_translation.storage.'.$config['auto_add_missing_translations']['config_name']));
71
        }
72
73 1
        if ($config['fallback_translation']['enabled']) {
74
            $loader->load('auto_translation.yml');
75
            $this->enableFallbackAutoTranslator($container, $config);
76
        }
77 1
    }
78
79
    /**
80
     * Handle the config node to prepare the config manager.
81
     *
82
     * @param ContainerBuilder $container
83
     * @param array            $config
84
     */
85 1
    private function handleConfigNode(ContainerBuilder $container, array $config)
86
    {
87
        // $first will be the "default" configuration.
88 1
        $first = null;
89 1
        foreach ($config['configs'] as $name => &$c) {
90
            if ($first === null || $name === 'default') {
91
                $first = $name;
92
            }
93
            if (empty($c['project_root'])) {
94
                // Add a project root of none is set.
95
                $c['project_root'] = dirname($container->getParameter('kernel.root_dir'));
96
            }
97
98
            $storageDefinition = $container->register('php_translation.storage.'.$name, StorageService::class);
99
100
            // Register a file storage
101
            $def = new DefinitionDecorator('php_translation.single_storage.file.abstract');
102
            $def->replaceArgument(2, $c['output_dir'])
103
                ->addTag('php_translation.storage', ['type' => 'local', 'name' => $name]);
104
            $container->setDefinition('php_translation.single_storage.file.'.$name, $def);
105
106
            // Add storages
107
            if (!empty($c['remote_storage'])) {
108
                foreach ($c['remote_storage'] as $serviceId) {
109
                    $storageDefinition->addMethodCall('addRemoteStorage', [new Reference($serviceId)]);
110
                }
111
            }
112
            if (!empty($c['local_storage'])) {
113
                foreach ($c['local_storage'] as $serviceId) {
114
                    $storageDefinition->addMethodCall('addLocalStorage', [new Reference($serviceId)]);
115
                }
116
            }
117 1
        }
118
119 1
        if ($first !== null) {
120
            // Create some aliases for the default storage
121
            $container->setAlias(
122
                'php_translation.storage',
123
                'php_translation.storage.'.$first
124
            );
125
            $container->setAlias(
126
                'php_translation.storage.default',
127
                'php_translation.storage.'.$first
128
            );
129
        }
130
131 1
        $container->getDefinition('php_translation.configuration_manager')
132 1
            ->replaceArgument(0, $config['configs']);
133 1
    }
134
135
    /**
136
     * Handle config for WebUI.
137
     *
138
     * @param ContainerBuilder $container
139
     * @param array            $config
140
     */
141
    private function enableWebUi(ContainerBuilder $container, array $config)
142
    {
143
        $container->setParameter('php_translation.webui.enabled', true);
144
        $container->setParameter('php_translation.webui.allow_create', $config['webui']['allow_create']);
145
        $container->setParameter('php_translation.webui.allow_delete', $config['webui']['allow_delete']);
146
    }
147
148
    /**
149
     * Handle config for EditInPlace.
150
     *
151
     * @param ContainerBuilder $container
152
     * @param array            $config
153
     */
154
    private function enableEditInPlace(ContainerBuilder $container, array $config)
155
    {
156
        $name = $config['edit_in_place']['config_name'];
157
158
        if ($name !== 'default' and !isset($config['configs'][$name])) {
0 ignored issues
show
Comprehensibility Best Practice introduced by
Using logical operators such as and instead of && is generally not recommended.

PHP has two types of connecting operators (logical operators, and boolean operators):

  Logical Operators Boolean Operator
AND - meaning and &&
OR - meaning or ||

The difference between these is the order in which they are executed. In most cases, you would want to use a boolean operator like &&, or ||.

Let’s take a look at a few examples:

// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);

Logical Operators are used for Control-Flow

One case where you explicitly want to use logical operators is for control-flow such as this:

$x === 5
    or die('$x must be 5.');

// Instead of
if ($x !== 5) {
    die('$x must be 5.');
}

Since die introduces problems of its own, f.e. it makes our code hardly testable, and prevents any kind of more sophisticated error handling; you probably do not want to use this in real-world code. Unfortunately, logical operators cannot be combined with throw at this point:

// The following is currently a parse error.
$x === 5
    or throw new RuntimeException('$x must be 5.');

These limitations lead to logical operators rarely being of use in current PHP code.

Loading history...
159
            throw new InvalidArgumentException(sprintf('There is no config named "%s".', $name));
160
        }
161
162
        $activatorRef = new Reference($config['edit_in_place']['activator']);
163
164
        $def = $container->getDefinition('php_translation.edit_in_place.response_listener');
165
        $def->replaceArgument(0, $activatorRef);
166
        $def->replaceArgument(3, $name);
167
168
        $def = $container->getDefinition('php_translator.edit_in_place.xtrans_html_translator');
169
        $def->replaceArgument(1, $activatorRef);
170
    }
171
172
    /**
173
     * Handle config for Symfony Profiler.
174
     *
175
     * @param ContainerBuilder $container
176
     * @param array            $config
177
     */
178
    private function enableSymfonyProfiler(ContainerBuilder $container, array $config)
179
    {
180
        $container->setParameter('php_translation.toolbar.allow_edit', $config['symfony_profiler']['allow_edit']);
181
    }
182
183
    /**
184
     * Handle config for fallback auto translate.
185
     *
186
     * @param ContainerBuilder $container
187
     * @param array            $config
188
     */
189
    private function enableFallbackAutoTranslator(ContainerBuilder $container, array $config)
190
    {
191
        $externalTranslatorId = 'php_translation.translator_service.'.$config['fallback_translation']['service'];
192
        $externalTranslatorDef = $container->getDefinition($externalTranslatorId);
193
        $externalTranslatorDef->addTag('php_translation.external_translator');
194
        $externalTranslatorDef->addArgument(new Reference($config['http_client']));
195
        $externalTranslatorDef->addArgument(new Reference($config['message_factory']));
196
197
        $container->setParameter('php_translation.translator_service.api_key', $config['fallback_translation']['api_key']);
198
    }
199
200
    /**
201
     * {@inheritdoc}
202
     */
203
    public function getAlias()
204
    {
205
        return 'translation';
206
    }
207
}
208