TranslationExtension::enableEditInPlace() - Code Metrics - Inspection of "Only measure code coverage on Unit tests. (#242)" - php-translation/symfony-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 130d29...c9c04e )

by Tobias

created 2018-06-26 12:53 UTC

TranslationExtension::enableEditInPlace() A

↳ Parent: TranslationExtension

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	3.0032

Importance

Changes

Metric	Value
dl	0
loc	21
ccs	13
cts	14
cp	0.9286
rs	9.584
c	0
b	0
f	0
cc	3
nc	2
nop	2
crap	3.0032

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <[email protected]>
 *
 * 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\DependencyInjection\Alias;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ChildDefinition;
use Symfony\Component\DependencyInjection\DefinitionDecorator;
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
use Symfony\Component\DependencyInjection\Loader;
use Symfony\Component\HttpKernel\Kernel;
use Translation\Bundle\Model\Configuration as ConfigurationModel;

/**
 * This is the class that loads and manages your bundle configuration.
 *
 * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
 */
class TranslationExtension extends Extension
{
    /**
     * {@inheritdoc}
     */
    public function load(array $configs, ContainerBuilder $container)
    {
        $configuration = new Configuration($container);
        $config = $this->processConfiguration($configuration, $configs);
        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));

        $loader->load('services.yml');
        $loader->load('extractors.yml');

        // Add major version to extractor
        $container->getDefinition('php_translation.extractor.php.visitor.FormTypeChoices')
            ->addMethodCall('setSymfonyMajorVersion', [Kernel::MAJOR_VERSION]);

        $container->setParameter('php_translation.locales', $config['locales']);
        $container->setParameter('php_translation.default_locale', isset($config['default_locale']) ? $config['default_locale'] : $container->getParameter('kernel.default_locale'));
        $this->handleConfigNode($container, $config);

        if ($config['webui']['enabled']) {
            $this->enableWebUi($container, $config);
        } else {
            $container->setParameter('php_translation.webui.enabled', false);
        }

        if ($config['symfony_profiler']['enabled']) {
            $loader->load('symfony_profiler.yml');
            $this->enableSymfonyProfiler($container, $config);
        }

        if ($config['edit_in_place']['enabled']) {
            $loader->load('edit_in_place.yml');
            $this->enableEditInPlace($container, $config);
        }

        if ($config['auto_add_missing_translations']['enabled']) {
            $loader->load('auto_add.yml');
            $container->getDefinition('php_translator.auto_adder')
                ->replaceArgument(0, new Reference('php_translation.storage.'.$config['auto_add_missing_translations']['config_name']));
        }

        if ($config['fallback_translation']['enabled']) {
            $loader->load('auto_translation.yml');
            $this->enableFallbackAutoTranslator($container, $config);
        }

        if ('test' === getenv('ENV')) {
            $loader->load('services_test.yml');
        }

        $loader->load('console.yml');
    }

    /**
     * Handle the config node to prepare the config manager.
     *
     * @param ContainerBuilder $container
     * @param array            $config
     */
    private function handleConfigNode(ContainerBuilder $container, array $config)
    {
        $storageManager = $container->getDefinition('php_translation.storage_manager');
        $configurationManager = $container->getDefinition('php_translation.configuration_manager');
        // $first will be the "default" configuration.
        $first = null;
        foreach ($config['configs'] as $name => &$c) {
            if (null === $first || 'default' === $name) {
                $first = $name;
            }
            if (empty($c['project_root'])) {
                // Add a project root of none is set.
                $c['project_root'] = dirname($container->getParameter('kernel.root_dir'));
            }
            $c['name'] = $name;
            $c['locales'] = $config['locales'];
            $configurationServiceId = 'php_translation.configuration.'.$name;
            $configDef = $container->register($configurationServiceId, ConfigurationModel::class);
            $configDef->setPublic(false)->addArgument($c);
            $configurationManager->addMethodCall('addConfiguration', [$name, new Reference($configurationServiceId)]);

            /*
             * Configure storage chain service
             */
            $storageDefinition = $this->createChildDefinition('php_translation.storage.abstract');
            $storageDefinition->replaceArgument(2, new Reference($configurationServiceId));
            $storageDefinition->setPublic(true);
            $container->setDefinition('php_translation.storage.'.$name, $storageDefinition);
            $storageManager->addMethodCall('addStorage', [$name, new Reference('php_translation.storage.'.$name)]);

            // Add storages
            foreach ($c['remote_storage'] as $serviceId) {
                $storageDefinition->addMethodCall('addRemoteStorage', [new Reference($serviceId)]);
            }

            foreach ($c['local_storage'] as $serviceId) {
                if ('php_translation.local_file_storage.abstract' !== $serviceId) {
                    $storageDefinition->addMethodCall('addLocalStorage', [new Reference($serviceId)]);

                    continue;
                }

                $def = $this->createChildDefinition($serviceId);
                $def->replaceArgument(2, [$c['output_dir']])
                    ->replaceArgument(3, $c['local_file_storage_options'])
                    ->addTag('php_translation.storage', ['type' => 'local', 'name' => $name]);
                $container->setDefinition('php_translation.single_storage.file.'.$name, $def);
            }
        }

        if (null !== $first) {
            // Create some aliases for the default storage
            $container->setAlias('php_translation.storage', new Alias('php_translation.storage.'.$first, true));
            if ('default' !== $first) {
                $container->setAlias('php_translation.storage.default', new Alias('php_translation.storage.'.$first, true));
            }
        }
    }

    /**
     * Handle config for WebUI.
     *
     * @param ContainerBuilder $container
     * @param array            $config
     */
    private function enableWebUi(ContainerBuilder $container, array $config)
    {
        $container->setParameter('php_translation.webui.enabled', true);
        $container->setParameter('php_translation.webui.allow_create', $config['webui']['allow_create']);
        $container->setParameter('php_translation.webui.allow_delete', $config['webui']['allow_delete']);

        $path = $config['webui']['file_base_path'];
        if (null === $path) {
            if ($container->hasParameter('kernel.project_dir')) {
                $path = $container->getParameter('kernel.project_dir');
            } else {
                $path = $container->getParameter('kernel.root_dir').'/..';
            }
        }

        $container->setParameter('php_translation.webui.file_base_path', rtrim($path, '/').'/');
    }

    /**
     * Handle config for EditInPlace.
     *
     * @param ContainerBuilder $container
     * @param array            $config
     */
    private function enableEditInPlace(ContainerBuilder $container, array $config)
    {
        $name = $config['edit_in_place']['config_name'];

        if ('default' !== $name && !isset($config['configs'][$name])) {
            throw new InvalidArgumentException(sprintf('There is no config named "%s".', $name));
        }

        $activatorRef = new Reference($config['edit_in_place']['activator']);

        $def = $container->getDefinition('php_translation.edit_in_place.response_listener');
        $def->replaceArgument(0, $activatorRef);
        $def->replaceArgument(3, $name);
        $def->replaceArgument(4, $config['edit_in_place']['show_untranslatable']);

        $def = $container->getDefinition('php_translator.edit_in_place.xtrans_html_translator');
        $def->replaceArgument(1, $activatorRef);

        $def = $container->getDefinition('php_translation.edit_in_place.extension.trans');
        $def->addMethodCall('setActivator', [$activatorRef]);
    }

    /**
     * Handle config for Symfony Profiler.
     *
     * @param ContainerBuilder $container
     * @param array            $config
     */
    private function enableSymfonyProfiler(ContainerBuilder $container, array $config)
    {
        $container->setParameter('php_translation.toolbar.allow_edit', $config['symfony_profiler']['allow_edit']);
    }

    /**
     * Handle config for fallback auto translate.
     *
     * @param ContainerBuilder $container
     * @param array            $config
     */
    private function enableFallbackAutoTranslator(ContainerBuilder $container, array $config)
    {
        $externalTranslatorId = 'php_translation.translator_service.'.$config['fallback_translation']['service'];
        $externalTranslatorDef = $container->getDefinition($externalTranslatorId);
        $externalTranslatorDef->addTag('php_translation.external_translator');
        $externalTranslatorDef->addArgument(new Reference($config['http_client']));
        $externalTranslatorDef->addArgument(new Reference($config['message_factory']));

        $container->setParameter('php_translation.translator_service.api_key', $config['fallback_translation']['api_key']);
    }

    /**
     * {@inheritdoc}
     */
    public function getAlias()
    {
        return 'translation';
    }

    /**
     * To avoid BC break for Symfony 3.3+.
     *
     * @param $parent
     *
     * @return ChildDefinition|DefinitionDecorator
     */
    private function createChildDefinition($parent)
    {
        if (class_exists('Symfony\Component\DependencyInjection\ChildDefinition')) {
            return new ChildDefinition($parent);
        }

        return new DefinitionDecorator($parent);
    }

    /**
     * {@inheritdoc}
     */
    public function getConfiguration(array $config, ContainerBuilder $container)
    {
        return new Configuration($container);
    }
}


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\Alias;
15		use Symfony\Component\DependencyInjection\ContainerBuilder;
16		use Symfony\Component\Config\FileLocator;
17		use Symfony\Component\DependencyInjection\ChildDefinition;
18		use Symfony\Component\DependencyInjection\DefinitionDecorator;
19		use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
20		use Symfony\Component\DependencyInjection\Reference;
21		use Symfony\Component\HttpKernel\DependencyInjection\Extension;
22		use Symfony\Component\DependencyInjection\Loader;
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)
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', isset($config['default_locale']) ? $config['default_locale'] : $container->getParameter('kernel.default_locale'));
51	8	$this->handleConfigNode($container, $config);
52
53	8	if ($config['webui']['enabled']) {
54	1	$this->enableWebUi($container, $config);
55		} else {
56	7	$container->setParameter('php_translation.webui.enabled', false);
57		}
58
59	8	if ($config['symfony_profiler']['enabled']) {
60	8	$loader->load('symfony_profiler.yml');
61	8	$this->enableSymfonyProfiler($container, $config);
62		}
63
64	8	if ($config['edit_in_place']['enabled']) {
65	1	$loader->load('edit_in_place.yml');
66	1	$this->enableEditInPlace($container, $config);
67		}
68
69	8	if ($config['auto_add_missing_translations']['enabled']) {
70	1	$loader->load('auto_add.yml');
71	1	$container->getDefinition('php_translator.auto_adder')
72	1	->replaceArgument(0, new Reference('php_translation.storage.'.$config['auto_add_missing_translations']['config_name']));
73		}
74
75	8	if ($config['fallback_translation']['enabled']) {
76	1	$loader->load('auto_translation.yml');
77	1	$this->enableFallbackAutoTranslator($container, $config);
78		}
79
80	8	if ('test' === getenv('ENV')) {
81	8	$loader->load('services_test.yml');
82		}
83
84	8	$loader->load('console.yml');
85	8	}
86
87		/**
88		* Handle the config node to prepare the config manager.
89		*
90		* @param ContainerBuilder $container
91		* @param array $config
92		*/
93	8	private function handleConfigNode(ContainerBuilder $container, array $config)
94		{
95	8	$storageManager = $container->getDefinition('php_translation.storage_manager');
96	8	$configurationManager = $container->getDefinition('php_translation.configuration_manager');
97		// $first will be the "default" configuration.
98	8	$first = null;
99	8	foreach ($config['configs'] as $name => &$c) {
100	8	if (null === $first \|\| 'default' === $name) {
101	8	$first = $name;
102		}
103	8	if (empty($c['project_root'])) {
104		// Add a project root of none is set.
105	8	$c['project_root'] = dirname($container->getParameter('kernel.root_dir'));
106		}
107	8	$c['name'] = $name;
108	8	$c['locales'] = $config['locales'];
109	8	$configurationServiceId = 'php_translation.configuration.'.$name;
110	8	$configDef = $container->register($configurationServiceId, ConfigurationModel::class);
111	8	$configDef->setPublic(false)->addArgument($c);
112	8	$configurationManager->addMethodCall('addConfiguration', [$name, new Reference($configurationServiceId)]);
113
114		/*
115		* Configure storage chain service
116		*/
117	8	$storageDefinition = $this->createChildDefinition('php_translation.storage.abstract');
118	8	$storageDefinition->replaceArgument(2, new Reference($configurationServiceId));
119	8	$storageDefinition->setPublic(true);
120	8	$container->setDefinition('php_translation.storage.'.$name, $storageDefinition);
121	8	$storageManager->addMethodCall('addStorage', [$name, new Reference('php_translation.storage.'.$name)]);
122
123		// Add storages
124	8	foreach ($c['remote_storage'] as $serviceId) {
125		$storageDefinition->addMethodCall('addRemoteStorage', [new Reference($serviceId)]);
126		}
127
128	8	foreach ($c['local_storage'] as $serviceId) {
129	8	if ('php_translation.local_file_storage.abstract' !== $serviceId) {
130		$storageDefinition->addMethodCall('addLocalStorage', [new Reference($serviceId)]);
131
132		continue;
133		}
134
135	8	$def = $this->createChildDefinition($serviceId);
136	8	$def->replaceArgument(2, [$c['output_dir']])
137	8	->replaceArgument(3, $c['local_file_storage_options'])
138	8	->addTag('php_translation.storage', ['type' => 'local', 'name' => $name]);
139	8	$container->setDefinition('php_translation.single_storage.file.'.$name, $def);
140		}
141		}
142
143	8	if (null !== $first) {
144		// Create some aliases for the default storage
145	8	$container->setAlias('php_translation.storage', new Alias('php_translation.storage.'.$first, true));
146	8	if ('default' !== $first) {
147		$container->setAlias('php_translation.storage.default', new Alias('php_translation.storage.'.$first, true));
148		}
149		}
150	8	}
151
152		/**
153		* Handle config for WebUI.
154		*
155		* @param ContainerBuilder $container
156		* @param array $config
157		*/
158	1	private function enableWebUi(ContainerBuilder $container, array $config)
159		{
160	1	$container->setParameter('php_translation.webui.enabled', true);
161	1	$container->setParameter('php_translation.webui.allow_create', $config['webui']['allow_create']);
162	1	$container->setParameter('php_translation.webui.allow_delete', $config['webui']['allow_delete']);
163
164	1	$path = $config['webui']['file_base_path'];
165	1	if (null === $path) {
166	1	if ($container->hasParameter('kernel.project_dir')) {
167		$path = $container->getParameter('kernel.project_dir');
168		} else {
169	1	$path = $container->getParameter('kernel.root_dir').'/..';
170		}
171		}
172
173	1	$container->setParameter('php_translation.webui.file_base_path', rtrim($path, '/').'/');
174	1	}
175
176		/**
177		* Handle config for EditInPlace.
178		*
179		* @param ContainerBuilder $container
180		* @param array $config
181		*/
182	1	private function enableEditInPlace(ContainerBuilder $container, array $config)
183		{
184	1	$name = $config['edit_in_place']['config_name'];
185
186	1	if ('default' !== $name && !isset($config['configs'][$name])) {
187		throw new InvalidArgumentException(sprintf('There is no config named "%s".', $name));
188		}
189
190	1	$activatorRef = new Reference($config['edit_in_place']['activator']);
191
192	1	$def = $container->getDefinition('php_translation.edit_in_place.response_listener');
193	1	$def->replaceArgument(0, $activatorRef);
194	1	$def->replaceArgument(3, $name);
195	1	$def->replaceArgument(4, $config['edit_in_place']['show_untranslatable']);
196
197	1	$def = $container->getDefinition('php_translator.edit_in_place.xtrans_html_translator');
198	1	$def->replaceArgument(1, $activatorRef);
199
200	1	$def = $container->getDefinition('php_translation.edit_in_place.extension.trans');
201	1	$def->addMethodCall('setActivator', [$activatorRef]);
202	1	}
203
204		/**
205		* Handle config for Symfony Profiler.
206		*
207		* @param ContainerBuilder $container
208		* @param array $config
209		*/
210	8	private function enableSymfonyProfiler(ContainerBuilder $container, array $config)
211		{
212	8	$container->setParameter('php_translation.toolbar.allow_edit', $config['symfony_profiler']['allow_edit']);
213	8	}
214
215		/**
216		* Handle config for fallback auto translate.
217		*
218		* @param ContainerBuilder $container
219		* @param array $config
220		*/
221	1	private function enableFallbackAutoTranslator(ContainerBuilder $container, array $config)
222		{
223	1	$externalTranslatorId = 'php_translation.translator_service.'.$config['fallback_translation']['service'];
224	1	$externalTranslatorDef = $container->getDefinition($externalTranslatorId);
225	1	$externalTranslatorDef->addTag('php_translation.external_translator');
226	1	$externalTranslatorDef->addArgument(new Reference($config['http_client']));
227	1	$externalTranslatorDef->addArgument(new Reference($config['message_factory']));
228
229	1	$container->setParameter('php_translation.translator_service.api_key', $config['fallback_translation']['api_key']);
230	1	}
231
232		/**
233		* {@inheritdoc}
234		*/
235	8	public function getAlias()
236		{
237	8	return 'translation';
238		}
239
240		/**
241		* To avoid BC break for Symfony 3.3+.
242		*
243		* @param $parent
244		*
245		* @return ChildDefinition\|DefinitionDecorator
246		*/
247	8	private function createChildDefinition($parent)
248		{
249	8	if (class_exists('Symfony\Component\DependencyInjection\ChildDefinition')) {
250	8	return new ChildDefinition($parent);
251		}
252
253		return new DefinitionDecorator($parent);
254		}
255
256		/**
257		* {@inheritdoc}
258		*/
259		public function getConfiguration(array $config, ContainerBuilder $container)
260		{
261		return new Configuration($container);
262		}
263		}
264

php-translation / symfony-bundle

Push — master ( 130d29...c9c04e )

TranslationExtension::enableEditInPlace() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like