svgMeltedModules.php 9.9 KB

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