svgMeltedModules.php 10 KB

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