svgMeltedModules.php 10 KB

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