|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace byrokrat\billing; |
|
6
|
|
|
|
|
7
|
|
|
use byrokrat\checkdigit\Luhn; |
|
8
|
|
|
|
|
9
|
|
|
/** |
|
10
|
|
|
* Tools for constructing and validating ocr numbers |
|
11
|
|
|
*/ |
|
12
|
|
|
class OcrTools |
|
13
|
|
|
{ |
|
14
|
|
|
/** |
|
15
|
|
|
* @var Luhn Checksum calculator |
|
16
|
|
|
*/ |
|
17
|
|
|
private $luhn; |
|
18
|
|
|
|
|
19
|
17 |
|
public function __construct(Luhn $luhn = null) |
|
20
|
|
|
{ |
|
21
|
17 |
|
$this->luhn = $luhn ?: new Luhn; |
|
22
|
17 |
|
} |
|
23
|
|
|
|
|
24
|
|
|
/** |
|
25
|
|
|
* Validate OCR number |
|
26
|
|
|
* |
|
27
|
|
|
* @throws Exception If ocr is not valid, including check and length digits |
|
28
|
|
|
*/ |
|
29
|
7 |
|
public function validateOcr(string $ocr): string |
|
30
|
|
|
{ |
|
31
|
7 |
|
if (!ctype_digit($ocr) || strlen($ocr) > 25 || strlen($ocr) < 2) { |
|
32
|
3 |
|
throw new Exception("Number must be numeric and contain between 2 and 25 digits"); |
|
33
|
|
|
} |
|
34
|
|
|
|
|
35
|
4 |
|
if (substr($ocr, -2, 1) != $this->calculateLengthDigit(substr($ocr, 0, -2))) { |
|
36
|
1 |
|
throw new Exception("Invalid length digit"); |
|
37
|
|
|
} |
|
38
|
|
|
|
|
39
|
3 |
|
if (!$this->luhn->isValid($ocr)) { |
|
40
|
1 |
|
throw new Exception("Invalid check digit"); |
|
41
|
|
|
} |
|
42
|
|
|
|
|
43
|
2 |
|
return $ocr; |
|
44
|
|
|
} |
|
45
|
|
|
|
|
46
|
|
|
/** |
|
47
|
|
|
* Create ocr from number by appending check and length digits |
|
48
|
|
|
* |
|
49
|
|
|
* @throws Exception If number is non-numeric or longer than 23 characters |
|
50
|
|
|
*/ |
|
51
|
4 |
|
public function createOcr(string $number): string |
|
52
|
|
|
{ |
|
53
|
4 |
|
if (!ctype_digit($number) || strlen($number) > 23) { |
|
54
|
2 |
|
throw new Exception("Number must be numeric and contain a maximum of 23 digits"); |
|
55
|
|
|
} |
|
56
|
|
|
|
|
57
|
2 |
|
$number .= $this->calculateLengthDigit($number); |
|
58
|
2 |
|
$number .= $this->luhn->calculateCheckDigit($number); |
|
59
|
|
|
|
|
60
|
2 |
|
return $number; |
|
61
|
|
|
} |
|
62
|
|
|
|
|
63
|
|
|
/** |
|
64
|
|
|
* Calculate length digit for raw number |
|
65
|
|
|
* |
|
66
|
|
|
* The length of $number plus 2 is used, to take length and check digits |
|
67
|
|
|
* into account. |
|
68
|
|
|
*/ |
|
69
|
6 |
|
private function calculateLengthDigit(string $number): string |
|
70
|
|
|
{ |
|
71
|
6 |
|
return (string)((strlen($number) + 2) % 10); |
|
72
|
|
|
} |
|
73
|
|
|
} |
|
74
|
|
|
|
byrokrat /
billing
