/
QRCode.php
340 lines (277 loc) · 7.58 KB
/
QRCode.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
<?php
/**
* Class QRCode
*
* @filesource QRCode.php
* @created 26.11.2015
* @package chillerlan\QRCode
* @author Smiley <smiley@chillerlan.net>
* @copyright 2015 Smiley
* @license MIT
*/
namespace chillerlan\QRCode;
use chillerlan\QRCode\Data\{
AlphaNum, Byte, Kanji, MaskPatternTester, Number, QRCodeDataException, QRDataInterface, QRMatrix
};
use chillerlan\QRCode\Output\{
QRCodeOutputException, QRImage, QRMarkup, QROutputInterface, QRString
};
use chillerlan\Traits\ClassLoader;
/**
* Turns a text string into a Model 2 QR Code
*
* @link https://github.com/kazuhikoarase/qrcode-generator/tree/master/php
* @link http://www.qrcode.com/en/codes/model12.html
* @link http://www.thonky.com/qr-code-tutorial/
*/
class QRCode{
use ClassLoader;
/**
* API constants
*/
const OUTPUT_MARKUP_HTML = 'html';
const OUTPUT_MARKUP_SVG = 'svg';
# const OUTPUT_MARKUP_EPS = 'eps';
# const OUTPUT_MARKUP_XML = 'xml'; // anyone?
const OUTPUT_IMAGE_PNG = 'png';
const OUTPUT_IMAGE_JPG = 'jpg';
const OUTPUT_IMAGE_GIF = 'gif';
const OUTPUT_STRING_JSON = 'json';
const OUTPUT_STRING_TEXT = 'text';
const OUTPUT_CUSTOM = 'custom';
const VERSION_AUTO = -1;
const MASK_PATTERN_AUTO = -1;
const ECC_L = 0b01; // 7%.
const ECC_M = 0b00; // 15%.
const ECC_Q = 0b11; // 25%.
const ECC_H = 0b10; // 30%.
const DATA_NUMBER = 0b0001;
const DATA_ALPHANUM = 0b0010;
const DATA_BYTE = 0b0100;
const DATA_KANJI = 0b1000;
const ECC_MODES = [
self::ECC_L => 0,
self::ECC_M => 1,
self::ECC_Q => 2,
self::ECC_H => 3,
];
const DATA_MODES = [
self::DATA_NUMBER => 0,
self::DATA_ALPHANUM => 1,
self::DATA_BYTE => 2,
self::DATA_KANJI => 3,
];
const OUTPUT_MODES = [
QRMarkup::class => [
self::OUTPUT_MARKUP_SVG,
self::OUTPUT_MARKUP_HTML,
# self::OUTPUT_MARKUP_EPS,
],
QRImage::class => [
self::OUTPUT_IMAGE_PNG,
self::OUTPUT_IMAGE_GIF,
self::OUTPUT_IMAGE_JPG,
],
QRString::class => [
self::OUTPUT_STRING_JSON,
self::OUTPUT_STRING_TEXT,
]
];
/**
* @var \chillerlan\QRCode\QROptions
*/
protected $options;
/**
* @var \chillerlan\QRCode\Data\QRDataInterface
*/
protected $dataInterface;
/**
* QRCode constructor.
*
* @param \chillerlan\QRCode\QROptions|null $options
*/
public function __construct(QROptions $options = null){
mb_internal_encoding('UTF-8');
$this->setOptions($options ?? new QROptions);
}
/**
* Sets the options, called internally by the constructor
*
* @param \chillerlan\QRCode\QROptions $options
*
* @return \chillerlan\QRCode\QRCode
* @throws \chillerlan\QRCode\QRCodeException
*/
public function setOptions(QROptions $options):QRCode{
if(!array_key_exists($options->eccLevel, $this::ECC_MODES)){
throw new QRCodeException('Invalid error correct level: '.$options->eccLevel);
}
if(!is_array($options->imageTransparencyBG) || count($options->imageTransparencyBG) < 3){
$options->imageTransparencyBG = [255, 255, 255];
}
$options->version = (int)$options->version;
// clamp min/max version number
$options->versionMin = (int)min($options->versionMin, $options->versionMax);
$options->versionMax = (int)max($options->versionMin, $options->versionMax);
$this->options = $options;
return $this;
}
/**
* Renders a QR Code for the given $data and QROptions
*
* @param string $data
*
* @return mixed
*/
public function render(string $data){
return $this->initOutputInterface($data)->dump();
}
/**
* Returns a QRMatrix object for the given $data and current QROptions
*
* @param string $data
*
* @return \chillerlan\QRCode\Data\QRMatrix
* @throws \chillerlan\QRCode\Data\QRCodeDataException
*/
public function getMatrix(string $data):QRMatrix {
$data = trim($data);
if(empty($data)){
throw new QRCodeDataException('QRCode::getMatrix() No data given.');
}
$this->dataInterface = $this->initDataInterface($data);
$maskPattern = $this->options->maskPattern === $this::MASK_PATTERN_AUTO
? $this->getBestMaskPattern()
: max(7, min(0, (int)$this->options->maskPattern));
$matrix = $this
->dataInterface
->initMatrix($maskPattern)
;
if((bool)$this->options->addQuietzone){
$matrix->setQuietZone($this->options->quietzoneSize);
}
return $matrix;
}
/**
* shoves a QRMatrix through the MaskPatternTester to find the lowest penalty mask pattern
*
* @see \chillerlan\QRCode\Data\MaskPatternTester
*
* @return int
*/
protected function getBestMaskPattern():int{
$penalties = [];
$tester = new MaskPatternTester;
for($testPattern = 0; $testPattern < 8; $testPattern++){
$matrix = $this
->dataInterface
->initMatrix($testPattern, true);
$tester->setMatrix($matrix);
$penalties[$testPattern] = $tester->testPattern();
}
return array_search(min($penalties), $penalties, true);
}
/**
* returns a fresh QRDataInterface for the given $data
*
* @param string $data
*
* @return \chillerlan\QRCode\Data\QRDataInterface
* @throws \chillerlan\QRCode\Data\QRCodeDataException
*/
public function initDataInterface(string $data):QRDataInterface{
$DATA_MODES = [
Number::class => 'Number',
AlphaNum::class => 'AlphaNum',
Kanji::class => 'Kanji',
Byte::class => 'Byte',
];
foreach($DATA_MODES as $dataInterface => $mode){
if(call_user_func_array([$this, 'is'.$mode], [$data]) === true){
return $this->loadClass($dataInterface, QRDataInterface::class, $this->options, $data);
}
}
throw new QRCodeDataException('invalid data type'); // @codeCoverageIgnore
}
/**
* returns a fresh (built-in) QROutputInterface
*
* @param string $data
*
* @return \chillerlan\QRCode\Output\QROutputInterface
* @throws \chillerlan\QRCode\Output\QRCodeOutputException
*/
protected function initOutputInterface(string $data):QROutputInterface{
if($this->options->outputType === $this::OUTPUT_CUSTOM && $this->options->outputInterface !== null){
return $this->loadClass($this->options->outputInterface, QROutputInterface::class, $this->options, $this->getMatrix($data));
}
foreach($this::OUTPUT_MODES as $outputInterface => $modes){
if(in_array($this->options->outputType, $modes, true)){
return $this->loadClass($outputInterface, QROutputInterface::class, $this->options, $this->getMatrix($data));
}
}
throw new QRCodeOutputException('invalid output type');
}
/**
* checks if a string qualifies as numeric
*
* @param string $string
*
* @return bool
*/
public function isNumber(string $string):bool {
$len = strlen($string);
$map = str_split('0123456789');
for($i = 0; $i < $len; $i++){
if(!in_array($string[$i], $map, true)){
return false;
}
}
return true;
}
/**
* checks if a string qualifies as alphanumeric
*
* @param string $string
*
* @return bool
*/
public function isAlphaNum(string $string):bool {
$len = strlen($string);
for($i = 0; $i < $len; $i++){
if(!in_array($string[$i], AlphaNum::CHAR_MAP, true)){
return false;
}
}
return true;
}
/**
* checks if a string qualifies as Kanji
*
* @param string $string
*
* @return bool
*/
public function isKanji(string $string):bool {
$i = 0;
$len = strlen($string);
while($i + 1 < $len){
$c = ((0xff&ord($string[$i])) << 8)|(0xff&ord($string[$i + 1]));
if(!($c >= 0x8140 && $c <= 0x9FFC) && !($c >= 0xE040 && $c <= 0xEBBF)){
return false;
}
$i += 2;
}
return !($i < $len);
}
/**
* a dummy
*
* @param $data
*
* @return bool
*/
protected function isByte(string $data):bool{
return !empty($data);
}
}