svgMeltedModules.php 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. <?php
  2. /**
  3. * This code generates an SVG QR code with rounded corners. It uses a round rect for each square and then additional
  4. * paths to fill in the gap where squares are next to each other. Adjacent squares overlap - to almost completely
  5. * eliminate hairline antialias "cracks" that tend to appear when two SVG paths are exactly adjacent to each other.
  6. *
  7. * @see https://github.com/chillerlan/php-qrcode/issues/127
  8. */
  9. use chillerlan\QRCode\{QRCode, QROptions};
  10. use chillerlan\QRCode\Common\EccLevel;
  11. use chillerlan\QRCode\Data\QRMatrix;
  12. use chillerlan\QRCode\Output\{QROutputInterface, QRMarkupSVG};
  13. require_once __DIR__.'/../vendor/autoload.php';
  14. /*
  15. * Class definition
  16. */
  17. /**
  18. * the extended SVG output module
  19. */
  20. class MeltedSVGQRCodeOutput extends QRMarkupSVG{
  21. /**
  22. * @inheritDoc
  23. */
  24. protected function path(string $path, int $M_TYPE):string{
  25. // omit the "fill" and "opacity" attributes on the path element
  26. return sprintf('<path class="%s" d="%s"/>', $this->getCssClass($M_TYPE), $path);
  27. }
  28. /**
  29. * @inheritDoc
  30. */
  31. protected function collectModules(Closure $transform):array{
  32. $paths = [];
  33. // collect the modules for each type
  34. foreach($this->matrix->matrix() as $y => $row){
  35. foreach($row as $x => $M_TYPE){
  36. $M_TYPE_LAYER = $M_TYPE;
  37. if($this->options->connectPaths && !$this->matrix->checkTypeIn($x, $y, $this->options->excludeFromConnect)){
  38. // to connect paths we'll redeclare the $M_TYPE_LAYER to data only
  39. $M_TYPE_LAYER = QRMatrix::M_DATA;
  40. if($this->matrix->check($x, $y)){
  41. $M_TYPE_LAYER |= QRMatrix::IS_DARK;
  42. }
  43. }
  44. // if we're going to "melt" the matrix, we'll declare *all* modules as dark,
  45. // so that light modules with dark parts are rendered in the same path
  46. if($this->options->melt){
  47. $M_TYPE_LAYER |= QRMatrix::IS_DARK;
  48. }
  49. // collect the modules per $M_TYPE
  50. $module = $transform($x, $y, $M_TYPE, $M_TYPE_LAYER);
  51. if(!empty($module)){
  52. $paths[$M_TYPE_LAYER][] = $module;
  53. }
  54. }
  55. }
  56. // beautify output
  57. ksort($paths);
  58. return $paths;
  59. }
  60. /**
  61. * @inheritDoc
  62. */
  63. protected function module(int $x, int $y, int $M_TYPE):string{
  64. $bits = $this->matrix->checkNeighbours($x, $y, null);
  65. $check = fn(int $all, int $any = 0):bool => ($bits & ($all | (~$any & 0xff))) === $all;
  66. $template = ($M_TYPE & QRMatrix::IS_DARK) === QRMatrix::IS_DARK
  67. ? $this->darkModule($check, $this->options->inverseMelt)
  68. : $this->lightModule($check, $this->options->inverseMelt);
  69. $r = $this->options->meltRadius;
  70. return sprintf($template, $x, $y, $r, (1 - $r), (1 - 2 * $r));
  71. }
  72. /**
  73. * returns a dark module for the given values
  74. */
  75. protected function darkModule(Closure $check, bool $invert):string{
  76. switch(true){
  77. // 4 rounded
  78. case !$invert && $check(0b00000000, 0b01010101):
  79. case $invert && $check(0b00000000, 0b00000000):
  80. return 'M%1$s,%2$s m0,%3$s v%5$s q0,%3$s %3$s,%3$s h%5$s q%3$s,0 %3$s,-%3$s v-%5$s q0,-%3$s -%3$s,-%3$s h-%5$s q-%3$s,0 -%3$s,%3$sZ';
  81. // 3 rounded
  82. case $invert && $check(0b01000000, 0b00000000): // 135
  83. return 'M%1$s,%2$s m0,1 h%4$s q%3$s,0 %3$s,-%3$s v-%5$s q0,-%3$s -%3$s,-%3$s h-%5$s q-%3$s,0 -%3$s,%3$sZ';
  84. case $invert && $check(0b00000001, 0b00000000): // 357
  85. return 'M%1$s,%2$s v%4$s q0,%3$s %3$s,%3$s h%5$s q%3$s,0 %3$s,-%3$s v-%5$s q0,-%3$s -%3$s,-%3$sZ';
  86. case $invert && $check(0b00000100, 0b00000000): // 571
  87. return 'M%1$s,%2$s m1,0 v%4$s q0,%3$s -%3$s,%3$s h-%5$s q-%3$s,0 -%3$s,-%3$s v-%5$s q0,-%3$s %3$s,-%3$sZ';
  88. case $invert && $check(0b00010000, 0b00000000): // 713
  89. return 'M%1$s,%2$s m1,1 h-%4$s q-%3$s,0 -%3$s,-%3$s v-%5$s q0,-%3$s %3$s,-%3$s h%5$s q%3$s,0 %3$s,%3$sZ';
  90. // 2 rounded
  91. case !$invert && $check(0b00100000, 0b01010101): // 13
  92. case $invert && $check(0b00000000, 0b01110000):
  93. return 'M%1$s,%2$s m0,1 h1 v-%4$s q0,-%3$s -%3$s,-%3$s h-%5$s q-%3$s,0 -%3$s,%3$sZ';
  94. case !$invert && $check(0b10000000, 0b01010101): // 35
  95. case $invert && $check(0b00000000, 0b11000001):
  96. return 'M%1$s,%2$s v1 h%4$s q%3$s,0 %3$s,-%3$s v-%5$s q0,-%3$s -%3$s,-%3$sZ';
  97. case !$invert && $check(0b00000010, 0b01010101): // 57
  98. case $invert && $check(0b00000000, 0b00000111):
  99. return 'M%1$s,%2$s v%4$s q0,%3$s %3$s,%3$s h%5$s q%3$s,0 %3$s,-%3$s v-%4$sZ';
  100. case !$invert && $check(0b00001000, 0b01010101): // 71
  101. case $invert && $check(0b00000000, 0b00011100):
  102. return 'M%1$s,%2$s m1,1 v-1 h-%4$s q-%3$s,0 -%3$s,%3$s v%5$s q0,%3$s %3$s,%3$sZ';
  103. // diagonal
  104. case $invert && $check(0b01000100, 0b00000000): // 15
  105. return 'M%1$s,%2$s m0,1 h%4$s q%3$s,0 %3$s,-%3$s v-%4$s h-%4$s q-%3$s,0 -%3$s,%3$sZ';
  106. case $invert && $check(0b00010001, 0b00000000): // 37
  107. return 'M%1$s,%2$s h%4$s q%3$s,0 %3$s,%3$s v%4$s h-%4$s q-%3$s,0 -%3$s,-%3$sZ';
  108. // 1 rounded
  109. case !$invert && $check(0b00101000, 0b01010101): // 1
  110. case $invert && $check(0b00000000, 0b01111100):
  111. return 'M%1$s,%2$s m0,1 h1 v-1 h-%4$s q-%3$s,0 -%3$s,%3$sZ';
  112. case !$invert && $check(0b10100000, 0b01010101): // 3
  113. case $invert && $check(0b00000000, 0b11110001):
  114. return 'M%1$s,%2$s h%4$s q%3$s,0 %3$s,%3$s v%4$s h-1Z';
  115. case !$invert && $check(0b10000010, 0b01010101): // 5
  116. case $invert && $check(0b00000000, 0b11000111):
  117. return 'M%1$s,%2$s h1 v%4$s q0,%3$s -%3$s,%3$s h-%4$sZ';
  118. case !$invert && $check(0b00001010, 0b01010101): // 7
  119. case $invert && $check(0b00000000, 0b00011111):
  120. return 'M%1$s,%2$s v%4$s q0,%3$s %3$s,%3$s h%4$s v-1Z';
  121. }
  122. // full square
  123. return 'M%1$s,%2$s h1 v1 h-1Z';
  124. }
  125. /**
  126. * returns a light module for the given values
  127. */
  128. protected function lightModule(Closure $check, bool $invert):string{
  129. switch(true){
  130. // 4 rounded
  131. case !$invert && $check(0b11111111, 0b01010101):
  132. case $invert && $check(0b10101010, 0b01010101):
  133. return 'M%1$s,%2$s h%3$s q-%3$s,0 -%3$s,%3$sz m1,0 v%3$s q0,-%3$s -%3$s,-%3$sz m0,1 h-%3$s q%3$s,0 %3$s,-%3$sz m-1,0 v-%3$s q0,%3$s %3$s,%3$sZ';
  134. // 3 rounded
  135. case !$invert && $check(0b10111111, 0b00000000): // 135
  136. return 'M%1$s,%2$s h%3$s q-%3$s,0 -%3$s,%3$sz m1,0 v%3$s q0,-%3$s -%3$s,-%3$sz m0,1 h-%3$s q%3$s,0 %3$s,-%3$sZ';
  137. case !$invert && $check(0b11111110, 0b00000000): // 357
  138. return 'M%1$s,%2$s m1,0 v%3$s q0,-%3$s -%3$s,-%3$sz m0,1 h-%3$s q%3$s,0 %3$s,-%3$sz m-1,0 v-%3$s q0,%3$s %3$s,%3$sZ';
  139. case !$invert && $check(0b11111011, 0b00000000): // 571
  140. return 'M%1$s,%2$s h%3$s q-%3$s,0 -%3$s,%3$sz m0,1 v-%3$s q0,%3$s %3$s,%3$sz m1,0 h-%3$s q%3$s,0 %3$s,-%3$sZ';
  141. case !$invert && $check(0b11101111, 0b00000000): // 713
  142. return 'M%1$s,%2$s h%3$s q-%3$s,0 -%3$s,%3$sz m0,1 v-%3$s q0,%3$s %3$s,%3$sz m1,-1 v%3$s q0,-%3$s -%3$s,-%3$sZ';
  143. // 2 rounded
  144. case !$invert && $check(0b10001111, 0b01110000): // 13
  145. case $invert && $check(0b10001010, 0b01010101):
  146. return 'M%1$s,%2$s h%3$s q-%3$s,0 -%3$s,%3$sz m1,0 v%3$s q0,-%3$s -%3$s,-%3$sZ';
  147. case !$invert && $check(0b00111110, 0b11000001): // 35
  148. case $invert && $check(0b00101010, 0b01010101):
  149. return 'M%1$s,%2$s m1,0 v%3$s q0,-%3$s -%3$s,-%3$sz m0,1 h-%3$s q%3$s,0 %3$s,-%3$sZ';
  150. case !$invert && $check(0b11111000, 0b00000111): // 57
  151. case $invert && $check(0b10101000, 0b01010101):
  152. return 'M%1$s,%2$s m1,1 h-%3$s q%3$s,0 %3$s,-%3$sz m-1,0 v-%3$s q0,%3$s %3$s,%3$sZ';
  153. case !$invert && $check(0b11100011, 0b00011100): // 71
  154. case $invert && $check(0b10100010, 0b01010101):
  155. return 'M%1$s,%2$s h%3$s q-%3$s,0 -%3$s,%3$sz m0,1 v-%3$s q0,%3$s %3$s,%3$sZ';
  156. // diagonal
  157. case !$invert && $check(0b10111011, 0b00000000): // 15
  158. return 'M%1$s,%2$s h%3$s q-%3$s,0 -%3$s,%3$sz m1,1 h-%3$s q%3$s,0 %3$s,-%3$sZ';
  159. case !$invert && $check(0b11101110, 0b00000000): // 37
  160. return 'M%1$s,%2$s m1,0 v%3$s q0,-%3$s -%3$s,-%3$sz m-1,1 v-%3$s q0,%3$s %3$s,%3$sZ';
  161. // 1 rounded
  162. case !$invert && $check(0b10000011, 0b01111100): // 1
  163. case $invert && $check(0b10000010, 0b01010101):
  164. return 'M%1$s,%2$s h%3$s q-%3$s,0 -%3$s,%3$sZ';
  165. case !$invert && $check(0b00001110, 0b11110001): // 3
  166. case $invert && $check(0b00001010, 0b01010101):
  167. return 'M%1$s,%2$s m1,0 v%3$s q0,-%3$s -%3$s,-%3$sZ';
  168. case !$invert && $check(0b00111000, 0b11000111): // 5
  169. case $invert && $check(0b00101000, 0b01010101):
  170. return 'M%1$s,%2$s m1,1 h-%3$s q%3$s,0 %3$s,-%3$sZ';
  171. case !$invert && $check(0b11100000, 0b00011111): // 7
  172. case $invert && $check(0b10100000, 0b01010101):
  173. return 'M%1$s,%2$s m0,1 v-%3$s q0,%3$s %3$s,%3$sZ';
  174. }
  175. // empty block
  176. return '';
  177. }
  178. }
  179. /**
  180. * the augmented options class
  181. */
  182. class MeltedOutputOptions extends QROptions{
  183. /**
  184. * enable "melt" effect
  185. */
  186. protected bool $melt = false;
  187. /**
  188. * whether to let the melt effect flow along the dark or light modules
  189. */
  190. protected bool $inverseMelt = false;
  191. /**
  192. * the corner radius for melted modules
  193. */
  194. protected float $meltRadius = 0.15;
  195. /**
  196. * clamp/set melt corner radius
  197. */
  198. protected function set_meltRadius(float $meltRadius):void{
  199. $this->meltRadius = max(0.01, min(0.5, $meltRadius));
  200. }
  201. }
  202. /*
  203. * Runtime
  204. */
  205. $options = new MeltedOutputOptions([
  206. 'melt' => true,
  207. 'inverseMelt' => true,
  208. 'meltRadius' => 0.4,
  209. 'version' => 7,
  210. 'eccLevel' => EccLevel::H,
  211. 'addQuietzone' => true,
  212. 'addLogoSpace' => true,
  213. 'logoSpaceWidth' => 13,
  214. 'logoSpaceHeight' => 13,
  215. 'connectPaths' => true,
  216. 'imageBase64' => false,
  217. 'outputType' => QROutputInterface::CUSTOM,
  218. 'outputInterface' => MeltedSVGQRCodeOutput::class,
  219. 'excludeFromConnect' => [
  220. QRMatrix::M_FINDER_DARK,
  221. QRMatrix::M_FINDER_DOT,
  222. ],
  223. 'svgDefs' => '
  224. <linearGradient id="rainbow" x1="100%" y2="100%">
  225. <stop stop-color="#e2453c" offset="2.5%"/>
  226. <stop stop-color="#e07e39" offset="21.5%"/>
  227. <stop stop-color="#e5d667" offset="40.5%"/>
  228. <stop stop-color="#51b95b" offset="59.5%"/>
  229. <stop stop-color="#1e72b7" offset="78.5%"/>
  230. <stop stop-color="#6f5ba7" offset="97.5%"/>
  231. </linearGradient>
  232. <style><![CDATA[
  233. .light, .dark{fill: url(#rainbow);}
  234. ]]></style>',
  235. ]);
  236. $qrcode = (new QRCode($options))->render('https://www.youtube.com/watch?v=dQw4w9WgXcQ');
  237. if(php_sapi_name() !== 'cli'){
  238. header('Content-type: image/svg+xml');
  239. if(extension_loaded('zlib')){
  240. header('Vary: Accept-Encoding');
  241. header('Content-Encoding: gzip');
  242. $qrcode = gzencode($qrcode, 9);
  243. }
  244. }
  245. echo $qrcode;
  246. exit;