ObjectAgentPass::process() - Code Metrics - Inspection of "Allow enabling agents" - psiphp/object-agent-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1)

by Daniel

created 2016-11-08 15:01 UTC

ObjectAgentPass::process() B

↳ Parent: ObjectAgentPass

Complexity

Conditions	5
Paths	6

Size

Total Lines	38
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	38
rs	8.439
cc	5
eloc	23
nc	6
nop	1

<?php

namespace Psi\Bundle\ObjectAgent\DependencyInjection\Compiler;

use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
use Symfony\Component\DependencyInjection\Reference;

class ObjectAgentPass implements CompilerPassInterface
{
    public function process(ContainerBuilder $container)
    {
        if (!$container->has('psi_object_agent.agent_finder')) {
            return;
        }

        $taggedIds = $container->findTaggedServiceIds('psi_object_agent.agent');
        $registryDef = $container->getDefinition('psi_object_agent.agent_finder');
        $enabledAgents = $container->getParameter('psi_object_agent.enabled_agents');

        foreach ($taggedIds as $serviceId => $attributes) {
            var_dump($serviceId);

            $attributes = $attributes[0];
            if (!isset($attributes['alias'])) {
                throw new InvalidArgumentException(sprintf(
                    $this->context . ' "%s" has no "alias" attribute in its tag',
class MyClass { }

$x = new MyClass();
$x->foo = true;
                    $serviceId
                ));
            }

            $alias = $attributes['alias'];

            $agents[$alias] = new Reference($serviceId);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
        }

        if ($diff = array_diff($enabledAgents, array_keys($agents))) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            throw new \RuntimeException(sprintf(
                'Unknown agent(s) "%s". Known agents: "%s"',
                implode('", "', $diff), implode('", "', array_keys($agents))
            ));
        }

        $agents = array_filter($agents, function ($key) use ($enabledAgents) {
            return in_array($key, $enabledAgents);
        }, ARRAY_FILTER_USE_KEY);

        $registryDef->replaceArgument(0, $agents);
    }
}


1			<?php
2
3			namespace Psi\Bundle\ObjectAgent\DependencyInjection\Compiler;
4
5			use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
6			use Symfony\Component\DependencyInjection\ContainerBuilder;
7			use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
8			use Symfony\Component\DependencyInjection\Reference;
9
10			class ObjectAgentPass implements CompilerPassInterface
11			{
12			public function process(ContainerBuilder $container)
13			{
14			if (!$container->has('psi_object_agent.agent_finder')) {
15			return;
16			}
17
18			$taggedIds = $container->findTaggedServiceIds('psi_object_agent.agent');
19			$registryDef = $container->getDefinition('psi_object_agent.agent_finder');
20			$enabledAgents = $container->getParameter('psi_object_agent.enabled_agents');
21
22			foreach ($taggedIds as $serviceId => $attributes) {
23			var_dump($serviceId);
			0 ignored issues – show Security Debugging Code introduced 2016-11-08 15:03 UTC by Report Bug Copy Issue Report `var_dump($serviceId);` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
24			$attributes = $attributes[0];
25			if (!isset($attributes['alias'])) {
26			throw new InvalidArgumentException(sprintf(
27			$this->context . ' "%s" has no "alias" attribute in its tag',
			0 ignored issues – show Bug introduced 2016-11-08 15:03 UTC by Report Bug Copy Issue Report The property `context` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
28			$serviceId
29			));
30			}
31
32			$alias = $attributes['alias'];
33
34			$agents[$alias] = new Reference($serviceId);
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-11-08 15:03 UTC by Report Bug Copy Issue Report `$agents` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$agents = 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...
35			}
36
37			if ($diff = array_diff($enabledAgents, array_keys($agents))) {
			0 ignored issues – show Bug introduced 2016-11-08 15:03 UTC by Report Bug Copy Issue Report The variable `$agents` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
38			throw new \RuntimeException(sprintf(
39			'Unknown agent(s) "%s". Known agents: "%s"',
40			implode('", "', $diff), implode('", "', array_keys($agents))
41			));
42			}
43
44			$agents = array_filter($agents, function ($key) use ($enabledAgents) {
45			return in_array($key, $enabledAgents);
46			}, ARRAY_FILTER_USE_KEY);
47
48			$registryDef->replaceArgument(0, $agents);
49			}
50			}
51

psiphp / object-agent-bundle

Pull Request — master (#1)

ObjectAgentPass::process() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like