chillerlan-QRCode-Output-QRMarkupSVG.html 82 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. <li class="phpdocumentor-topnav__menu-item -menu">
  44. <a href="https://php-qrcode.readthedocs.io">
  45. <span>
  46. User Manual
  47. </span>
  48. </a>
  49. </li>
  50. <li class="phpdocumentor-topnav__menu-item -social">
  51. <a href="https://github.com/chillerlan/php-qrcode">
  52. <span>
  53. <i class="fab fa-github"></i>
  54. </span>
  55. </a>
  56. </li>
  57. </ul>
  58. </nav>
  59. </header>
  60. <main class="phpdocumentor">
  61. <div class="phpdocumentor-section">
  62. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  63. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  64. Menu
  65. </label>
  66. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  71. </h4>
  72. <ul class="phpdocumentor-list">
  73. <li>
  74. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  75. </li>
  76. <li>
  77. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  78. </li>
  79. </ul>
  80. </section>
  81. <section class="phpdocumentor-sidebar__category">
  82. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  83. <h4 class="phpdocumentor-sidebar__root-namespace">
  84. <a href="packages/Application.html" class="">Application</a>
  85. </h4>
  86. </section>
  87. <section class="phpdocumentor-sidebar__category">
  88. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  89. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  92. </section>
  93. <section class="phpdocumentor-sidebar__category">
  94. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  95. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  96. </section>
  97. </aside>
  98. <div class="phpdocumentor-column -eight phpdocumentor-content">
  99. <ul class="phpdocumentor-breadcrumbs">
  100. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  101. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  103. </ul>
  104. <article class="phpdocumentor-element -class">
  105. <h2 class="phpdocumentor-content__title">
  106. QRMarkupSVG
  107. <span class="phpdocumentor-element__extends">
  108. extends <a href="classes/chillerlan-QRCode-Output-QRMarkup.html"><abbr title="\chillerlan\QRCode\Output\QRMarkup">QRMarkup</abbr></a>
  109. </span>
  110. <div class="phpdocumentor-element__package">
  111. in package
  112. <ul class="phpdocumentor-breadcrumbs">
  113. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  114. </ul>
  115. </div>
  116. </h2>
  117. <aside class="phpdocumentor-element-found-in">
  118. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupSVG.php"><a href="files/src-output-qrmarkupsvg.html"><abbr title="src/Output/QRMarkupSVG.php">QRMarkupSVG.php</abbr></a></abbr>
  119. :
  120. <span class="phpdocumentor-element-found-in__line">24</span>
  121. </aside>
  122. <p class="phpdocumentor-summary">SVG output</p>
  123. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  124. Tags
  125. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  126. </h5>
  127. <dl class="phpdocumentor-tag-list">
  128. <dt class="phpdocumentor-tag-list__entry">
  129. <span class="phpdocumentor-tag__name">see</span>
  130. </dt>
  131. <dd class="phpdocumentor-tag-list__definition">
  132. <span class="phpdocumentor-tag-link"><a href="https://github.com/codemasher/php-qrcode/pull/5"><abbr title="https://github.com/codemasher/php-qrcode/pull/5">https://github.com/codemasher/php-qrcode/pull/5</abbr></a></span>
  133. </dd>
  134. <dt class="phpdocumentor-tag-list__entry">
  135. <span class="phpdocumentor-tag__name">see</span>
  136. </dt>
  137. <dd class="phpdocumentor-tag-list__definition">
  138. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg</abbr></a></span>
  139. </dd>
  140. <dt class="phpdocumentor-tag-list__entry">
  141. <span class="phpdocumentor-tag__name">see</span>
  142. </dt>
  143. <dd class="phpdocumentor-tag-list__definition">
  144. <span class="phpdocumentor-tag-link"><a href="https://www.sarasoueidan.com/demos/interactive-svg-coordinate-system/"><abbr title="https://www.sarasoueidan.com/demos/interactive-svg-coordinate-system/">https://www.sarasoueidan.com/demos/interactive-svg-coordinate-system/</abbr></a></span>
  145. </dd>
  146. <dt class="phpdocumentor-tag-list__entry">
  147. <span class="phpdocumentor-tag__name">see</span>
  148. </dt>
  149. <dd class="phpdocumentor-tag-list__definition">
  150. <span class="phpdocumentor-tag-link"><a href="http://apex.infogridpacific.com/SVG/svg-tutorial-contents.html"><abbr title="http://apex.infogridpacific.com/SVG/svg-tutorial-contents.html">http://apex.infogridpacific.com/SVG/svg-tutorial-contents.html</abbr></a></span>
  151. </dd>
  152. </dl>
  153. <h3 id="toc">
  154. Table of Contents
  155. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  156. </h3>
  157. <dl class="phpdocumentor-table-of-contents">
  158. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  159. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  160. <span>
  161. &nbsp;: int </span>
  162. </dt>
  163. <dd>the side length of the QR image (modules * scale)</dd>
  164. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  165. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  166. <span>
  167. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  168. </dt>
  169. <dd>the (filled) data matrix object</dd>
  170. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  171. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  172. <span>
  173. &nbsp;: int </span>
  174. </dt>
  175. <dd>the current size of the QR matrix</dd>
  176. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  177. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  178. <span>
  179. &nbsp;: array&lt;string|int, mixed&gt; </span>
  180. </dt>
  181. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  182. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  183. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  184. <span>
  185. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  186. </dt>
  187. <dd></dd>
  188. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  189. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  190. <span>
  191. &nbsp;: int </span>
  192. </dt>
  193. <dd>the current scaling for a QR pixel</dd>
  194. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  195. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  196. <span>
  197. &nbsp;: mixed </span>
  198. </dt>
  199. <dd>QROutputAbstract constructor.</dd>
  200. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  201. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump">dump()</a>
  202. <span>
  203. &nbsp;: string </span>
  204. </dt>
  205. <dd></dd>
  206. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  207. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  208. <span>
  209. &nbsp;: bool </span>
  210. </dt>
  211. <dd>note: we&#039;re not necessarily validating the several values, just checking the general syntax
  212. note: css4 colors are not included</dd>
  213. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  214. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  215. <span>
  216. &nbsp;: array&lt;string|int, mixed&gt; </span>
  217. </dt>
  218. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  219. returns an array with the transformed modules</dd>
  220. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  221. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_createMarkup">createMarkup()</a>
  222. <span>
  223. &nbsp;: string </span>
  224. </dt>
  225. <dd>returns the fully parsed and rendered markup string for the given input</dd>
  226. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  227. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getCssClass">getCssClass()</a>
  228. <span>
  229. &nbsp;: string </span>
  230. </dt>
  231. <dd>returns a string with all css classes for the current element</dd>
  232. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  233. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  234. <span>
  235. &nbsp;: mixed|null </span>
  236. </dt>
  237. <dd>Returns a default value for either dark or light modules</dd>
  238. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  239. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  240. <span>
  241. &nbsp;: mixed|null </span>
  242. </dt>
  243. <dd>Returns the prepared value for the given $M_TYPE</dd>
  244. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  245. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  246. <span>
  247. &nbsp;: mixed|null </span>
  248. </dt>
  249. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  250. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  251. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_header">header()</a>
  252. <span>
  253. &nbsp;: string </span>
  254. </dt>
  255. <dd>returns the &lt;svg&gt; header with the given options parsed</dd>
  256. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  257. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_module">module()</a>
  258. <span>
  259. &nbsp;: string </span>
  260. </dt>
  261. <dd>returns a path segment for a single module</dd>
  262. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  263. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_path">path()</a>
  264. <span>
  265. &nbsp;: string </span>
  266. </dt>
  267. <dd>renders and returns a single &lt;path&gt; element</dd>
  268. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  269. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_paths">paths()</a>
  270. <span>
  271. &nbsp;: string </span>
  272. </dt>
  273. <dd>returns one or more SVG &lt;path&gt; elements</dd>
  274. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  275. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a>
  276. <span>
  277. &nbsp;: mixed|null </span>
  278. </dt>
  279. <dd>Prepares the value for the given input ()</dd>
  280. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  281. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  282. <span>
  283. &nbsp;: void </span>
  284. </dt>
  285. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  286. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  287. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  288. <span>
  289. &nbsp;: void </span>
  290. </dt>
  291. <dd>Sets/updates the matrix dimensions</dd>
  292. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  293. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  294. <span>
  295. &nbsp;: void </span>
  296. </dt>
  297. <dd>Sets the initial module values</dd>
  298. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  299. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  300. <span>
  301. &nbsp;: string </span>
  302. </dt>
  303. <dd>Returns a base64 data URI for the given string and mime type</dd>
  304. </dl>
  305. <section class="phpdocumentor-properties">
  306. <h3 class="phpdocumentor-elements__header" id="properties">
  307. Properties
  308. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  309. </h3>
  310. <article
  311. class="
  312. phpdocumentor-element
  313. -property
  314. -protected
  315. "
  316. >
  317. <h4 class="phpdocumentor-element__name" id="property_length">
  318. $length
  319. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  320. <span class="phpdocumentor-element__modifiers">
  321. </span>
  322. </h4>
  323. <aside class="phpdocumentor-element-found-in">
  324. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  325. :
  326. <span class="phpdocumentor-element-found-in__line">40</span>
  327. </aside>
  328. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  329. <code class="phpdocumentor-code phpdocumentor-signature ">
  330. <span class="phpdocumentor-signature__visibility">protected</span>
  331. <span class="phpdocumentor-signature__type">int</span>
  332. <span class="phpdocumentor-signature__name">$length</span>
  333. </code>
  334. <section class="phpdocumentor-description"></section>
  335. </article>
  336. <article
  337. class="
  338. phpdocumentor-element
  339. -property
  340. -protected
  341. "
  342. >
  343. <h4 class="phpdocumentor-element__name" id="property_matrix">
  344. $matrix
  345. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  346. <span class="phpdocumentor-element__modifiers">
  347. </span>
  348. </h4>
  349. <aside class="phpdocumentor-element-found-in">
  350. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  351. :
  352. <span class="phpdocumentor-element-found-in__line">50</span>
  353. </aside>
  354. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  355. <code class="phpdocumentor-code phpdocumentor-signature ">
  356. <span class="phpdocumentor-signature__visibility">protected</span>
  357. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  358. <span class="phpdocumentor-signature__name">$matrix</span>
  359. </code>
  360. <section class="phpdocumentor-description"></section>
  361. </article>
  362. <article
  363. class="
  364. phpdocumentor-element
  365. -property
  366. -protected
  367. "
  368. >
  369. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  370. $moduleCount
  371. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  372. <span class="phpdocumentor-element__modifiers">
  373. </span>
  374. </h4>
  375. <aside class="phpdocumentor-element-found-in">
  376. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  377. :
  378. <span class="phpdocumentor-element-found-in__line">28</span>
  379. </aside>
  380. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  381. <code class="phpdocumentor-code phpdocumentor-signature ">
  382. <span class="phpdocumentor-signature__visibility">protected</span>
  383. <span class="phpdocumentor-signature__type">int</span>
  384. <span class="phpdocumentor-signature__name">$moduleCount</span>
  385. </code>
  386. <section class="phpdocumentor-description"></section>
  387. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  388. Tags
  389. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  390. </h5>
  391. <dl class="phpdocumentor-tag-list">
  392. <dt class="phpdocumentor-tag-list__entry">
  393. <span class="phpdocumentor-tag__name">see</span>
  394. </dt>
  395. <dd class="phpdocumentor-tag-list__definition">
  396. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getSize()">QRMatrix::getSize()</abbr></a></span>
  397. </dd>
  398. </dl>
  399. </article>
  400. <article
  401. class="
  402. phpdocumentor-element
  403. -property
  404. -protected
  405. "
  406. >
  407. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  408. $moduleValues
  409. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  410. <span class="phpdocumentor-element__modifiers">
  411. </span>
  412. </h4>
  413. <aside class="phpdocumentor-element-found-in">
  414. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  415. :
  416. <span class="phpdocumentor-element-found-in__line">45</span>
  417. </aside>
  418. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  419. <code class="phpdocumentor-code phpdocumentor-signature ">
  420. <span class="phpdocumentor-signature__visibility">protected</span>
  421. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  422. <span class="phpdocumentor-signature__name">$moduleValues</span>
  423. </code>
  424. <section class="phpdocumentor-description"></section>
  425. </article>
  426. <article
  427. class="
  428. phpdocumentor-element
  429. -property
  430. -protected
  431. "
  432. >
  433. <h4 class="phpdocumentor-element__name" id="property_options">
  434. $options
  435. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  436. <span class="phpdocumentor-element__modifiers">
  437. </span>
  438. </h4>
  439. <aside class="phpdocumentor-element-found-in">
  440. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  441. :
  442. <span class="phpdocumentor-element-found-in__line">55</span>
  443. </aside>
  444. <code class="phpdocumentor-code phpdocumentor-signature ">
  445. <span class="phpdocumentor-signature__visibility">protected</span>
  446. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  447. <span class="phpdocumentor-signature__name">$options</span>
  448. </code>
  449. </article>
  450. <article
  451. class="
  452. phpdocumentor-element
  453. -property
  454. -protected
  455. "
  456. >
  457. <h4 class="phpdocumentor-element__name" id="property_scale">
  458. $scale
  459. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  460. <span class="phpdocumentor-element__modifiers">
  461. </span>
  462. </h4>
  463. <aside class="phpdocumentor-element-found-in">
  464. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  465. :
  466. <span class="phpdocumentor-element-found-in__line">35</span>
  467. </aside>
  468. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  469. <code class="phpdocumentor-code phpdocumentor-signature ">
  470. <span class="phpdocumentor-signature__visibility">protected</span>
  471. <span class="phpdocumentor-signature__type">int</span>
  472. <span class="phpdocumentor-signature__name">$scale</span>
  473. </code>
  474. <section class="phpdocumentor-description"></section>
  475. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  476. Tags
  477. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  478. </h5>
  479. <dl class="phpdocumentor-tag-list">
  480. <dt class="phpdocumentor-tag-list__entry">
  481. <span class="phpdocumentor-tag__name">see</span>
  482. </dt>
  483. <dd class="phpdocumentor-tag-list__definition">
  484. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  485. </dd>
  486. </dl>
  487. </article>
  488. </section>
  489. <section class="phpdocumentor-methods">
  490. <h3 class="phpdocumentor-elements__header" id="methods">
  491. Methods
  492. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  493. </h3>
  494. <article
  495. class="phpdocumentor-element
  496. -method
  497. -public
  498. "
  499. >
  500. <h4 class="phpdocumentor-element__name" id="method___construct">
  501. __construct()
  502. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  503. </h4>
  504. <aside class="phpdocumentor-element-found-in">
  505. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  506. :
  507. <span class="phpdocumentor-element-found-in__line">60</span>
  508. </aside>
  509. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  510. <code class="phpdocumentor-code phpdocumentor-signature ">
  511. <span class="phpdocumentor-signature__visibility">public</span>
  512. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  513. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  514. <dl class="phpdocumentor-argument-list">
  515. <dt class="phpdocumentor-argument-list__entry">
  516. <span class="phpdocumentor-signature__argument__name">$options</span>
  517. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  518. </dt>
  519. <dd class="phpdocumentor-argument-list__definition">
  520. <section class="phpdocumentor-description"></section>
  521. </dd>
  522. <dt class="phpdocumentor-argument-list__entry">
  523. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  524. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  525. </dt>
  526. <dd class="phpdocumentor-argument-list__definition">
  527. <section class="phpdocumentor-description"></section>
  528. </dd>
  529. </dl>
  530. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  531. <span class="phpdocumentor-signature__response_type">mixed</span>
  532. &mdash;
  533. </article>
  534. <article
  535. class="phpdocumentor-element
  536. -method
  537. -public
  538. "
  539. >
  540. <h4 class="phpdocumentor-element__name" id="method_dump">
  541. dump()
  542. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  543. </h4>
  544. <aside class="phpdocumentor-element-found-in">
  545. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkup.php"><a href="files/src-output-qrmarkup.html"><abbr title="src/Output/QRMarkup.php">QRMarkup.php</abbr></a></abbr>
  546. :
  547. <span class="phpdocumentor-element-found-in__line">74</span>
  548. </aside>
  549. <code class="phpdocumentor-code phpdocumentor-signature ">
  550. <span class="phpdocumentor-signature__visibility">public</span>
  551. <span class="phpdocumentor-signature__name">dump</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  552. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  553. <dl class="phpdocumentor-argument-list">
  554. <dt class="phpdocumentor-argument-list__entry">
  555. <span class="phpdocumentor-signature__argument__name">$file</span>
  556. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  557. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  558. <dd class="phpdocumentor-argument-list__definition">
  559. <section class="phpdocumentor-description"></section>
  560. </dd>
  561. </dl>
  562. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  563. Tags
  564. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  565. </h5>
  566. <dl class="phpdocumentor-tag-list">
  567. <dt class="phpdocumentor-tag-list__entry">
  568. <span class="phpdocumentor-tag__name">inheritDoc</span>
  569. </dt>
  570. <dd class="phpdocumentor-tag-list__definition">
  571. </dd>
  572. </dl>
  573. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  574. <span class="phpdocumentor-signature__response_type">string</span>
  575. &mdash;
  576. </article>
  577. <article
  578. class="phpdocumentor-element
  579. -method
  580. -public
  581. -static "
  582. >
  583. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  584. moduleValueIsValid()
  585. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  586. </h4>
  587. <aside class="phpdocumentor-element-found-in">
  588. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupSVG.php"><a href="files/src-output-qrmarkupsvg.html"><abbr title="src/Output/QRMarkupSVG.php">QRMarkupSVG.php</abbr></a></abbr>
  589. :
  590. <span class="phpdocumentor-element-found-in__line">32</span>
  591. </aside>
  592. <p class="phpdocumentor-summary">note: we&#039;re not necessarily validating the several values, just checking the general syntax
  593. note: css4 colors are not included</p>
  594. <code class="phpdocumentor-code phpdocumentor-signature ">
  595. <span class="phpdocumentor-signature__visibility">public</span>
  596. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">moduleValueIsValid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  597. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  598. <dl class="phpdocumentor-argument-list">
  599. <dt class="phpdocumentor-argument-list__entry">
  600. <span class="phpdocumentor-signature__argument__name">$value</span>
  601. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  602. </dt>
  603. <dd class="phpdocumentor-argument-list__definition">
  604. <section class="phpdocumentor-description"></section>
  605. </dd>
  606. </dl>
  607. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  608. Tags
  609. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  610. </h5>
  611. <dl class="phpdocumentor-tag-list">
  612. <dt class="phpdocumentor-tag-list__entry">
  613. <span class="phpdocumentor-tag__name">todo:</span>
  614. </dt>
  615. <dd class="phpdocumentor-tag-list__definition">
  616. <section class="phpdocumentor-description"><p>XSS proof</p>
  617. </section>
  618. </dd>
  619. <dt class="phpdocumentor-tag-list__entry">
  620. <span class="phpdocumentor-tag__name">see</span>
  621. </dt>
  622. <dd class="phpdocumentor-tag-list__definition">
  623. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill</abbr></a></span>
  624. </dd>
  625. <dt class="phpdocumentor-tag-list__entry">
  626. <span class="phpdocumentor-tag__name">inheritDoc</span>
  627. </dt>
  628. <dd class="phpdocumentor-tag-list__definition">
  629. </dd>
  630. </dl>
  631. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  632. <span class="phpdocumentor-signature__response_type">bool</span>
  633. &mdash;
  634. </article>
  635. <article
  636. class="phpdocumentor-element
  637. -method
  638. -protected
  639. "
  640. >
  641. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  642. collectModules()
  643. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  644. </h4>
  645. <aside class="phpdocumentor-element-found-in">
  646. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  647. :
  648. <span class="phpdocumentor-element-found-in__line">176</span>
  649. </aside>
  650. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  651. returns an array with the transformed modules</p>
  652. <code class="phpdocumentor-code phpdocumentor-signature ">
  653. <span class="phpdocumentor-signature__visibility">protected</span>
  654. <span class="phpdocumentor-signature__name">collectModules</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$transform</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  655. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  656. <p>$x - current column
  657. $y - current row
  658. $M_TYPE - field value
  659. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  660. </section>
  661. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  662. <dl class="phpdocumentor-argument-list">
  663. <dt class="phpdocumentor-argument-list__entry">
  664. <span class="phpdocumentor-signature__argument__name">$transform</span>
  665. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  666. </dt>
  667. <dd class="phpdocumentor-argument-list__definition">
  668. <section class="phpdocumentor-description"></section>
  669. </dd>
  670. </dl>
  671. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  672. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  673. &mdash;
  674. </article>
  675. <article
  676. class="phpdocumentor-element
  677. -method
  678. -protected
  679. "
  680. >
  681. <h4 class="phpdocumentor-element__name" id="method_createMarkup">
  682. createMarkup()
  683. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_createMarkup" class="headerlink"><i class="fas fa-link"></i></a>
  684. </h4>
  685. <aside class="phpdocumentor-element-found-in">
  686. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupSVG.php"><a href="files/src-output-qrmarkupsvg.html"><abbr title="src/Output/QRMarkupSVG.php">QRMarkupSVG.php</abbr></a></abbr>
  687. :
  688. <span class="phpdocumentor-element-found-in__line">52</span>
  689. </aside>
  690. <p class="phpdocumentor-summary">returns the fully parsed and rendered markup string for the given input</p>
  691. <code class="phpdocumentor-code phpdocumentor-signature ">
  692. <span class="phpdocumentor-signature__visibility">protected</span>
  693. <span class="phpdocumentor-signature__name">createMarkup</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$saveToFile</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  694. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  695. <dl class="phpdocumentor-argument-list">
  696. <dt class="phpdocumentor-argument-list__entry">
  697. <span class="phpdocumentor-signature__argument__name">$saveToFile</span>
  698. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  699. </dt>
  700. <dd class="phpdocumentor-argument-list__definition">
  701. <section class="phpdocumentor-description"></section>
  702. </dd>
  703. </dl>
  704. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  705. Tags
  706. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  707. </h5>
  708. <dl class="phpdocumentor-tag-list">
  709. <dt class="phpdocumentor-tag-list__entry">
  710. <span class="phpdocumentor-tag__name">inheritDoc</span>
  711. </dt>
  712. <dd class="phpdocumentor-tag-list__definition">
  713. </dd>
  714. </dl>
  715. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  716. <span class="phpdocumentor-signature__response_type">string</span>
  717. &mdash;
  718. </article>
  719. <article
  720. class="phpdocumentor-element
  721. -method
  722. -protected
  723. "
  724. >
  725. <h4 class="phpdocumentor-element__name" id="method_getCssClass">
  726. getCssClass()
  727. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getCssClass" class="headerlink"><i class="fas fa-link"></i></a>
  728. </h4>
  729. <aside class="phpdocumentor-element-found-in">
  730. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupSVG.php"><a href="files/src-output-qrmarkupsvg.html"><abbr title="src/Output/QRMarkupSVG.php">QRMarkupSVG.php</abbr></a></abbr>
  731. :
  732. <span class="phpdocumentor-element-found-in__line">150</span>
  733. </aside>
  734. <p class="phpdocumentor-summary">returns a string with all css classes for the current element</p>
  735. <code class="phpdocumentor-code phpdocumentor-signature ">
  736. <span class="phpdocumentor-signature__visibility">protected</span>
  737. <span class="phpdocumentor-signature__name">getCssClass</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  738. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  739. <dl class="phpdocumentor-argument-list">
  740. <dt class="phpdocumentor-argument-list__entry">
  741. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  742. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  743. </dt>
  744. <dd class="phpdocumentor-argument-list__definition">
  745. <section class="phpdocumentor-description"></section>
  746. </dd>
  747. </dl>
  748. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  749. Tags
  750. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  751. </h5>
  752. <dl class="phpdocumentor-tag-list">
  753. <dt class="phpdocumentor-tag-list__entry">
  754. <span class="phpdocumentor-tag__name">inheritDoc</span>
  755. </dt>
  756. <dd class="phpdocumentor-tag-list__definition">
  757. </dd>
  758. </dl>
  759. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  760. <span class="phpdocumentor-signature__response_type">string</span>
  761. &mdash;
  762. </article>
  763. <article
  764. class="phpdocumentor-element
  765. -method
  766. -protected
  767. -abstract "
  768. >
  769. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  770. getDefaultModuleValue()
  771. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  772. </h4>
  773. <aside class="phpdocumentor-element-found-in">
  774. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  775. :
  776. <span class="phpdocumentor-element-found-in__line">133</span>
  777. </aside>
  778. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
  779. <code class="phpdocumentor-code phpdocumentor-signature ">
  780. <span class="phpdocumentor-signature__visibility">protected</span>
  781. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getDefaultModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$isDark</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  782. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  783. <dl class="phpdocumentor-argument-list">
  784. <dt class="phpdocumentor-argument-list__entry">
  785. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  786. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  787. </dt>
  788. <dd class="phpdocumentor-argument-list__definition">
  789. <section class="phpdocumentor-description"></section>
  790. </dd>
  791. </dl>
  792. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  793. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  794. &mdash;
  795. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  796. </section>
  797. </article>
  798. <article
  799. class="phpdocumentor-element
  800. -method
  801. -protected
  802. "
  803. >
  804. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  805. getModuleValue()
  806. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  807. </h4>
  808. <aside class="phpdocumentor-element-found-in">
  809. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  810. :
  811. <span class="phpdocumentor-element-found-in__line">100</span>
  812. </aside>
  813. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  814. <code class="phpdocumentor-code phpdocumentor-signature ">
  815. <span class="phpdocumentor-signature__visibility">protected</span>
  816. <span class="phpdocumentor-signature__name">getModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  817. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  818. <dl class="phpdocumentor-argument-list">
  819. <dt class="phpdocumentor-argument-list__entry">
  820. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  821. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  822. </dt>
  823. <dd class="phpdocumentor-argument-list__definition">
  824. <section class="phpdocumentor-description"></section>
  825. </dd>
  826. </dl>
  827. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  828. Tags
  829. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  830. </h5>
  831. <dl class="phpdocumentor-tag-list">
  832. <dt class="phpdocumentor-tag-list__entry">
  833. <span class="phpdocumentor-tag__name">throws</span>
  834. </dt>
  835. <dd class="phpdocumentor-tag-list__definition">
  836. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  837. </dd>
  838. </dl>
  839. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  840. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  841. &mdash;
  842. <section class="phpdocumentor-description"><p>return value depends on the output class, null if $moduleValues[$M_TYPE] doesn't exist</p>
  843. </section>
  844. </article>
  845. <article
  846. class="phpdocumentor-element
  847. -method
  848. -protected
  849. "
  850. >
  851. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  852. getModuleValueAt()
  853. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  854. </h4>
  855. <aside class="phpdocumentor-element-found-in">
  856. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  857. :
  858. <span class="phpdocumentor-element-found-in__line">115</span>
  859. </aside>
  860. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  861. <code class="phpdocumentor-code phpdocumentor-signature ">
  862. <span class="phpdocumentor-signature__visibility">protected</span>
  863. <span class="phpdocumentor-signature__name">getModuleValueAt</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  864. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  865. <dl class="phpdocumentor-argument-list">
  866. <dt class="phpdocumentor-argument-list__entry">
  867. <span class="phpdocumentor-signature__argument__name">$x</span>
  868. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  869. </dt>
  870. <dd class="phpdocumentor-argument-list__definition">
  871. <section class="phpdocumentor-description"></section>
  872. </dd>
  873. <dt class="phpdocumentor-argument-list__entry">
  874. <span class="phpdocumentor-signature__argument__name">$y</span>
  875. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  876. </dt>
  877. <dd class="phpdocumentor-argument-list__definition">
  878. <section class="phpdocumentor-description"></section>
  879. </dd>
  880. </dl>
  881. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  882. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  883. &mdash;
  884. </article>
  885. <article
  886. class="phpdocumentor-element
  887. -method
  888. -protected
  889. "
  890. >
  891. <h4 class="phpdocumentor-element__name" id="method_header">
  892. header()
  893. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_header" class="headerlink"><i class="fas fa-link"></i></a>
  894. </h4>
  895. <aside class="phpdocumentor-element-found-in">
  896. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupSVG.php"><a href="files/src-output-qrmarkupsvg.html"><abbr title="src/Output/QRMarkupSVG.php">QRMarkupSVG.php</abbr></a></abbr>
  897. :
  898. <span class="phpdocumentor-element-found-in__line">75</span>
  899. </aside>
  900. <p class="phpdocumentor-summary">returns the &lt;svg&gt; header with the given options parsed</p>
  901. <code class="phpdocumentor-code phpdocumentor-signature ">
  902. <span class="phpdocumentor-signature__visibility">protected</span>
  903. <span class="phpdocumentor-signature__name">header</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  904. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  905. <span class="phpdocumentor-signature__response_type">string</span>
  906. &mdash;
  907. </article>
  908. <article
  909. class="phpdocumentor-element
  910. -method
  911. -protected
  912. "
  913. >
  914. <h4 class="phpdocumentor-element__name" id="method_module">
  915. module()
  916. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  917. </h4>
  918. <aside class="phpdocumentor-element-found-in">
  919. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupSVG.php"><a href="files/src-output-qrmarkupsvg.html"><abbr title="src/Output/QRMarkupSVG.php">QRMarkupSVG.php</abbr></a></abbr>
  920. :
  921. <span class="phpdocumentor-element-found-in__line">163</span>
  922. </aside>
  923. <p class="phpdocumentor-summary">returns a path segment for a single module</p>
  924. <code class="phpdocumentor-code phpdocumentor-signature ">
  925. <span class="phpdocumentor-signature__visibility">protected</span>
  926. <span class="phpdocumentor-signature__name">module</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  927. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  928. <dl class="phpdocumentor-argument-list">
  929. <dt class="phpdocumentor-argument-list__entry">
  930. <span class="phpdocumentor-signature__argument__name">$x</span>
  931. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  932. </dt>
  933. <dd class="phpdocumentor-argument-list__definition">
  934. <section class="phpdocumentor-description"></section>
  935. </dd>
  936. <dt class="phpdocumentor-argument-list__entry">
  937. <span class="phpdocumentor-signature__argument__name">$y</span>
  938. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  939. </dt>
  940. <dd class="phpdocumentor-argument-list__definition">
  941. <section class="phpdocumentor-description"></section>
  942. </dd>
  943. <dt class="phpdocumentor-argument-list__entry">
  944. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  945. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  946. </dt>
  947. <dd class="phpdocumentor-argument-list__definition">
  948. <section class="phpdocumentor-description"></section>
  949. </dd>
  950. </dl>
  951. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  952. Tags
  953. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  954. </h5>
  955. <dl class="phpdocumentor-tag-list">
  956. <dt class="phpdocumentor-tag-list__entry">
  957. <span class="phpdocumentor-tag__name">see</span>
  958. </dt>
  959. <dd class="phpdocumentor-tag-list__definition">
  960. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d</abbr></a></span>
  961. </dd>
  962. </dl>
  963. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  964. <span class="phpdocumentor-signature__response_type">string</span>
  965. &mdash;
  966. </article>
  967. <article
  968. class="phpdocumentor-element
  969. -method
  970. -protected
  971. "
  972. >
  973. <h4 class="phpdocumentor-element__name" id="method_path">
  974. path()
  975. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_path" class="headerlink"><i class="fas fa-link"></i></a>
  976. </h4>
  977. <aside class="phpdocumentor-element-found-in">
  978. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupSVG.php"><a href="files/src-output-qrmarkupsvg.html"><abbr title="src/Output/QRMarkupSVG.php">QRMarkupSVG.php</abbr></a></abbr>
  979. :
  980. <span class="phpdocumentor-element-found-in__line">131</span>
  981. </aside>
  982. <p class="phpdocumentor-summary">renders and returns a single &lt;path&gt; element</p>
  983. <code class="phpdocumentor-code phpdocumentor-signature ">
  984. <span class="phpdocumentor-signature__visibility">protected</span>
  985. <span class="phpdocumentor-signature__name">path</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  986. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  987. <dl class="phpdocumentor-argument-list">
  988. <dt class="phpdocumentor-argument-list__entry">
  989. <span class="phpdocumentor-signature__argument__name">$path</span>
  990. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  991. </dt>
  992. <dd class="phpdocumentor-argument-list__definition">
  993. <section class="phpdocumentor-description"></section>
  994. </dd>
  995. <dt class="phpdocumentor-argument-list__entry">
  996. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  997. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  998. </dt>
  999. <dd class="phpdocumentor-argument-list__definition">
  1000. <section class="phpdocumentor-description"></section>
  1001. </dd>
  1002. </dl>
  1003. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1004. Tags
  1005. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1006. </h5>
  1007. <dl class="phpdocumentor-tag-list">
  1008. <dt class="phpdocumentor-tag-list__entry">
  1009. <span class="phpdocumentor-tag__name">see</span>
  1010. </dt>
  1011. <dd class="phpdocumentor-tag-list__definition">
  1012. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path</abbr></a></span>
  1013. </dd>
  1014. </dl>
  1015. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1016. <span class="phpdocumentor-signature__response_type">string</span>
  1017. &mdash;
  1018. </article>
  1019. <article
  1020. class="phpdocumentor-element
  1021. -method
  1022. -protected
  1023. "
  1024. >
  1025. <h4 class="phpdocumentor-element__name" id="method_paths">
  1026. paths()
  1027. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_paths" class="headerlink"><i class="fas fa-link"></i></a>
  1028. </h4>
  1029. <aside class="phpdocumentor-element-found-in">
  1030. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupSVG.php"><a href="files/src-output-qrmarkupsvg.html"><abbr title="src/Output/QRMarkupSVG.php">QRMarkupSVG.php</abbr></a></abbr>
  1031. :
  1032. <span class="phpdocumentor-element-found-in__line">100</span>
  1033. </aside>
  1034. <p class="phpdocumentor-summary">returns one or more SVG &lt;path&gt; elements</p>
  1035. <code class="phpdocumentor-code phpdocumentor-signature ">
  1036. <span class="phpdocumentor-signature__visibility">protected</span>
  1037. <span class="phpdocumentor-signature__name">paths</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1038. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1039. <span class="phpdocumentor-signature__response_type">string</span>
  1040. &mdash;
  1041. </article>
  1042. <article
  1043. class="phpdocumentor-element
  1044. -method
  1045. -protected
  1046. -abstract "
  1047. >
  1048. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  1049. prepareModuleValue()
  1050. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1051. </h4>
  1052. <aside class="phpdocumentor-element-found-in">
  1053. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1054. :
  1055. <span class="phpdocumentor-element-found-in__line">126</span>
  1056. </aside>
  1057. <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
  1058. <code class="phpdocumentor-code phpdocumentor-signature ">
  1059. <span class="phpdocumentor-signature__visibility">protected</span>
  1060. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">prepareModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  1061. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1062. <dl class="phpdocumentor-argument-list">
  1063. <dt class="phpdocumentor-argument-list__entry">
  1064. <span class="phpdocumentor-signature__argument__name">$value</span>
  1065. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1066. </dt>
  1067. <dd class="phpdocumentor-argument-list__definition">
  1068. </dd>
  1069. </dl>
  1070. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1071. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  1072. &mdash;
  1073. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  1074. </section>
  1075. </article>
  1076. <article
  1077. class="phpdocumentor-element
  1078. -method
  1079. -protected
  1080. "
  1081. >
  1082. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1083. saveToFile()
  1084. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1085. </h4>
  1086. <aside class="phpdocumentor-element-found-in">
  1087. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1088. :
  1089. <span class="phpdocumentor-element-found-in__line">150</span>
  1090. </aside>
  1091. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1092. <code class="phpdocumentor-code phpdocumentor-signature ">
  1093. <span class="phpdocumentor-signature__visibility">protected</span>
  1094. <span class="phpdocumentor-signature__name">saveToFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1095. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1096. <dl class="phpdocumentor-argument-list">
  1097. <dt class="phpdocumentor-argument-list__entry">
  1098. <span class="phpdocumentor-signature__argument__name">$data</span>
  1099. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1100. </dt>
  1101. <dd class="phpdocumentor-argument-list__definition">
  1102. <section class="phpdocumentor-description"></section>
  1103. </dd>
  1104. <dt class="phpdocumentor-argument-list__entry">
  1105. <span class="phpdocumentor-signature__argument__name">$file</span>
  1106. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1107. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1108. <dd class="phpdocumentor-argument-list__definition">
  1109. <section class="phpdocumentor-description"></section>
  1110. </dd>
  1111. </dl>
  1112. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1113. Tags
  1114. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1115. </h5>
  1116. <dl class="phpdocumentor-tag-list">
  1117. <dt class="phpdocumentor-tag-list__entry">
  1118. <span class="phpdocumentor-tag__name">see</span>
  1119. </dt>
  1120. <dd class="phpdocumentor-tag-list__definition">
  1121. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1122. </dd>
  1123. <dt class="phpdocumentor-tag-list__entry">
  1124. <span class="phpdocumentor-tag__name">see</span>
  1125. </dt>
  1126. <dd class="phpdocumentor-tag-list__definition">
  1127. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1128. </dd>
  1129. <dt class="phpdocumentor-tag-list__entry">
  1130. <span class="phpdocumentor-tag__name">throws</span>
  1131. </dt>
  1132. <dd class="phpdocumentor-tag-list__definition">
  1133. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1134. </dd>
  1135. </dl>
  1136. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1137. <span class="phpdocumentor-signature__response_type">void</span>
  1138. &mdash;
  1139. </article>
  1140. <article
  1141. class="phpdocumentor-element
  1142. -method
  1143. -protected
  1144. "
  1145. >
  1146. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1147. setMatrixDimensions()
  1148. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1149. </h4>
  1150. <aside class="phpdocumentor-element-found-in">
  1151. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1152. :
  1153. <span class="phpdocumentor-element-found-in__line">73</span>
  1154. </aside>
  1155. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1156. <code class="phpdocumentor-code phpdocumentor-signature ">
  1157. <span class="phpdocumentor-signature__visibility">protected</span>
  1158. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1159. <section class="phpdocumentor-description"><p>Call this method if you modify the matrix from within your custom module in case the dimensions have been changed</p>
  1160. </section>
  1161. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1162. <span class="phpdocumentor-signature__response_type">void</span>
  1163. &mdash;
  1164. </article>
  1165. <article
  1166. class="phpdocumentor-element
  1167. -method
  1168. -protected
  1169. "
  1170. >
  1171. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1172. setModuleValues()
  1173. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1174. </h4>
  1175. <aside class="phpdocumentor-element-found-in">
  1176. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1177. :
  1178. <span class="phpdocumentor-element-found-in__line">82</span>
  1179. </aside>
  1180. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1181. <code class="phpdocumentor-code phpdocumentor-signature ">
  1182. <span class="phpdocumentor-signature__visibility">protected</span>
  1183. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1184. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1185. <span class="phpdocumentor-signature__response_type">void</span>
  1186. &mdash;
  1187. </article>
  1188. <article
  1189. class="phpdocumentor-element
  1190. -method
  1191. -protected
  1192. "
  1193. >
  1194. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1195. toBase64DataURI()
  1196. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1197. </h4>
  1198. <aside class="phpdocumentor-element-found-in">
  1199. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1200. :
  1201. <span class="phpdocumentor-element-found-in__line">138</span>
  1202. </aside>
  1203. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1204. <code class="phpdocumentor-code phpdocumentor-signature ">
  1205. <span class="phpdocumentor-signature__visibility">protected</span>
  1206. <span class="phpdocumentor-signature__name">toBase64DataURI</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1207. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1208. <dl class="phpdocumentor-argument-list">
  1209. <dt class="phpdocumentor-argument-list__entry">
  1210. <span class="phpdocumentor-signature__argument__name">$data</span>
  1211. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1212. </dt>
  1213. <dd class="phpdocumentor-argument-list__definition">
  1214. <section class="phpdocumentor-description"></section>
  1215. </dd>
  1216. <dt class="phpdocumentor-argument-list__entry">
  1217. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1218. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1219. </dt>
  1220. <dd class="phpdocumentor-argument-list__definition">
  1221. <section class="phpdocumentor-description"></section>
  1222. </dd>
  1223. </dl>
  1224. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1225. <span class="phpdocumentor-signature__response_type">string</span>
  1226. &mdash;
  1227. </article>
  1228. </section>
  1229. <script type="text/javascript">
  1230. function loadExternalCodeSnippets(line) {
  1231. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1232. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  1233. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  1234. var language = 'php';
  1235. var code = document.createElement('code');
  1236. code.className = 'language-' + language;
  1237. pre.textContent = '';
  1238. pre.setAttribute('data-line', line)
  1239. code.textContent = 'Loading…';
  1240. pre.appendChild(code);
  1241. var xhr = new XMLHttpRequest();
  1242. xhr.open('GET', src, true);
  1243. xhr.onreadystatechange = function () {
  1244. if (xhr.readyState == 4) {
  1245. if (xhr.status < 400 && xhr.responseText) {
  1246. code.textContent = xhr.responseText;
  1247. Prism.highlightElement(code);
  1248. }
  1249. else if (xhr.status >= 400) {
  1250. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1251. }
  1252. else {
  1253. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  1254. }
  1255. }
  1256. };
  1257. xhr.send(null);
  1258. });
  1259. }
  1260. var modals = document.querySelectorAll("[data-modal]");
  1261. modals.forEach(function (trigger) {
  1262. trigger.addEventListener("click", function (event) {
  1263. //event.preventDefault();
  1264. const modal = document.getElementById(trigger.dataset.modal);
  1265. modal.classList.add("phpdocumentor-modal__open");
  1266. loadExternalCodeSnippets(trigger.dataset.line)
  1267. const exits = modal.querySelectorAll("[data-exit-button]");
  1268. exits.forEach(function (exit) {
  1269. exit.addEventListener("click", function (event) {
  1270. event.preventDefault();
  1271. modal.classList.remove("phpdocumentor-modal__open");
  1272. });
  1273. });
  1274. });
  1275. });
  1276. </script>
  1277. </article>
  1278. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1279. <section class="phpdocumentor-search-results__dialog">
  1280. <header class="phpdocumentor-search-results__header">
  1281. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1282. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1283. </header>
  1284. <section class="phpdocumentor-search-results__body">
  1285. <ul class="phpdocumentor-search-results__entries"></ul>
  1286. </section>
  1287. </section>
  1288. </section>
  1289. </div>
  1290. </div>
  1291. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1292. </main>
  1293. <script>
  1294. cssVars({});
  1295. </script>
  1296. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1297. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1298. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1299. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1300. </body>
  1301. </html>