| 1 |
<?php |
| 2 |
/** |
| 3 |
* Class Version |
| 4 |
* |
| 5 |
* @created 19.11.2020 |
| 6 |
* @author smiley <[email protected]> |
| 7 |
* @copyright 2020 smiley |
| 8 |
* @license MIT |
| 9 |
*/ |
| 10 |
declare(strict_types=1); |
| 11 |
|
| 12 |
namespace chillerlan\QRCode\Common; |
| 13 |
|
| 14 |
use chillerlan\QRCode\QRCodeException; |
| 15 |
|
| 16 |
/** |
| 17 |
* Version related tables and methods |
| 18 |
*/ |
| 19 |
final class Version{ |
| 20 |
|
| 21 |
/** |
| 22 |
* Enable version auto detection |
| 23 |
* |
| 24 |
* @see \chillerlan\QRCode\QROptionsTrait::$version |
| 25 |
* |
| 26 |
* @var int |
| 27 |
*/ |
| 28 |
public const AUTO = -1; |
| 29 |
|
| 30 |
/** |
| 31 |
* ISO/IEC 18004:2000 Annex E, Table E.1 - Row/column coordinates of center module of Alignment Patterns |
| 32 |
* |
| 33 |
* version -> pattern |
| 34 |
* |
| 35 |
* @var int[][] |
| 36 |
*/ |
| 37 |
private const ALIGNMENT_PATTERN = [ |
| 38 |
1 => [], |
| 39 |
2 => [6, 18], |
| 40 |
3 => [6, 22], |
| 41 |
4 => [6, 26], |
| 42 |
5 => [6, 30], |
| 43 |
6 => [6, 34], |
| 44 |
7 => [6, 22, 38], |
| 45 |
8 => [6, 24, 42], |
| 46 |
9 => [6, 26, 46], |
| 47 |
10 => [6, 28, 50], |
| 48 |
11 => [6, 30, 54], |
| 49 |
12 => [6, 32, 58], |
| 50 |
13 => [6, 34, 62], |
| 51 |
14 => [6, 26, 46, 66], |
| 52 |
15 => [6, 26, 48, 70], |
| 53 |
16 => [6, 26, 50, 74], |
| 54 |
17 => [6, 30, 54, 78], |
| 55 |
18 => [6, 30, 56, 82], |
| 56 |
19 => [6, 30, 58, 86], |
| 57 |
20 => [6, 34, 62, 90], |
| 58 |
21 => [6, 28, 50, 72, 94], |
| 59 |
22 => [6, 26, 50, 74, 98], |
| 60 |
23 => [6, 30, 54, 78, 102], |
| 61 |
24 => [6, 28, 54, 80, 106], |
| 62 |
25 => [6, 32, 58, 84, 110], |
| 63 |
26 => [6, 30, 58, 86, 114], |
| 64 |
27 => [6, 34, 62, 90, 118], |
| 65 |
28 => [6, 26, 50, 74, 98, 122], |
| 66 |
29 => [6, 30, 54, 78, 102, 126], |
| 67 |
30 => [6, 26, 52, 78, 104, 130], |
| 68 |
31 => [6, 30, 56, 82, 108, 134], |
| 69 |
32 => [6, 34, 60, 86, 112, 138], |
| 70 |
33 => [6, 30, 58, 86, 114, 142], |
| 71 |
34 => [6, 34, 62, 90, 118, 146], |
| 72 |
35 => [6, 30, 54, 78, 102, 126, 150], |
| 73 |
36 => [6, 24, 50, 76, 102, 128, 154], |
| 74 |
37 => [6, 28, 54, 80, 106, 132, 158], |
| 75 |
38 => [6, 32, 58, 84, 110, 136, 162], |
| 76 |
39 => [6, 26, 54, 82, 110, 138, 166], |
| 77 |
40 => [6, 30, 58, 86, 114, 142, 170], |
| 78 |
]; |
| 79 |
|
| 80 |
/** |
| 81 |
* ISO/IEC 18004:2000 Annex D, Table D.1 - Version information bit stream for each version |
| 82 |
* |
| 83 |
* no version pattern for QR Codes < 7 |
| 84 |
* |
| 85 |
* @var int[] |
| 86 |
*/ |
| 87 |
private const VERSION_PATTERN = [ |
| 88 |
7 => 0b000111110010010100, |
| 89 |
8 => 0b001000010110111100, |
| 90 |
9 => 0b001001101010011001, |
| 91 |
10 => 0b001010010011010011, |
| 92 |
11 => 0b001011101111110110, |
| 93 |
12 => 0b001100011101100010, |
| 94 |
13 => 0b001101100001000111, |
| 95 |
14 => 0b001110011000001101, |
| 96 |
15 => 0b001111100100101000, |
| 97 |
16 => 0b010000101101111000, |
| 98 |
17 => 0b010001010001011101, |
| 99 |
18 => 0b010010101000010111, |
| 100 |
19 => 0b010011010100110010, |
| 101 |
20 => 0b010100100110100110, |
| 102 |
21 => 0b010101011010000011, |
| 103 |
22 => 0b010110100011001001, |
| 104 |
23 => 0b010111011111101100, |
| 105 |
24 => 0b011000111011000100, |
| 106 |
25 => 0b011001000111100001, |
| 107 |
26 => 0b011010111110101011, |
| 108 |
27 => 0b011011000010001110, |
| 109 |
28 => 0b011100110000011010, |
| 110 |
29 => 0b011101001100111111, |
| 111 |
30 => 0b011110110101110101, |
| 112 |
31 => 0b011111001001010000, |
| 113 |
32 => 0b100000100111010101, |
| 114 |
33 => 0b100001011011110000, |
| 115 |
34 => 0b100010100010111010, |
| 116 |
35 => 0b100011011110011111, |
| 117 |
36 => 0b100100101100001011, |
| 118 |
37 => 0b100101010000101110, |
| 119 |
38 => 0b100110101001100100, |
| 120 |
39 => 0b100111010101000001, |
| 121 |
40 => 0b101000110001101001, |
| 122 |
]; |
| 123 |
|
| 124 |
/** |
| 125 |
* ISO/IEC 18004:2000 Tables 13-22 - Error correction characteristics |
| 126 |
* |
| 127 |
* @see http://www.thonky.com/qr-code-tutorial/error-correction-table |
| 128 |
*/ |
| 129 |
private const RSBLOCKS = [ |
| 130 |
1 => [[ 7, [[ 1, 19], [ 0, 0]]], [10, [[ 1, 16], [ 0, 0]]], [13, [[ 1, 13], [ 0, 0]]], [17, [[ 1, 9], [ 0, 0]]]], |
| 131 |
2 => [[10, [[ 1, 34], [ 0, 0]]], [16, [[ 1, 28], [ 0, 0]]], [22, [[ 1, 22], [ 0, 0]]], [28, [[ 1, 16], [ 0, 0]]]], |
| 132 |
3 => [[15, [[ 1, 55], [ 0, 0]]], [26, [[ 1, 44], [ 0, 0]]], [18, [[ 2, 17], [ 0, 0]]], [22, [[ 2, 13], [ 0, 0]]]], |
| 133 |
4 => [[20, [[ 1, 80], [ 0, 0]]], [18, [[ 2, 32], [ 0, 0]]], [26, [[ 2, 24], [ 0, 0]]], [16, [[ 4, 9], [ 0, 0]]]], |
| 134 |
5 => [[26, [[ 1, 108], [ 0, 0]]], [24, [[ 2, 43], [ 0, 0]]], [18, [[ 2, 15], [ 2, 16]]], [22, [[ 2, 11], [ 2, 12]]]], |
| 135 |
6 => [[18, [[ 2, 68], [ 0, 0]]], [16, [[ 4, 27], [ 0, 0]]], [24, [[ 4, 19], [ 0, 0]]], [28, [[ 4, 15], [ 0, 0]]]], |
| 136 |
7 => [[20, [[ 2, 78], [ 0, 0]]], [18, [[ 4, 31], [ 0, 0]]], [18, [[ 2, 14], [ 4, 15]]], [26, [[ 4, 13], [ 1, 14]]]], |
| 137 |
8 => [[24, [[ 2, 97], [ 0, 0]]], [22, [[ 2, 38], [ 2, 39]]], [22, [[ 4, 18], [ 2, 19]]], [26, [[ 4, 14], [ 2, 15]]]], |
| 138 |
9 => [[30, [[ 2, 116], [ 0, 0]]], [22, [[ 3, 36], [ 2, 37]]], [20, [[ 4, 16], [ 4, 17]]], [24, [[ 4, 12], [ 4, 13]]]], |
| 139 |
10 => [[18, [[ 2, 68], [ 2, 69]]], [26, [[ 4, 43], [ 1, 44]]], [24, [[ 6, 19], [ 2, 20]]], [28, [[ 6, 15], [ 2, 16]]]], |
| 140 |
11 => [[20, [[ 4, 81], [ 0, 0]]], [30, [[ 1, 50], [ 4, 51]]], [28, [[ 4, 22], [ 4, 23]]], [24, [[ 3, 12], [ 8, 13]]]], |
| 141 |
12 => [[24, [[ 2, 92], [ 2, 93]]], [22, [[ 6, 36], [ 2, 37]]], [26, [[ 4, 20], [ 6, 21]]], [28, [[ 7, 14], [ 4, 15]]]], |
| 142 |
13 => [[26, [[ 4, 107], [ 0, 0]]], [22, [[ 8, 37], [ 1, 38]]], [24, [[ 8, 20], [ 4, 21]]], [22, [[12, 11], [ 4, 12]]]], |
| 143 |
14 => [[30, [[ 3, 115], [ 1, 116]]], [24, [[ 4, 40], [ 5, 41]]], [20, [[11, 16], [ 5, 17]]], [24, [[11, 12], [ 5, 13]]]], |
| 144 |
15 => [[22, [[ 5, 87], [ 1, 88]]], [24, [[ 5, 41], [ 5, 42]]], [30, [[ 5, 24], [ 7, 25]]], [24, [[11, 12], [ 7, 13]]]], |
| 145 |
16 => [[24, [[ 5, 98], [ 1, 99]]], [28, [[ 7, 45], [ 3, 46]]], [24, [[15, 19], [ 2, 20]]], [30, [[ 3, 15], [13, 16]]]], |
| 146 |
17 => [[28, [[ 1, 107], [ 5, 108]]], [28, [[10, 46], [ 1, 47]]], [28, [[ 1, 22], [15, 23]]], [28, [[ 2, 14], [17, 15]]]], |
| 147 |
18 => [[30, [[ 5, 120], [ 1, 121]]], [26, [[ 9, 43], [ 4, 44]]], [28, [[17, 22], [ 1, 23]]], [28, [[ 2, 14], [19, 15]]]], |
| 148 |
19 => [[28, [[ 3, 113], [ 4, 114]]], [26, [[ 3, 44], [11, 45]]], [26, [[17, 21], [ 4, 22]]], [26, [[ 9, 13], [16, 14]]]], |
| 149 |
20 => [[28, [[ 3, 107], [ 5, 108]]], [26, [[ 3, 41], [13, 42]]], [30, [[15, 24], [ 5, 25]]], [28, [[15, 15], [10, 16]]]], |
| 150 |
21 => [[28, [[ 4, 116], [ 4, 117]]], [26, [[17, 42], [ 0, 0]]], [28, [[17, 22], [ 6, 23]]], [30, [[19, 16], [ 6, 17]]]], |
| 151 |
22 => [[28, [[ 2, 111], [ 7, 112]]], [28, [[17, 46], [ 0, 0]]], [30, [[ 7, 24], [16, 25]]], [24, [[34, 13], [ 0, 0]]]], |
| 152 |
23 => [[30, [[ 4, 121], [ 5, 122]]], [28, [[ 4, 47], [14, 48]]], [30, [[11, 24], [14, 25]]], [30, [[16, 15], [14, 16]]]], |
| 153 |
24 => [[30, [[ 6, 117], [ 4, 118]]], [28, [[ 6, 45], [14, 46]]], [30, [[11, 24], [16, 25]]], [30, [[30, 16], [ 2, 17]]]], |
| 154 |
25 => [[26, [[ 8, 106], [ 4, 107]]], [28, [[ 8, 47], [13, 48]]], [30, [[ 7, 24], [22, 25]]], [30, [[22, 15], [13, 16]]]], |
| 155 |
26 => [[28, [[10, 114], [ 2, 115]]], [28, [[19, 46], [ 4, 47]]], [28, [[28, 22], [ 6, 23]]], [30, [[33, 16], [ 4, 17]]]], |
| 156 |
27 => [[30, [[ 8, 122], [ 4, 123]]], [28, [[22, 45], [ 3, 46]]], [30, [[ 8, 23], [26, 24]]], [30, [[12, 15], [28, 16]]]], |
| 157 |
28 => [[30, [[ 3, 117], [10, 118]]], [28, [[ 3, 45], [23, 46]]], [30, [[ 4, 24], [31, 25]]], [30, [[11, 15], [31, 16]]]], |
| 158 |
29 => [[30, [[ 7, 116], [ 7, 117]]], [28, [[21, 45], [ 7, 46]]], [30, [[ 1, 23], [37, 24]]], [30, [[19, 15], [26, 16]]]], |
| 159 |
30 => [[30, [[ 5, 115], [10, 116]]], [28, [[19, 47], [10, 48]]], [30, [[15, 24], [25, 25]]], [30, [[23, 15], [25, 16]]]], |
| 160 |
31 => [[30, [[13, 115], [ 3, 116]]], [28, [[ 2, 46], [29, 47]]], [30, [[42, 24], [ 1, 25]]], [30, [[23, 15], [28, 16]]]], |
| 161 |
32 => [[30, [[17, 115], [ 0, 0]]], [28, [[10, 46], [23, 47]]], [30, [[10, 24], [35, 25]]], [30, [[19, 15], [35, 16]]]], |
| 162 |
33 => [[30, [[17, 115], [ 1, 116]]], [28, [[14, 46], [21, 47]]], [30, [[29, 24], [19, 25]]], [30, [[11, 15], [46, 16]]]], |
| 163 |
34 => [[30, [[13, 115], [ 6, 116]]], [28, [[14, 46], [23, 47]]], [30, [[44, 24], [ 7, 25]]], [30, [[59, 16], [ 1, 17]]]], |
| 164 |
35 => [[30, [[12, 121], [ 7, 122]]], [28, [[12, 47], [26, 48]]], [30, [[39, 24], [14, 25]]], [30, [[22, 15], [41, 16]]]], |
| 165 |
36 => [[30, [[ 6, 121], [14, 122]]], [28, [[ 6, 47], [34, 48]]], [30, [[46, 24], [10, 25]]], [30, [[ 2, 15], [64, 16]]]], |
| 166 |
37 => [[30, [[17, 122], [ 4, 123]]], [28, [[29, 46], [14, 47]]], [30, [[49, 24], [10, 25]]], [30, [[24, 15], [46, 16]]]], |
| 167 |
38 => [[30, [[ 4, 122], [18, 123]]], [28, [[13, 46], [32, 47]]], [30, [[48, 24], [14, 25]]], [30, [[42, 15], [32, 16]]]], |
| 168 |
39 => [[30, [[20, 117], [ 4, 118]]], [28, [[40, 47], [ 7, 48]]], [30, [[43, 24], [22, 25]]], [30, [[10, 15], [67, 16]]]], |
| 169 |
40 => [[30, [[19, 118], [ 6, 119]]], [28, [[18, 47], [31, 48]]], [30, [[34, 24], [34, 25]]], [30, [[20, 15], [61, 16]]]], |
| 170 |
]; |
| 171 |
|
| 172 |
/** |
| 173 |
* ISO/IEC 18004:2000 Table 1 - Data capacity of all versions of QR Code |
| 174 |
*/ |
| 175 |
private const TOTAL_CODEWORDS = [ |
| 176 |
1 => 26, |
| 177 |
2 => 44, |
| 178 |
3 => 70, |
| 179 |
4 => 100, |
| 180 |
5 => 134, |
| 181 |
6 => 172, |
| 182 |
7 => 196, |
| 183 |
8 => 242, |
| 184 |
9 => 292, |
| 185 |
10 => 346, |
| 186 |
11 => 404, |
| 187 |
12 => 466, |
| 188 |
13 => 532, |
| 189 |
14 => 581, |
| 190 |
15 => 655, |
| 191 |
16 => 733, |
| 192 |
17 => 815, |
| 193 |
18 => 901, |
| 194 |
19 => 991, |
| 195 |
20 => 1085, |
| 196 |
21 => 1156, |
| 197 |
22 => 1258, |
| 198 |
23 => 1364, |
| 199 |
24 => 1474, |
| 200 |
25 => 1588, |
| 201 |
26 => 1706, |
| 202 |
27 => 1828, |
| 203 |
28 => 1921, |
| 204 |
29 => 2051, |
| 205 |
30 => 2185, |
| 206 |
31 => 2323, |
| 207 |
32 => 2465, |
| 208 |
33 => 2611, |
| 209 |
34 => 2761, |
| 210 |
35 => 2876, |
| 211 |
36 => 3034, |
| 212 |
37 => 3196, |
| 213 |
38 => 3362, |
| 214 |
39 => 3532, |
| 215 |
40 => 3706, |
| 216 |
]; |
| 217 |
|
| 218 |
/** |
| 219 |
* QR Code version number |
| 220 |
*/ |
| 221 |
private int $versionNumber; |
| 222 |
|
| 223 |
/** |
| 224 |
* Version constructor. |
| 225 |
* |
| 226 |
* @throws \chillerlan\QRCode\QRCodeException |
| 227 |
*/ |
| 228 |
public function __construct(int $version){ |
| 229 |
|
| 230 |
if($version < 1 || $version > 40){ |
| 231 |
throw new QRCodeException('invalid version given'); |
| 232 |
} |
| 233 |
|
| 234 |
$this->versionNumber = $version; |
| 235 |
} |
| 236 |
|
| 237 |
/** |
| 238 |
* returns the current version number as string |
| 239 |
*/ |
| 240 |
public function __toString():string{ |
| 241 |
return (string)$this->versionNumber; |
| 242 |
} |
| 243 |
|
| 244 |
/** |
| 245 |
* returns the current version number |
| 246 |
* |
| 247 |
* @deprecated 6.0.1 This method will be removed. In v7, use the property "Version::$versionNumber" instead. |
| 248 |
*/ |
| 249 |
public function getVersionNumber():int{ |
| 250 |
return $this->versionNumber; |
| 251 |
} |
| 252 |
|
| 253 |
/** |
| 254 |
* the matrix size for the given version |
| 255 |
*/ |
| 256 |
public function getDimension():int{ |
| 257 |
return (($this->versionNumber * 4) + 17); |
| 258 |
} |
| 259 |
|
| 260 |
/** |
| 261 |
* the version pattern for the given version |
| 262 |
*/ |
| 263 |
public function getVersionPattern():int|null{ |
| 264 |
return (self::VERSION_PATTERN[$this->versionNumber] ?? null); |
| 265 |
} |
| 266 |
|
| 267 |
/** |
| 268 |
* the alignment patterns for the current version |
| 269 |
* |
| 270 |
* @return int[] |
| 271 |
*/ |
| 272 |
public function getAlignmentPattern():array{ |
| 273 |
return self::ALIGNMENT_PATTERN[$this->versionNumber]; |
| 274 |
} |
| 275 |
|
| 276 |
/** |
| 277 |
* returns ECC block information for the given $version and $eccLevel |
| 278 |
*/ |
| 279 |
public function getRSBlocks(EccLevel $eccLevel):array{ |
| 280 |
return self::RSBLOCKS[$this->versionNumber][$eccLevel->getOrdinal()]; |
| 281 |
} |
| 282 |
|
| 283 |
/** |
| 284 |
* returns the maximum codewords for the current version |
| 285 |
*/ |
| 286 |
public function getTotalCodewords():int{ |
| 287 |
return self::TOTAL_CODEWORDS[$this->versionNumber]; |
| 288 |
} |
| 289 |
|
| 290 |
} |