ProfilerExtension::mergeDebugPluginArguments() - Code Metrics - Inspection of "Refactor the HttplugExtension" - php-http/HttplugBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#97)

by Tobias

created 2016-07-20 16:12 UTC

ProfilerExtension::mergeDebugPluginArguments() A

↳ Parent: ProfilerExtension

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	12
ccs	0
cts	0
cp	0
rs	9.4285
cc	3
eloc	8
nc	3
nop	2
crap	12

<?php

namespace Http\HttplugBundle\DependencyInjection;

use Http\HttplugBundle\Collector\DebugPlugin;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
use Symfony\Component\DependencyInjection\Reference;

/**
 * This class is responsible for loading profiler tools and the toolbar. This extension should generally not be used
 * in production.
 *
 * @author David Buchmann <[email protected]>
 * @author Tobias Nyholm <[email protected]>
 */
class ProfilerExtension
{
    /**
     * @param array            $config           Processed configuration
     * @param ContainerBuilder $container
     * @param array            $clientServiceIds ids of all clients
     */
    public function load(array $config, ContainerBuilder $container, array $clientServiceIds)
    {
        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
        $loader->load('data-collector.xml');

        if (!empty($config['toolbar']['formatter'])) {
            // Add custom formatter
            $container->getDefinition('httplug.collector.debug_collector')
                ->replaceArgument(0, new Reference($config['toolbar']['formatter']));
        }

        $container->getDefinition('httplug.formatter.full_http_message')
            ->addArgument($config['toolbar']['captured_body_length']);

        foreach ($clientServiceIds as $clientId) {
            $pluginClientDefinition = $container->getDefinition($clientId);
            $serviceIdDebugPlugin = $this->registerDebugPlugin($container, $clientId);

            $argument = $this->mergeDebugPluginArguments($pluginClientDefinition->getArgument(3), [new Reference($serviceIdDebugPlugin)]);
            $pluginClientDefinition->replaceArgument(3, $argument);
        }
    }

    /**
     * Create a new plugin service for this client.
     *
     * @param ContainerBuilder $container
     * @param string           $name
     *
     * @return string
     */
    private function registerDebugPlugin(ContainerBuilder $container, $name)
    {
        $serviceIdDebugPlugin = $name.'.debug_plugin';
        $container->register($serviceIdDebugPlugin, DebugPlugin::class)
            ->addArgument(new Reference('httplug.collector.debug_collector'))
            ->addArgument(substr($name, strrpos($name, '.')+1))
            ->setPublic(false);

        return $serviceIdDebugPlugin;
    }

    /**
     * @param array $existing
     * @param array $newArgument
     *
     * @return array
     */
    private function mergeDebugPluginArguments($existing, $newArgument)
    {
        if (empty($existing)) {
            $mergedArgument = ['debug_plugins' => $newArgument];
        } elseif (empty($existing['debug_plugins'])) {
            $mergedArgument['debug_plugins'] = $newArgument;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        } else {
            $mergedArgument['debug_plugins'] = array_merge($existing['debug_plugins'], $newArgument);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        }

        return $mergedArgument;
    }
}


1			<?php
2
3			namespace Http\HttplugBundle\DependencyInjection;
4
5			use Http\HttplugBundle\Collector\DebugPlugin;
6			use Symfony\Component\Config\FileLocator;
7			use Symfony\Component\DependencyInjection\ContainerBuilder;
8			use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
9			use Symfony\Component\DependencyInjection\Reference;
10
11			/**
12			* This class is responsible for loading profiler tools and the toolbar. This extension should generally not be used
13			* in production.
14			*
15			* @author David Buchmann <[email protected]>
16			* @author Tobias Nyholm <[email protected]>
17			*/
18			class ProfilerExtension
19			{
20			/**
21			* @param array $config Processed configuration
22			* @param ContainerBuilder $container
23			* @param array $clientServiceIds ids of all clients
24			*/
25			public function load(array $config, ContainerBuilder $container, array $clientServiceIds)
26			{
27			$loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
28			$loader->load('data-collector.xml');
29
30			if (!empty($config['toolbar']['formatter'])) {
31			// Add custom formatter
32			$container->getDefinition('httplug.collector.debug_collector')
33			->replaceArgument(0, new Reference($config['toolbar']['formatter']));
34			}
35
36			$container->getDefinition('httplug.formatter.full_http_message')
37			->addArgument($config['toolbar']['captured_body_length']);
38
39			foreach ($clientServiceIds as $clientId) {
40			$pluginClientDefinition = $container->getDefinition($clientId);
41			$serviceIdDebugPlugin = $this->registerDebugPlugin($container, $clientId);
42
43			$argument = $this->mergeDebugPluginArguments($pluginClientDefinition->getArgument(3), [new Reference($serviceIdDebugPlugin)]);
44			$pluginClientDefinition->replaceArgument(3, $argument);
45			}
46			}
47
48			/**
49			* Create a new plugin service for this client.
50			*
51			* @param ContainerBuilder $container
52			* @param string $name
53			*
54			* @return string
55			*/
56			private function registerDebugPlugin(ContainerBuilder $container, $name)
57			{
58			$serviceIdDebugPlugin = $name.'.debug_plugin';
59			$container->register($serviceIdDebugPlugin, DebugPlugin::class)
60			->addArgument(new Reference('httplug.collector.debug_collector'))
61			->addArgument(substr($name, strrpos($name, '.')+1))
62			->setPublic(false);
63
64			return $serviceIdDebugPlugin;
65			}
66
67			/**
68			* @param array $existing
69			* @param array $newArgument
70			*
71			* @return array
72			*/
73			private function mergeDebugPluginArguments($existing, $newArgument)
74			{
75			if (empty($existing)) {
76			$mergedArgument = ['debug_plugins' => $newArgument];
77			} elseif (empty($existing['debug_plugins'])) {
78			$mergedArgument['debug_plugins'] = $newArgument;
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-07-20 16:14 UTC by Report Bug Copy Issue Report `$mergedArgument` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$mergedArgument = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
79			} else {
80			$mergedArgument['debug_plugins'] = array_merge($existing['debug_plugins'], $newArgument);
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-07-20 16:14 UTC by Report Bug Copy Issue Report `$mergedArgument` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$mergedArgument = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
81			}
82
83			return $mergedArgument;
84			}
85			}
86

php-http / HttplugBundle

Pull Request — master (#97)

ProfilerExtension::mergeDebugPluginArguments() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like