Modulo11::calculateCheckDigit()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 13

Duplication

Lines 3
Ratio 23.08 %

Code Coverage

Tests 6
CRAP Score 2

Importance

Changes 0
Metric Value
dl 3
loc 13
ccs 6
cts 6
cp 1
rs 9.8333
c 0
b 0
f 0
cc 2
nc 2
nop 1
crap 2
1
<?php
2
3
declare(strict_types = 1);
4
5
namespace byrokrat\checkdigit;
6
7
/**
8
 * Modulo11 calculator
9
 */
10
class Modulo11 implements Calculator
11
{
12
    use AssertionsTrait;
13
14
    /**
15
     * @var array Map modulo 11 remainder to check digit
16
     */
17
    private static $remainderToCheck = [
18
        0 => '0',
19
        1 => '1',
20
        2 => '2',
21
        3 => '3',
22
        4 => '4',
23
        5 => '5',
24
        6 => '6',
25
        7 => '7',
26
        8 => '8',
27
        9 => '9',
28
        10 => 'X',
29
        11 => '0',
30
    ];
31
32
    /**
33
     * Check if the last digit of number is a valid modulo 11 check digit
34
     */
35 6
    public function isValid(string $number): bool
36
    {
37 6
        if (!preg_match("/^\d*(X|\d){1}$/", $number)) {
38 5
            throw new InvalidStructureException(
39 5
                "Number must consist of characters 0-9 and optionally end with X"
40
            );
41
        }
42
43 1
        $sum = 0;
44
45 1
        foreach (array_reverse(str_split($number)) as $pos => $digit) {
46 1
            $digit = ($digit == 'X') ? 10 : $digit;
47 1
            $sum += $digit * $this->getWeight($pos);
48
        }
49
50
        // If remainder is 0 check digit is valid
51 1
        return $sum % 11 === 0;
52
    }
53
54
    /**
55
     * Calculate the modulo 11 check digit for number
56
     */
57 6
    public function calculateCheckDigit(string $number): string
58
    {
59 6
        $this->assertNumber($number);
60
61 1
        $sum = 0;
62
63 1 View Code Duplication
        foreach (array_reverse(str_split($number)) as $pos => $digit) {
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...
64 1
            $sum += $digit * $this->getWeight($pos, 2);
65
        }
66
67
        // Calculate check digit from remainder
68 1
        return self::$remainderToCheck[11 - $sum % 11];
69
    }
70
71
    /**
72
     * Calculate weight based on position in number
73
     *
74
     * @param int $pos   Position in number (starts from 0)
75
     * @param int $start Start value for weight calculation (value of position 0)
76
     */
77 2
    protected function getWeight(int $pos, int $start = 1): int
78
    {
79 2
        $pos += $start;
80
81 2
        while ($pos > 10) {
82 2
            $pos -= 10;
83
        }
84
85 2
        return $pos;
86
    }
87
}
88