chillerlan-QRCode-Output-QRString.html 80 KB

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