OnCallParser::__construct()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
c 0
b 0
f 0
rs 10
cc 1
eloc 2
nc 1
nop 1
1
<?php
2
3
namespace Shrikeh\PagerDuty\Parser\OnCall;
4
5
use Psr\Http\Message\ResponseInterface;
6
7
use Shrikeh\PagerDuty\Entity\OnCall\OnCall;
8
use Shrikeh\PagerDuty\Entity\EscalationPolicy\EscalationPolicy;
9
use Shrikeh\PagerDuty\Collection\OnCalls as OnCallsCollection;
10
use Shrikeh\PagerDuty\Decoder\Json;
11
use Shrikeh\PagerDuty\Parser\OnCall as OnCallInterface;
12
13
final class OnCallParser implements OnCallInterface
14
{
15
    private $decoder;
16
17
    public function __construct(Json $decoder)
18
    {
19
        $this->decoder = $decoder;
20
    }
21
22
    public function parseResponse(ResponseInterface $response)
23
    {
24
        $dto = $this->decoder->decode($response->getBody());
25
        $policies = [];
0 ignored issues
show
Unused Code introduced by
$policies is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
26
        foreach ($dto->oncalls as $entry) {
27
          $policy = new EscalationPolicy($entry->escalation_policy);
0 ignored issues
show
Unused Code introduced by
The call to EscalationPolicy::__construct() has too many arguments starting with $entry->escalation_policy.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
28
          $user   = $entry->user;
29
          $level  = $entry->escalation_level;
30
          $entries[] =  new OnCall($policy, $user, $level);
0 ignored issues
show
Coding Style Comprehensibility introduced by
$entries was never initialized. Although not strictly required by PHP, it is generally a good practice to add $entries = 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...
31
        }
32
        return OnCallsCollection::fromArray($entries);
0 ignored issues
show
Bug introduced by
The variable $entries 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...
33
    }
34
}
35