vendor/endroid/qr-code/src/Writer/SvgWriter.php line 23

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Endroid\QrCode\Writer;
  7. use Endroid\QrCode\Bacon\MatrixFactory;
  8. use Endroid\QrCode\ImageData\LogoImageData;
  9. use Endroid\QrCode\Label\LabelInterface;
  10. use Endroid\QrCode\Logo\LogoInterface;
  11. use Endroid\QrCode\QrCodeInterface;
  12. use Endroid\QrCode\Writer\Result\ResultInterface;
  13. use Endroid\QrCode\Writer\Result\SvgResult;
  15. final class SvgWriter implements WriterInterface
  16. {
  17. public const DECIMAL_PRECISION = 10;
  18. public const WRITER_OPTION_BLOCK_ID = 'block_id';
  19. public const WRITER_OPTION_EXCLUDE_XML_DECLARATION = 'exclude_xml_declaration';
  20. public const WRITER_OPTION_EXCLUDE_SVG_WIDTH_AND_HEIGHT = 'exclude_svg_width_and_height';
  21. public const WRITER_OPTION_FORCE_XLINK_HREF = 'force_xlink_href';
  23. public function write(QrCodeInterface $qrCode, LogoInterface $logo = null, LabelInterface $label = null, array $options = []): ResultInterface
  24. {
  25. if (!isset($options[self::WRITER_OPTION_BLOCK_ID])) {
  26. $options[self::WRITER_OPTION_BLOCK_ID] = 'block';
  27. }
  29. if (!isset($options[self::WRITER_OPTION_EXCLUDE_XML_DECLARATION])) {
  30. $options[self::WRITER_OPTION_EXCLUDE_XML_DECLARATION] = false;
  31. }
  33. if (!isset($options[self::WRITER_OPTION_EXCLUDE_SVG_WIDTH_AND_HEIGHT])) {
  34. $options[self::WRITER_OPTION_EXCLUDE_SVG_WIDTH_AND_HEIGHT] = false;
  35. }
  37. $matrixFactory = new MatrixFactory();
  38. $matrix = $matrixFactory->create($qrCode);
  40. $xml = new \SimpleXMLElement('<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"/>');
  41. $xml->addAttribute('version', '1.1');
  42. if (!$options[self::WRITER_OPTION_EXCLUDE_SVG_WIDTH_AND_HEIGHT]) {
  43. $xml->addAttribute('width', $matrix->getOuterSize().'px');
  44. $xml->addAttribute('height', $matrix->getOuterSize().'px');
  45. }
  46. $xml->addAttribute('viewBox', '0 0 '.$matrix->getOuterSize().' '.$matrix->getOuterSize());
  47. $xml->addChild('defs');
  49. $blockDefinition = $xml->defs->addChild('rect');
  50. $blockDefinition->addAttribute('id', strval($options[self::WRITER_OPTION_BLOCK_ID]));
  51. $blockDefinition->addAttribute('width', number_format($matrix->getBlockSize(), self::DECIMAL_PRECISION, '.', ''));
  52. $blockDefinition->addAttribute('height', number_format($matrix->getBlockSize(), self::DECIMAL_PRECISION, '.', ''));
  53. $blockDefinition->addAttribute('fill', '#'.sprintf('%02x%02x%02x', $qrCode->getForegroundColor()->getRed(), $qrCode->getForegroundColor()->getGreen(), $qrCode->getForegroundColor()->getBlue()));
  54. $blockDefinition->addAttribute('fill-opacity', strval($qrCode->getForegroundColor()->getOpacity()));
  56. $background = $xml->addChild('rect');
  57. $background->addAttribute('x', '0');
  58. $background->addAttribute('y', '0');
  59. $background->addAttribute('width', strval($matrix->getOuterSize()));
  60. $background->addAttribute('height', strval($matrix->getOuterSize()));
  61. $background->addAttribute('fill', '#'.sprintf('%02x%02x%02x', $qrCode->getBackgroundColor()->getRed(), $qrCode->getBackgroundColor()->getGreen(), $qrCode->getBackgroundColor()->getBlue()));
  62. $background->addAttribute('fill-opacity', strval($qrCode->getBackgroundColor()->getOpacity()));
  64. for ($rowIndex = 0; $rowIndex < $matrix->getBlockCount(); ++$rowIndex) {
  65. for ($columnIndex = 0; $columnIndex < $matrix->getBlockCount(); ++$columnIndex) {
  66. if (1 === $matrix->getBlockValue($rowIndex, $columnIndex)) {
  67. $block = $xml->addChild('use');
  68. $block->addAttribute('x', number_format($matrix->getMarginLeft() + $matrix->getBlockSize() * $columnIndex, self::DECIMAL_PRECISION, '.', ''));
  69. $block->addAttribute('y', number_format($matrix->getMarginLeft() + $matrix->getBlockSize() * $rowIndex, self::DECIMAL_PRECISION, '.', ''));
  70. $block->addAttribute('xlink:href', '#'.$options[self::WRITER_OPTION_BLOCK_ID], 'http://www.w3.org/1999/xlink');
  71. }
  72. }
  73. }
  75. $result = new SvgResult($matrix, $xml, boolval($options[self::WRITER_OPTION_EXCLUDE_XML_DECLARATION]));
  77. if ($logo instanceof LogoInterface) {
  78. $this->addLogo($logo, $result, $options);
  79. }
  81. return $result;
  82. }
  84. /** @param array<string, mixed> $options */
  85. private function addLogo(LogoInterface $logo, SvgResult $result, array $options): void
  86. {
  87. $logoImageData = LogoImageData::createForLogo($logo);
  89. if (!isset($options[self::WRITER_OPTION_FORCE_XLINK_HREF])) {
  90. $options[self::WRITER_OPTION_FORCE_XLINK_HREF] = false;
  91. }
  93. $xml = $result->getXml();
  95. /** @var \SimpleXMLElement $xmlAttributes */
  96. $xmlAttributes = $xml->attributes();
  98. $x = intval($xmlAttributes->width) / 2 - $logoImageData->getWidth() / 2;
  99. $y = intval($xmlAttributes->height) / 2 - $logoImageData->getHeight() / 2;
  101. $imageDefinition = $xml->addChild('image');
  102. $imageDefinition->addAttribute('x', strval($x));
  103. $imageDefinition->addAttribute('y', strval($y));
  104. $imageDefinition->addAttribute('width', strval($logoImageData->getWidth()));
  105. $imageDefinition->addAttribute('height', strval($logoImageData->getHeight()));
  106. $imageDefinition->addAttribute('preserveAspectRatio', 'none');
  108. if ($options[self::WRITER_OPTION_FORCE_XLINK_HREF]) {
  109. $imageDefinition->addAttribute('xlink:href', $logoImageData->createDataUri(), 'http://www.w3.org/1999/xlink');
  110. } else {
  111. $imageDefinition->addAttribute('href', $logoImageData->createDataUri());
  112. }
  113. }
  114. }