chillerlan-QRCode-Output-QRMarkupSVG.html 81 KB

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