Completed
Pull Request — master (#21)
by Daniel
03:27 queued 01:17
created

GridBench   A

Complexity

Total Complexity 3

Size/Duplication

Total Lines 49
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 0

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 3
c 1
b 0
f 0
lcom 1
cbo 0
dl 0
loc 49
rs 10

2 Methods

Rating   Name   Duplication   Size   Complexity  
B setUp() 0 36 2
A grid_loading() 0 4 1
1
<?php
2
3
namespace Psi\Component\Grid\Benchmarks;
4
5
use Psi\Component\Grid\Tests\Functional\GridTestCase;
6
use Psi\Component\Grid\Tests\Model\Article;
7
8
/**
9
 * @BeforeMethods({"setUp"})
10
 * @Revs(100)
11
 * @Iterations(10)
12
 * @OutputTimeUnit("milliseconds")
13
 */
14
class GridBench extends GridTestCase
15
{
16
    private $factory;
17
18
    public function setUp()
19
    {
20
        $nbObjects = 100;
21
        for ($i = 0; $i < $nbObjects; $i++) {
22
            $objects[] = new Article('hello', $i);
0 ignored issues
show
Coding Style Comprehensibility introduced by
$objects was never initialized. Although not strictly required by PHP, it is generally a good practice to add $objects = 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...
23
        }
24
25
        $container = $this->createContainer([
26
            'mapping' => [
27
                Article::class => [
28
                    'grids' => [
29
                        'main' => [
30
                            'columns' => [
31
                                'title' => [
32
                                    'type' => 'property',
33
                                ],
34
                                'number' => [
35
                                    'type' => 'property',
36
                                ],
37
                            ],
38
                            'filters' => [
39
                                'title' => [
40
                                    'type' => 'string',
41
                                ],
42
                            ],
43
                        ],
44
                    ],
45
                ],
46
            ],
47
            'collections' => [
48
                Article::class => $objects,
0 ignored issues
show
Bug introduced by
The variable $objects 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

  1. 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;
        }
    }
    
  2. 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;
    }
    
  3. 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...
49
            ],
50
        ]);
51
52
        $this->factory = $container->get('grid.factory');
53
    }
54
55
    /**
56
     * @Subject()
57
     */
58
    public function grid_loading()
59
    {
60
        $this->factory->loadGrid(Article::class, []);
61
    }
62
}
63