mirror of
https://github.com/chillerlan/php-qrcode.git
synced 2026-08-25 16:47:55 +00:00
codemasher
630 lines
13 KiB
PHP
Executable File
630 lines
13 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* Class QRMatrix
|
|
*
|
|
* @filesource QRMatrix.php
|
|
* @created 15.11.2017
|
|
* @package chillerlan\QRCode\Data
|
|
* @author Smiley <smiley@chillerlan.net>
|
|
* @copyright 2017 Smiley
|
|
* @license MIT
|
|
*/
|
|
|
|
namespace chillerlan\QRCode\Data;
|
|
|
|
use chillerlan\QRCode\QRCode;
|
|
|
|
/**
|
|
* @link http://www.thonky.com/qr-code-tutorial/format-version-information
|
|
*/
|
|
class QRMatrix{
|
|
|
|
public const M_NULL = 0x00;
|
|
public const M_DARKMODULE = 0x02;
|
|
public const M_DATA = 0x04;
|
|
public const M_FINDER = 0x06;
|
|
public const M_SEPARATOR = 0x08;
|
|
public const M_ALIGNMENT = 0x0a;
|
|
public const M_TIMING = 0x0c;
|
|
public const M_FORMAT = 0x0e;
|
|
public const M_VERSION = 0x10;
|
|
public const M_QUIETZONE = 0x12;
|
|
public const M_LOGO = 0x14; // @todo
|
|
|
|
public const M_TEST = 0xff;
|
|
|
|
/**
|
|
* @link http://www.thonky.com/qr-code-tutorial/alignment-pattern-locations
|
|
*
|
|
* version -> pattern
|
|
*/
|
|
protected const alignmentPattern = [
|
|
1 => [],
|
|
2 => [6, 18],
|
|
3 => [6, 22],
|
|
4 => [6, 26],
|
|
5 => [6, 30],
|
|
6 => [6, 34],
|
|
7 => [6, 22, 38],
|
|
8 => [6, 24, 42],
|
|
9 => [6, 26, 46],
|
|
10 => [6, 28, 50],
|
|
11 => [6, 30, 54],
|
|
12 => [6, 32, 58],
|
|
13 => [6, 34, 62],
|
|
14 => [6, 26, 46, 66],
|
|
15 => [6, 26, 48, 70],
|
|
16 => [6, 26, 50, 74],
|
|
17 => [6, 30, 54, 78],
|
|
18 => [6, 30, 56, 82],
|
|
19 => [6, 30, 58, 86],
|
|
20 => [6, 34, 62, 90],
|
|
21 => [6, 28, 50, 72, 94],
|
|
22 => [6, 26, 50, 74, 98],
|
|
23 => [6, 30, 54, 78, 102],
|
|
24 => [6, 28, 54, 80, 106],
|
|
25 => [6, 32, 58, 84, 110],
|
|
26 => [6, 30, 58, 86, 114],
|
|
27 => [6, 34, 62, 90, 118],
|
|
28 => [6, 26, 50, 74, 98, 122],
|
|
29 => [6, 30, 54, 78, 102, 126],
|
|
30 => [6, 26, 52, 78, 104, 130],
|
|
31 => [6, 30, 56, 82, 108, 134],
|
|
32 => [6, 34, 60, 86, 112, 138],
|
|
33 => [6, 30, 58, 86, 114, 142],
|
|
34 => [6, 34, 62, 90, 118, 146],
|
|
35 => [6, 30, 54, 78, 102, 126, 150],
|
|
36 => [6, 24, 50, 76, 102, 128, 154],
|
|
37 => [6, 28, 54, 80, 106, 132, 158],
|
|
38 => [6, 32, 58, 84, 110, 136, 162],
|
|
39 => [6, 26, 54, 82, 110, 138, 166],
|
|
40 => [6, 30, 58, 86, 114, 142, 170],
|
|
];
|
|
|
|
/**
|
|
* @link http://www.thonky.com/qr-code-tutorial/format-version-tables
|
|
*
|
|
* no version pattern for QR Codes < 7
|
|
*/
|
|
protected const versionPattern = [
|
|
7 => 0b000111110010010100,
|
|
8 => 0b001000010110111100,
|
|
9 => 0b001001101010011001,
|
|
10 => 0b001010010011010011,
|
|
11 => 0b001011101111110110,
|
|
12 => 0b001100011101100010,
|
|
13 => 0b001101100001000111,
|
|
14 => 0b001110011000001101,
|
|
15 => 0b001111100100101000,
|
|
16 => 0b010000101101111000,
|
|
17 => 0b010001010001011101,
|
|
18 => 0b010010101000010111,
|
|
19 => 0b010011010100110010,
|
|
20 => 0b010100100110100110,
|
|
21 => 0b010101011010000011,
|
|
22 => 0b010110100011001001,
|
|
23 => 0b010111011111101100,
|
|
24 => 0b011000111011000100,
|
|
25 => 0b011001000111100001,
|
|
26 => 0b011010111110101011,
|
|
27 => 0b011011000010001110,
|
|
28 => 0b011100110000011010,
|
|
29 => 0b011101001100111111,
|
|
30 => 0b011110110101110101,
|
|
31 => 0b011111001001010000,
|
|
32 => 0b100000100111010101,
|
|
33 => 0b100001011011110000,
|
|
34 => 0b100010100010111010,
|
|
35 => 0b100011011110011111,
|
|
36 => 0b100100101100001011,
|
|
37 => 0b100101010000101110,
|
|
38 => 0b100110101001100100,
|
|
39 => 0b100111010101000001,
|
|
40 => 0b101000110001101001,
|
|
];
|
|
|
|
// ECC level -> mask pattern
|
|
protected const formatPattern = [
|
|
[ // L
|
|
0b111011111000100,
|
|
0b111001011110011,
|
|
0b111110110101010,
|
|
0b111100010011101,
|
|
0b110011000101111,
|
|
0b110001100011000,
|
|
0b110110001000001,
|
|
0b110100101110110,
|
|
],
|
|
[ // M
|
|
0b101010000010010,
|
|
0b101000100100101,
|
|
0b101111001111100,
|
|
0b101101101001011,
|
|
0b100010111111001,
|
|
0b100000011001110,
|
|
0b100111110010111,
|
|
0b100101010100000,
|
|
],
|
|
[ // Q
|
|
0b011010101011111,
|
|
0b011000001101000,
|
|
0b011111100110001,
|
|
0b011101000000110,
|
|
0b010010010110100,
|
|
0b010000110000011,
|
|
0b010111011011010,
|
|
0b010101111101101,
|
|
],
|
|
[ // H
|
|
0b001011010001001,
|
|
0b001001110111110,
|
|
0b001110011100111,
|
|
0b001100111010000,
|
|
0b000011101100010,
|
|
0b000001001010101,
|
|
0b000110100001100,
|
|
0b000100000111011,
|
|
],
|
|
];
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
protected $version;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
protected $eclevel;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
protected $maskPattern = QRCode::MASK_PATTERN_AUTO;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
protected $moduleCount;
|
|
|
|
/**
|
|
* @var mixed[]
|
|
*/
|
|
protected $matrix;
|
|
|
|
/**
|
|
* QRMatrix constructor.
|
|
*
|
|
* @param int $version
|
|
* @param int $eclevel
|
|
*
|
|
* @throws \chillerlan\QRCode\Data\QRCodeDataException
|
|
*/
|
|
public function __construct(int $version, int $eclevel){
|
|
|
|
if(!\in_array($version, \range(1, 40), true)){
|
|
throw new QRCodeDataException('invalid QR Code version');
|
|
}
|
|
|
|
if(!\array_key_exists($eclevel, QRCode::ECC_MODES)){
|
|
throw new QRCodeDataException('invalid ecc level');
|
|
}
|
|
|
|
$this->version = $version;
|
|
$this->eclevel = $eclevel;
|
|
$this->moduleCount = $this->version * 4 + 17;
|
|
$this->matrix = \array_fill(0, $this->moduleCount, \array_fill(0, $this->moduleCount, $this::M_NULL));
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function matrix():array{
|
|
return $this->matrix;
|
|
}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function version():int{
|
|
return $this->version;
|
|
}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function eccLevel():int{
|
|
return $this->eclevel;
|
|
}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function maskPattern():int{
|
|
return $this->maskPattern;
|
|
}
|
|
|
|
/**
|
|
* Returns the absoulute size of the matrix, including quiet zone (after setting it).
|
|
*
|
|
* size = version * 4 + 17 [ + 2 * quietzone size]
|
|
*
|
|
* @return int
|
|
*/
|
|
public function size():int{
|
|
return $this->moduleCount;
|
|
}
|
|
|
|
/**
|
|
* Returns the value of the module at position [$x, $y]
|
|
*
|
|
* @param int $x
|
|
* @param int $y
|
|
*
|
|
* @return int
|
|
*/
|
|
public function get(int $x, int $y):int{
|
|
return $this->matrix[$y][$x];
|
|
}
|
|
|
|
/**
|
|
* Sets the $M_TYPE value for the module at position [$x, $y]
|
|
*
|
|
* true => $M_TYPE << 8
|
|
* false => $M_TYPE
|
|
*
|
|
* @param int $x
|
|
* @param int $y
|
|
* @param int $M_TYPE
|
|
* @param bool $value
|
|
*
|
|
* @return \chillerlan\QRCode\Data\QRMatrix
|
|
*/
|
|
public function set(int $x, int $y, bool $value, int $M_TYPE):QRMatrix{
|
|
$this->matrix[$y][$x] = $M_TYPE << ($value ? 8 : 0);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Checks whether a module is true (dark) or false (light)
|
|
*
|
|
* true => $value >> 8 === $M_TYPE
|
|
* $value >> 8 > 0
|
|
*
|
|
* false => $value === $M_TYPE
|
|
* $value >> 8 === 0
|
|
*
|
|
* @param int $x
|
|
* @param int $y
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function check(int $x, int $y):bool{
|
|
return $this->matrix[$y][$x] >> 8 > 0;
|
|
}
|
|
|
|
|
|
/**
|
|
* Sets the "dark module", that is always on the same position 1x1px away from the bottom left finder
|
|
*
|
|
* @return \chillerlan\QRCode\Data\QRMatrix
|
|
*/
|
|
public function setDarkModule():QRMatrix{
|
|
$this->set(8, 4 * $this->version + 9, true, $this::M_DARKMODULE);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Draws the 7x7 finder patterns in the corners top left/right and bottom left
|
|
*
|
|
* @return \chillerlan\QRCode\Data\QRMatrix
|
|
*/
|
|
public function setFinderPattern():QRMatrix{
|
|
|
|
$pos = [
|
|
[0, 0], // top left
|
|
[$this->moduleCount - 7, 0], // bottom left
|
|
[0, $this->moduleCount - 7], // top right
|
|
];
|
|
|
|
foreach($pos as $c){
|
|
for($y = 0; $y < 7; $y++){
|
|
for($x = 0; $x < 7; $x++){
|
|
$this->set(
|
|
$c[0] + $y,
|
|
$c[1] + $x,
|
|
!(($x > 0 && $x < 6 && ($y === 1 || $y === 5)) || ($y > 0 && $y < 6 && ($x === 1 || $x === 5))),
|
|
$this::M_FINDER
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Draws the separator lines around the finder patterns
|
|
*
|
|
* @return \chillerlan\QRCode\Data\QRMatrix
|
|
*/
|
|
public function setSeparators():QRMatrix{
|
|
|
|
$h = [
|
|
[7, 0],
|
|
[$this->moduleCount - 8, 0],
|
|
[7, $this->moduleCount - 8],
|
|
];
|
|
|
|
$v = [
|
|
[7, 7],
|
|
[$this->moduleCount - 1, 7],
|
|
[7, $this->moduleCount - 8],
|
|
];
|
|
|
|
for($c = 0; $c < 3; $c++){
|
|
for($i = 0; $i < 8; $i++){
|
|
$this->set($h[$c][0] , $h[$c][1] + $i, false, $this::M_SEPARATOR);
|
|
$this->set($v[$c][0] - $i, $v[$c][1] , false, $this::M_SEPARATOR);
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
|
|
/**
|
|
* Draws the 5x5 alignment patterns
|
|
*
|
|
* @return \chillerlan\QRCode\Data\QRMatrix
|
|
*/
|
|
public function setAlignmentPattern():QRMatrix{
|
|
|
|
foreach($this::alignmentPattern[$this->version] as $y){
|
|
foreach($this::alignmentPattern[$this->version] as $x){
|
|
|
|
// skip existing patterns
|
|
if($this->matrix[$y][$x] !== $this::M_NULL){
|
|
continue;
|
|
}
|
|
|
|
for($ry = -2; $ry <= 2; $ry++){
|
|
for($rx = -2; $rx <= 2; $rx++){
|
|
$v = ($ry === 0 && $rx === 0) || $ry === 2 || $ry === -2 || $rx === 2 || $rx === -2;
|
|
|
|
$this->set($x + $rx, $y + $ry, $v, $this::M_ALIGNMENT);
|
|
}
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
|
|
/**
|
|
* Draws the timing pattern (h/v checkered line between the finder patterns)
|
|
*
|
|
* @return \chillerlan\QRCode\Data\QRMatrix
|
|
*/
|
|
public function setTimingPattern():QRMatrix{
|
|
|
|
foreach(\range(8, $this->moduleCount - 8 - 1) as $i){
|
|
|
|
if($this->matrix[6][$i] !== $this::M_NULL || $this->matrix[$i][6] !== $this::M_NULL){
|
|
continue;
|
|
}
|
|
|
|
$v = $i % 2 === 0;
|
|
|
|
$this->set($i, 6, $v, $this::M_TIMING); // h
|
|
$this->set(6, $i, $v, $this::M_TIMING); // v
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Draws the version information, 2x 3x6 pixel
|
|
*
|
|
* @param bool|null $test
|
|
*
|
|
* @return \chillerlan\QRCode\Data\QRMatrix
|
|
*/
|
|
public function setVersionNumber(bool $test = null):QRMatrix{
|
|
$bits = $this::versionPattern[$this->version] ?? false;
|
|
|
|
if($bits !== false){
|
|
|
|
for($i = 0; $i < 18; $i++){
|
|
$a = (int)\floor($i / 3);
|
|
$b = $i % 3 + $this->moduleCount - 8 - 3;
|
|
$v = !$test && (($bits >> $i) & 1) === 1;
|
|
|
|
$this->set($b, $a, $v, $this::M_VERSION); // ne
|
|
$this->set($a, $b, $v, $this::M_VERSION); // sw
|
|
}
|
|
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Draws the format info along the finder patterns
|
|
*
|
|
* @param int $maskPattern
|
|
* @param bool|null $test
|
|
*
|
|
* @return \chillerlan\QRCode\Data\QRMatrix
|
|
*/
|
|
public function setFormatInfo(int $maskPattern, bool $test = null):QRMatrix{
|
|
$bits = $this::formatPattern[QRCode::ECC_MODES[$this->eclevel]][$maskPattern] ?? 0;
|
|
|
|
for($i = 0; $i < 15; $i++){
|
|
$v = !$test && (($bits >> $i) & 1) === 1;
|
|
|
|
if($i < 6){
|
|
$this->set(8, $i, $v, $this::M_FORMAT);
|
|
}
|
|
elseif($i < 8){
|
|
$this->set(8, $i + 1, $v, $this::M_FORMAT);
|
|
}
|
|
else{
|
|
$this->set(8, $this->moduleCount - 15 + $i, $v, $this::M_FORMAT);
|
|
}
|
|
|
|
if($i < 8){
|
|
$this->set($this->moduleCount - $i - 1, 8, $v, $this::M_FORMAT);
|
|
}
|
|
elseif($i < 9){
|
|
$this->set(15 - $i, 8, $v, $this::M_FORMAT);
|
|
}
|
|
else{
|
|
$this->set(15 - $i - 1, 8, $v, $this::M_FORMAT);
|
|
}
|
|
|
|
}
|
|
|
|
$this->set(8, $this->moduleCount - 8, !$test, $this::M_FORMAT);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Draws the "quiet zone" of $size around the matrix
|
|
*
|
|
* @param int|null $size
|
|
*
|
|
* @return \chillerlan\QRCode\Data\QRMatrix
|
|
* @throws \chillerlan\QRCode\Data\QRCodeDataException
|
|
*/
|
|
public function setQuietZone(int $size = null):QRMatrix{
|
|
|
|
if($this->matrix[$this->moduleCount - 1][$this->moduleCount - 1] === $this::M_NULL){
|
|
throw new QRCodeDataException('use only after writing data');
|
|
}
|
|
|
|
$size = $size !== null
|
|
? \max(0, \min($size, \floor($this->moduleCount / 2)))
|
|
: 4;
|
|
|
|
for($y = 0; $y < $this->moduleCount; $y++){
|
|
for($i = 0; $i < $size; $i++){
|
|
\array_unshift($this->matrix[$y], $this::M_QUIETZONE);
|
|
\array_push($this->matrix[$y], $this::M_QUIETZONE);
|
|
}
|
|
}
|
|
|
|
$this->moduleCount += ($size * 2);
|
|
|
|
$r = \array_fill(0, $this->moduleCount, $this::M_QUIETZONE);
|
|
|
|
for($i = 0; $i < $size; $i++){
|
|
\array_unshift($this->matrix, $r);
|
|
\array_push($this->matrix, $r);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Maps the binary $data array from QRDataInterface::maskECC() on the matrix, using $maskPattern
|
|
*
|
|
* @see \chillerlan\QRCode\Data\QRDataAbstract::maskECC()
|
|
*
|
|
* @param int[] $data
|
|
* @param int $maskPattern
|
|
*
|
|
* @return \chillerlan\QRCode\Data\QRMatrix
|
|
*/
|
|
public function mapData(array $data, int $maskPattern):QRMatrix{
|
|
$this->maskPattern = $maskPattern;
|
|
$byteCount = \count($data);
|
|
$size = $this->moduleCount - 1;
|
|
|
|
for($i = $size, $y = $size, $inc = -1, $byteIndex = 0, $bitIndex = 7; $i > 0; $i -= 2){
|
|
|
|
if($i === 6){
|
|
$i--;
|
|
}
|
|
|
|
while(true){
|
|
for($c = 0; $c < 2; $c++){
|
|
$x = $i - $c;
|
|
|
|
if($this->matrix[$y][$x] === $this::M_NULL){
|
|
$v = false;
|
|
|
|
if($byteIndex < $byteCount){
|
|
$v = (($data[$byteIndex] >> $bitIndex) & 1) === 1;
|
|
}
|
|
|
|
if($this->getMask($x, $y, $maskPattern) === 0){
|
|
$v = !$v;
|
|
}
|
|
|
|
$this->matrix[$y][$x] = $this::M_DATA << ($v ? 8 : 0);
|
|
$bitIndex--;
|
|
|
|
if($bitIndex === -1){
|
|
$byteIndex++;
|
|
$bitIndex = 7;
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
$y += $inc;
|
|
|
|
if($y < 0 || $this->moduleCount <= $y){
|
|
$y -= $inc;
|
|
$inc = -$inc;
|
|
|
|
break;
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @see \chillerlan\QRCode\QRMatrix::mapData()
|
|
*
|
|
* @internal
|
|
*
|
|
* @param int $x
|
|
* @param int $y
|
|
* @param int $maskPattern
|
|
*
|
|
* @return int
|
|
* @throws \chillerlan\QRCode\Data\QRCodeDataException
|
|
*/
|
|
protected function getMask(int $x, int $y, int $maskPattern):int{
|
|
$a = $y + $x;
|
|
$m = $y * $x;
|
|
|
|
if($maskPattern >= 0 && $maskPattern < 8){
|
|
// this is literally the same as the stupid switch...
|
|
return [
|
|
$a % 2,
|
|
$y % 2,
|
|
$x % 3,
|
|
$a % 3,
|
|
(\floor($y / 2) + \floor($x / 3)) % 2,
|
|
$m % 2 + $m % 3,
|
|
($m % 2 + $m % 3) % 2,
|
|
($m % 3 + $a % 2) % 2
|
|
][$maskPattern];
|
|
}
|
|
|
|
throw new QRCodeDataException('invalid mask pattern'); // @codeCoverageIgnore
|
|
}
|
|
|
|
}
|