Ints::filter()   C
last analyzed

Complexity

Conditions 21
Paths 21

Size

Total Lines 68
Code Lines 37

Duplication

Lines 6
Ratio 8.82 %

Importance

Changes 0
Metric Value
dl 6
loc 68
rs 5.6559
c 0
b 0
f 0
cc 21
eloc 37
nc 21
nop 4

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * Defines the DominionEnterprises\Filter\Ints class.
4
 */
5
6
namespace DominionEnterprises\Filter;
7
8
/**
9
 * A collection of filters for integers.
10
 */
11
final class Ints
12
{
13
    /**
14
     * Filters $value to an integer strictly.
15
     *
16
     * $value must be an int or contain all digits, optionally prepended by a '+' or '-' and optionally surrounded by
17
     * whitespace to pass the filter.
18
     *
19
     * The return value is the int, as expected by the \DominionEnterprises\Filterer class.
20
     *
21
     * @param string|int $value the value to make an integer
22
     * @param bool $allowNull Set to true if NULL values are allowed. The filtered result of a NULL value is NULL
23
     * @param int $minValue The minimum acceptable value
24
     * @param int $maxValue The maximum acceptable value
25
     *
26
     * @return int|null The filtered value
27
     *
28
     * @throws \InvalidArgumentException if $allowNull is not a boolean
29
     * @throws \InvalidArgumentException if $minValue is not null and not an int
30
     * @throws \InvalidArgumentException if $maxValue is not an int
31
     * @throws \Exception if $value string length is zero
32
     * @throws \Exception if $value does not contain all digits, optionally prepended by a '+' or '-' and optionally
33
     *                    surrounded by whitespace
34
     * @throws \Exception if $value was greater than a max int of PHP_INT_MAX
35
     * @throws \Exception if $value was less than a min int of ~PHP_INT_MAX
36
     * @throws \Exception if $value is not a string
37
     * @throws \Exception if $value is less than $minValue
38
     * @throws \Exception if $value is greater than $maxValue
39
     */
40
    public static function filter($value, $allowNull = false, $minValue = null, $maxValue = PHP_INT_MAX)
41
    {
42 View Code Duplication
        if ($allowNull !== false && $allowNull !== true) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
43
            throw new \InvalidArgumentException('"' . var_export($allowNull, true) . '" $allowNull was not a bool');
44
        }
45
46 View Code Duplication
        if ($minValue !== null && !is_int($minValue)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
47
            throw new \InvalidArgumentException('"' . var_export($minValue, true) . '" $minValue was not an int');
48
        }
49
50
        if (!is_int($maxValue)) {
51
            throw new \InvalidArgumentException('"' . var_export($maxValue, true) . '" $maxValue was not an int');
52
        }
53
54
        if ($allowNull === true && $value === null) {
55
            return null;
56
        }
57
58
        $valueInt = null;
0 ignored issues
show
Unused Code introduced by
$valueInt 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...
59
        if (is_int($value)) {
60
            $valueInt = $value;
61
        } elseif (is_string($value)) {
62
            $value = trim($value);
63
64
            if (strlen($value) === 0) {
65
                throw new \Exception('$value string length is zero');
66
            }
67
68
            $stringToCheckDigits = $value;
69
70
            if ($value[0] === '-' || $value[0] === '+') {
71
                $stringToCheckDigits = substr($value, 1);
72
            }
73
74
            if (!ctype_digit($stringToCheckDigits)) {
75
                throw new \Exception(
76
                    "{$value} does not contain all digits, optionally prepended by a '+' or '-' and optionally "
77
                    . "surrounded by whitespace"
78
                );
79
            }
80
81
            $phpIntMin = ~PHP_INT_MAX;
82
83
            $casted = (int)$value;
84
85
            if ($casted === PHP_INT_MAX && $value !== (string)PHP_INT_MAX) {
86
                throw new \Exception("{$value} was greater than a max int of " . PHP_INT_MAX);
87
            }
88
89
            if ($casted === $phpIntMin && $value !== (string)$phpIntMin) {
90
                throw new \Exception("{$value} was less than a min int of {$phpIntMin}");
91
            }
92
93
            $valueInt = $casted;
94
        } else {
95
            throw new \Exception('"' . var_export($value, true) . '" $value is not a string');
96
        }
97
98
        if ($minValue !== null && $valueInt < $minValue) {
99
            throw new \Exception("{$valueInt} is less than {$minValue}");
100
        }
101
102
        if ($valueInt > $maxValue) {
103
            throw new \Exception("{$valueInt} is greater than {$maxValue}");
104
        }
105
106
        return $valueInt;
107
    }
108
}
109