Extension::getAlias() - Code Metrics - Inspection of "Documented, stabilized..." - RunOpenCode/exchange-rate-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b26542...bb7d10 )

by Nikola

created 2016-01-08 11:42 UTC

Extension::getAlias() A

↳ Parent: Extension

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/*
 * This file is part of the Exchange Rate Bundle, an RunOpenCode project.
 *
 * (c) 2016 RunOpenCode
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace RunOpenCode\Bundle\ExchangeRate\DependencyInjection;

use RunOpenCode\ExchangeRate\Configuration;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Extension\Extension as BaseExtension;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
use Symfony\Component\DependencyInjection\Reference;

/**
 * Class Extension
 *
 * Bundle extension.
 *
 * @package RunOpenCode\Bundle\ExchangeRate\DependencyInjection
 */
class Extension extends BaseExtension
{
    /**
     * {@inheritdoc}
     */
    public function getAlias()
    {
        return "run_open_code_exchange_rate";
    }

    /**
     * {@inheritdoc}
     */
    public function load(array $config, ContainerBuilder $container)
    {
        $configuration = new Configuration();

        $config = $this->processConfiguration($configuration, $config);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
        $loader->load('services.xml');

        $this->configureExchangeRateService($config, $container);
        $this->configureSourcesRegistry($config, $container);
        $this->configureProcessorsRegistry($config, $container);
        $this->configureRatesRegistry($config, $container);
        $this->configureFileRepository($config, $container);
        $this->configureController($config, $container);
        $this->configureDebugCommand($config, $container);
    }

    /**
     * Configure exchange rate service.
     *
     * @param array $config
     * @param ContainerBuilder $container
     */
    protected function configureExchangeRateService(array $config, ContainerBuilder $container)
    {
        if ($container->hasDefinition('run_open_code.exchange_rate')) {

            $definition = $container->getDefinition('run_open_code.exchange_rate');

            $definition->setArguments(array(
                $config['base_currency'],
                new Reference($config['repository']),
                new Reference('run_open_code.exchange_rate.registry.sources'),
                new Reference('run_open_code.exchange_rate.registry.processors'),
                new Reference('run_open_code.exchange_rate.registry.rates')
            ));
        }
    }

    /**
     * Configure sources registry.
     *
     * @param array $config
     * @param ContainerBuilder $container
     */
    protected function configureSourcesRegistry(array $config, ContainerBuilder $container)
    {
        if ($container->hasDefinition('run_open_code.exchange_rate.registry.sources')) {

            $definition = $container->getDefinition('run_open_code.exchange_rate.registry.sources');
            $requiredSources = $this->getRequiredSources($config);


            foreach ($container->findTaggedServiceIds('run_open_code.exchange_rate.source') as $id => $tags) {

                foreach ($tags as $attributes) {

                    if (array_key_exists($attributes['alias'], $requiredSources)) {

                        $definition->addMethodCall('add', array(
                            new Reference($id)
                        ));

                        unset($requiredSources[$attributes['alias']]);
                    }
                }
            }

            if (count($requiredSources) > 0) {
                throw new InvalidConfigurationException(sprintf('Required source(s) "%s" does not exists.', implode(', ', $requiredSources)));
            }
        }
    }

    /**
     * Configure processors registry.
     *
     * @param array $config
     * @param ContainerBuilder $container
     */
    protected function configureProcessorsRegistry(array $config, ContainerBuilder $container)
    {
        if ($container->hasDefinition('run_open_code.exchange_rate.registry.processors')) {

            $definition = $container->getDefinition('run_open_code.exchange_rate.registry.processors');

            $processors = array();

            foreach ($container->findTaggedServiceIds('run_open_code.exchange_rate.processor') as $id => $tags) {

                if (!in_array($id, $config['processors'], true)) {
                    continue;
                }

                foreach ($tags as $attributes) {
                    $processors[$id] = (isset($attributes['priority'])) ? intval($attributes['priority']) : 0;
                }
            }

            asort($processors);

            foreach ($processors as $id => $processor) {
                $definition->addMethodCall('add', array(
                    new Reference($id)
                ));
            }
        }
    }

    /**
     * Configure rates.
     *
     * @param array $config
     * @param ContainerBuilder $container
     */
    protected function configureRatesRegistry(array $config, ContainerBuilder $container)
    {
        if ($container->hasDefinition('run_open_code.exchange_rate.registry.rates')) {

            $definition = $container->getDefinition('run_open_code.exchange_rate.registry.rates');

            $aliases = array();

            /**
             * @var Configuration $rateConfiguration
             */
            foreach ($config['rates'] as $rateConfiguration) {

                if ($rateConfiguration->getAlias() === null) {
                    continue;
                }

                if (array_key_exists($rateConfiguration->getAlias(), $aliases)) {
                    throw new InvalidConfigurationException(sprintf('Rate with alias "%s" is already defined.', $rateConfiguration->getAlias()));
                }

                $aliases[$rateConfiguration->getAlias()] = $rateConfiguration;
            }

            $definition->setArguments(array(array_values($config['rates'])));
        }
    }

    /**
     * Configure file registry, if used.
     *
     * @param array $config
     * @param ContainerBuilder $container
     */
    protected function configureFileRepository(array $config, ContainerBuilder $container)
    {
        if (
            $config['repository'] === 'run_open_code.exchange_rate.repository.file_repository'
            &&
            $container->hasDefinition('run_open_code.exchange_rate.repository.file_repository')
        ) {

            if (!empty($config['file_repository']) && !empty($config['file_repository']['path'])) {
                $definition = $container->getDefinition('run_open_code.exchange_rate.repository.file_repository');
                $definition->setArguments(array(
                    $config['file_repository']['path']
                ));
            } else {
                throw new InvalidConfigurationException('You must configure location to the file where file repository will store exchange rates.');
            }

        } elseif ($config['repository'] === 'run_open_code.exchange_rate.repository.file_repository') {
            throw new InvalidConfigurationException('File repository is used to store exchange rates, but it is not available in container.');
        } else {
            $container->removeDefinition('run_open_code.exchange_rate.repository.file_repository');
        }
    }

    /**
     * Configure controller - view layer.
     *
     * @param array $config
     * @param ContainerBuilder $container
     */
    protected function configureController(array $config, ContainerBuilder $container)
    {
        if ($container->has('run_open_code.exchange_rate.controller')) {
            $definition = $container->getDefinition('run_open_code.exchange_rate.controller');
            $definition->setArguments(array(
                new Reference($config['repository']),
                $config['base_currency'],
                $config['view']
            ));
        }
    }

    /**
     * Configure debug command.
     *
     * @param array $config
     * @param ContainerBuilder $container
     */
    protected function configureDebugCommand(array $config, ContainerBuilder $container)
    {
        if ($container->has('run_open_code.exchange_rate.command.configuration_debug')) {
            $definition = $container->getDefinition('run_open_code.exchange_rate.command.configuration_debug');

            $arguments = $definition->getArguments();
            $arguments[3] = new Reference($config['repository']);

            $definition->setArguments($arguments);
        }
    }

    /**
     * Extract name of only required sources from configuration.
     *
     * @param array $config
     * @return array
     */
    protected function getRequiredSources(array $config)
    {
        $requiredSources = array();

        foreach ($config['rates'] as $rate) {
            $requiredSources[$rate['source']] = $rate['source'];
        }

        return $requiredSources;
    }
}


1		<?php
2		/*
3		* This file is part of the Exchange Rate Bundle, an RunOpenCode project.
4		*
5		* (c) 2016 RunOpenCode
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10		namespace RunOpenCode\Bundle\ExchangeRate\DependencyInjection;
11
12		use RunOpenCode\ExchangeRate\Configuration;
		0 ignored issues – show Bug introduced 2016-01-08 11:49 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `RunOpenCode\Bundle\Excha...Injection\Configuration`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
13		use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
14		use Symfony\Component\Config\FileLocator;
15		use Symfony\Component\DependencyInjection\ContainerBuilder;
16		use Symfony\Component\DependencyInjection\Extension\Extension as BaseExtension;
17	2	use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
18		use Symfony\Component\DependencyInjection\Reference;
19	2
20	2	/**
21		* Class Extension
22	2	*
23	2	* Bundle extension.
24		*
25	2	* @package RunOpenCode\Bundle\ExchangeRate\DependencyInjection
26	2	*/
27	2	class Extension extends BaseExtension
28	2	{
29	2	/**
30	2	* {@inheritdoc}
31	2	*/
32		public function getAlias()
33	2	{
34		return "run_open_code_exchange_rate";
35	2	}
36	2
37		/**
38	2	* {@inheritdoc}
39	2	*/
40	2	public function load(array $config, ContainerBuilder $container)
41	2	{
42	2	$configuration = new Configuration();
		0 ignored issues – show Bug introduced 2016-01-08 11:49 UTC by Report Bug Copy Issue Report The call to `Configuration::__construct()` misses some required arguments starting with `$currencyCode`. Loading history...
43	2	$config = $this->processConfiguration($configuration, $config);
		0 ignored issues – show Documentation introduced 2016-01-08 11:49 UTC by Report Bug Copy Issue Report `$configuration` is of type `object<RunOpenCode\ExchangeRate\Configuration>`, but the function expects a `object<Symfony\Component...ConfigurationInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
44	1
45	1	$loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
46	2	$loader->load('services.xml');
47
48	2	$this->configureExchangeRateService($config, $container);
49		$this->configureSourcesRegistry($config, $container);
50	2	$this->configureProcessorsRegistry($config, $container);
51		$this->configureRatesRegistry($config, $container);
52	2	$this->configureFileRepository($config, $container);
53		$this->configureController($config, $container);
54	2	$this->configureDebugCommand($config, $container);
55		}
56	2
57	2	/**
58	1	* Configure exchange rate service.
59		*
60		* @param array $config
61	2	* @param ContainerBuilder $container
62		*/
63	2	protected function configureExchangeRateService(array $config, ContainerBuilder $container)
64		{
65	2	if ($container->hasDefinition('run_open_code.exchange_rate')) {
66
67	2	$definition = $container->getDefinition('run_open_code.exchange_rate');
68	2
69	1	$definition->setArguments(array(
70		$config['base_currency'],
71	2	new Reference($config['repository']),
72	1	new Reference('run_open_code.exchange_rate.registry.sources'),
73	1	new Reference('run_open_code.exchange_rate.registry.processors'),
74	1	new Reference('run_open_code.exchange_rate.registry.rates')
75		));
76	2	}
77		}
78
79	1	/**
80	2	* Configure sources registry.
81		*
82	2	* @param array $config
83		* @param ContainerBuilder $container
84	2	*/
85		protected function configureSourcesRegistry(array $config, ContainerBuilder $container)
86	2	{
87		if ($container->hasDefinition('run_open_code.exchange_rate.registry.sources')) {
88	2
89		$definition = $container->getDefinition('run_open_code.exchange_rate.registry.sources');
90	2	$requiredSources = $this->getRequiredSources($config);
91
92	2
93		foreach ($container->findTaggedServiceIds('run_open_code.exchange_rate.source') as $id => $tags) {
94
95		foreach ($tags as $attributes) {
96	2
97	2	if (array_key_exists($attributes['alias'], $requiredSources)) {
98	1
99	1	$definition->addMethodCall('add', array(
100		new Reference($id)
101	2	));
102
103	2	unset($requiredSources[$attributes['alias']]);
104	2	}
105	2	}
106	1	}
107	1
108	1	if (count($requiredSources) > 0) {
109	2	throw new InvalidConfigurationException(sprintf('Required source(s) "%s" does not exists.', implode(', ', $requiredSources)));
110		}
111	2	}
112		}
113	2
114		/**
115	2	* Configure processors registry.
116		*
117	2	* @param array $config
118		* @param ContainerBuilder $container
119	2	*/
120		protected function configureProcessorsRegistry(array $config, ContainerBuilder $container)
121	2	{
122		if ($container->hasDefinition('run_open_code.exchange_rate.registry.processors')) {
123	2
124		$definition = $container->getDefinition('run_open_code.exchange_rate.registry.processors');
125
126		$processors = array();
127	2
128		foreach ($container->findTaggedServiceIds('run_open_code.exchange_rate.processor') as $id => $tags) {
129	2
130	1	if (!in_array($id, $config['processors'], true)) {
131		continue;
132	2	}
133	2
134	1	foreach ($tags as $attributes) {
135	1	$processors[$id] = (isset($attributes['priority'])) ? intval($attributes['priority']) : 0;
136	2	}
137		}
138	2
139		asort($processors);
140
141	2	foreach ($processors as $id => $processor) {
142	1	$definition->addMethodCall('add', array(
143	2	new Reference($id)
144	1	));
145		}
146	2	}
147	2	}
148	2
149	2	/**
150	1	* Configure rates.
151	1	*
152	1	* @param array $config
153		* @param ContainerBuilder $container
154		*/
155	1	protected function configureRatesRegistry(array $config, ContainerBuilder $container)
156		{
157		if ($container->hasDefinition('run_open_code.exchange_rate.registry.rates')) {
158
159		$definition = $container->getDefinition('run_open_code.exchange_rate.registry.rates');
160	2
161		$aliases = array();
162	2
163		/**
164	2	* @var Configuration $rateConfiguration
165	2	*/
166	2	foreach ($config['rates'] as $rateConfiguration) {
167	2
168	2	if ($rateConfiguration->getAlias() === null) {
169	2	continue;
170	2	}
171	2
172	1	if (array_key_exists($rateConfiguration->getAlias(), $aliases)) {
173	1	throw new InvalidConfigurationException(sprintf('Rate with alias "%s" is already defined.', $rateConfiguration->getAlias()));
174	2	}
175
176		$aliases[$rateConfiguration->getAlias()] = $rateConfiguration;
177		}
178
179	4	$definition->setArguments(array(array_values($config['rates'])));
180		}
181	4	}
182
183		/**
184		* Configure file registry, if used.
185		*
186		* @param array $config
187		* @param ContainerBuilder $container
188		*/
189		protected function configureFileRepository(array $config, ContainerBuilder $container)
190		{
191		if (
192		$config['repository'] === 'run_open_code.exchange_rate.repository.file_repository'
193		&&
194		$container->hasDefinition('run_open_code.exchange_rate.repository.file_repository')
195		) {
196
197		if (!empty($config['file_repository']) && !empty($config['file_repository']['path'])) {
198		$definition = $container->getDefinition('run_open_code.exchange_rate.repository.file_repository');
199		$definition->setArguments(array(
200		$config['file_repository']['path']
201		));
202		} else {
203		throw new InvalidConfigurationException('You must configure location to the file where file repository will store exchange rates.');
204		}
205
206		} elseif ($config['repository'] === 'run_open_code.exchange_rate.repository.file_repository') {
207		throw new InvalidConfigurationException('File repository is used to store exchange rates, but it is not available in container.');
208		} else {
209		$container->removeDefinition('run_open_code.exchange_rate.repository.file_repository');
210		}
211		}
212
213		/**
214		* Configure controller - view layer.
215		*
216		* @param array $config
217		* @param ContainerBuilder $container
218		*/
219		protected function configureController(array $config, ContainerBuilder $container)
220		{
221		if ($container->has('run_open_code.exchange_rate.controller')) {
222		$definition = $container->getDefinition('run_open_code.exchange_rate.controller');
223		$definition->setArguments(array(
224		new Reference($config['repository']),
225		$config['base_currency'],
226		$config['view']
227		));
228		}
229		}
230
231		/**
232		* Configure debug command.
233		*
234		* @param array $config
235		* @param ContainerBuilder $container
236		*/
237		protected function configureDebugCommand(array $config, ContainerBuilder $container)
238		{
239		if ($container->has('run_open_code.exchange_rate.command.configuration_debug')) {
240		$definition = $container->getDefinition('run_open_code.exchange_rate.command.configuration_debug');
241
242		$arguments = $definition->getArguments();
243		$arguments[3] = new Reference($config['repository']);
244
245		$definition->setArguments($arguments);
246		}
247		}
248
249		/**
250		* Extract name of only required sources from configuration.
251		*
252		* @param array $config
253		* @return array
254		*/
255		protected function getRequiredSources(array $config)
256		{
257		$requiredSources = array();
258
259		foreach ($config['rates'] as $rate) {
260		$requiredSources[$rate['source']] = $rate['source'];
261		}
262
263		return $requiredSources;
264		}
265		}
266

RunOpenCode / exchange-rate-bundle

Push — master ( b26542...bb7d10 )

Extension::getAlias() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like