|
1
|
|
|
<?php declare(strict_types=1); |
|
2
|
|
|
|
|
3
|
|
|
namespace Sprain\SwissQrBill\QrCode; |
|
4
|
|
|
|
|
5
|
|
|
use Endroid\QrCode\Encoding\Encoding; |
|
6
|
|
|
use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelMedium; |
|
7
|
|
|
use Endroid\QrCode\Logo\Logo; |
|
8
|
|
|
use Endroid\QrCode\RoundBlockSizeMode\RoundBlockSizeModeEnlarge; |
|
9
|
|
|
use Endroid\QrCode\QrCode as BaseQrCode; |
|
10
|
|
|
use Endroid\QrCode\Writer\PngWriter; |
|
11
|
|
|
use Endroid\QrCode\Writer\Result\ResultInterface; |
|
12
|
|
|
use Endroid\QrCode\Writer\SvgWriter; |
|
13
|
|
|
use Endroid\QrCode\Writer\WriterInterface; |
|
14
|
|
|
use Sprain\SwissQrBill\QrCode\Exception\UnsupportedFileExtensionException; |
|
15
|
|
|
|
|
16
|
|
|
final class QrCode |
|
17
|
|
|
{ |
|
18
|
|
|
public const FILE_FORMAT_PNG = 'png'; |
|
19
|
|
|
public const FILE_FORMAT_SVG = 'svg'; |
|
20
|
|
|
|
|
21
|
|
|
private const SUPPORTED_FILE_FORMATS = [ |
|
22
|
|
|
self::FILE_FORMAT_PNG, |
|
23
|
|
|
self::FILE_FORMAT_SVG |
|
24
|
|
|
]; |
|
25
|
|
|
|
|
26
|
|
|
private const SWISS_CROSS_LOGO_FILE = __DIR__ . '/../../assets/swiss-cross.optimized.png'; |
|
27
|
|
|
private const PX_QR_CODE = 543; // recommended 46x46 mm in px @ 300dpi – in pixel based outputs the final image size may be slightly different, depending on the qr code contents |
|
28
|
|
|
private const PX_SWISS_CROSS = 83; // recommended 7x7 mm in px @ 300dpi |
|
29
|
|
|
|
|
30
|
|
|
private BaseQrCode $qrCode; |
|
31
|
|
|
private Logo $qrCodeLogo; |
|
32
|
|
|
private WriterInterface $qrCodeWriter; |
|
33
|
|
|
|
|
34
|
|
|
public static function create(string $data, string $fileFormat = null): self |
|
35
|
|
|
{ |
|
36
|
|
|
if (null === $fileFormat) { |
|
37
|
|
|
$fileFormat = self::FILE_FORMAT_SVG; |
|
38
|
|
|
} |
|
39
|
|
|
|
|
40
|
|
|
return new self($data, $fileFormat); |
|
41
|
|
|
} |
|
42
|
|
|
|
|
43
|
|
|
private function __construct(string $data, string $fileFormat) |
|
44
|
|
|
{ |
|
45
|
|
|
$this->qrCode = BaseQrCode::create($data) |
|
46
|
|
|
->setEncoding(new Encoding('UTF-8')) |
|
47
|
|
|
->setErrorCorrectionLevel(new ErrorCorrectionLevelMedium()) |
|
48
|
|
|
->setSize(self::PX_QR_CODE) |
|
49
|
|
|
->setMargin(0) |
|
50
|
|
|
->setRoundBlockSizeMode(new RoundBlockSizeModeEnlarge()); |
|
51
|
|
|
|
|
52
|
|
|
$this->qrCodeLogo = Logo::create(self::SWISS_CROSS_LOGO_FILE) |
|
53
|
|
|
->setResizeToWidth(self::PX_SWISS_CROSS); |
|
54
|
|
|
|
|
55
|
|
|
$this->setWriterByExtension($fileFormat); |
|
56
|
|
|
} |
|
57
|
|
|
|
|
58
|
|
|
public function writeFile(string $path): void |
|
59
|
|
|
{ |
|
60
|
|
|
$extension = strtolower(pathinfo($path, PATHINFO_EXTENSION)); |
|
|
|
|
|
|
61
|
|
|
$this->setWriterByExtension($extension); |
|
62
|
|
|
$this->getQrCodeResult()->saveToFile($path); |
|
63
|
|
|
} |
|
64
|
|
|
|
|
65
|
|
|
/** |
|
66
|
|
|
* @deprecated Will be removed in v5. Use getDataUri() instead. |
|
67
|
|
|
*/ |
|
68
|
|
|
public function writeDataUri() |
|
69
|
|
|
{ |
|
70
|
|
|
return $this->getDataUri(); |
|
71
|
|
|
} |
|
72
|
|
|
|
|
73
|
|
|
public function getDataUri(string $format = self::FILE_FORMAT_SVG): string |
|
74
|
|
|
{ |
|
75
|
|
|
$this->setWriterByExtension($format); |
|
76
|
|
|
return $this->getQrCodeResult()->getDataUri(); |
|
77
|
|
|
} |
|
78
|
|
|
|
|
79
|
|
|
public function getAsString(string $format = self::FILE_FORMAT_SVG): string |
|
80
|
|
|
{ |
|
81
|
|
|
$this->setWriterByExtension($format); |
|
82
|
|
|
return $this->getQrCodeResult()->getString(); |
|
83
|
|
|
} |
|
84
|
|
|
|
|
85
|
|
|
public function getText(): string |
|
86
|
|
|
{ |
|
87
|
|
|
return $this->qrCode->getData(); |
|
88
|
|
|
} |
|
89
|
|
|
|
|
90
|
|
|
private function setWriterByExtension(string $extension): void |
|
91
|
|
|
{ |
|
92
|
|
|
if (!in_array($extension, self::SUPPORTED_FILE_FORMATS)) { |
|
93
|
|
|
throw new UnsupportedFileExtensionException(sprintf( |
|
94
|
|
|
'The qr code file cannot be created. Only these file formats are supported: %s. You provided: %s.', |
|
95
|
|
|
implode(', ', self::SUPPORTED_FILE_FORMATS), |
|
96
|
|
|
$extension |
|
97
|
|
|
)); |
|
98
|
|
|
} |
|
99
|
|
|
|
|
100
|
|
|
$this->qrCodeWriter = match ($extension) { |
|
101
|
|
|
self::FILE_FORMAT_SVG => new SvgWriter(), |
|
102
|
|
|
default => new PngWriter(), |
|
103
|
|
|
}; |
|
104
|
|
|
} |
|
105
|
|
|
|
|
106
|
|
|
private function getQrCodeResult(): ResultInterface |
|
107
|
|
|
{ |
|
108
|
|
|
return $this->qrCodeWriter->write( |
|
109
|
|
|
$this->qrCode, |
|
110
|
|
|
$this->qrCodeLogo, |
|
111
|
|
|
null, |
|
112
|
|
|
[SvgWriter::WRITER_OPTION_FORCE_XLINK_HREF => true] |
|
113
|
|
|
); |
|
114
|
|
|
} |
|
115
|
|
|
} |
|
116
|
|
|
|
sprain /
php-swiss-qr-bill
Loading history...