chillerlan-QRCode-Output-QRString.html 54 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156
  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. QRString
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</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/QRString.php"><a href="files/src-output-qrstring.html"><abbr title="src/Output/QRString.php">QRString.php</abbr></a></abbr>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">23</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">Converts the matrix data into string types</p>
  109. <h3 id="toc">
  110. Table of Contents
  111. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  112. </h3>
  113. <dl class="phpdocumentor-table-of-contents">
  114. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  115. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  116. <span>
  117. &nbsp;: int </span>
  118. </dt>
  119. <dd>the side length of the QR image (modules * scale)</dd>
  120. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  121. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  122. <span>
  123. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  124. </dt>
  125. <dd>the (filled) data matrix object</dd>
  126. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  127. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  128. <span>
  129. &nbsp;: int </span>
  130. </dt>
  131. <dd>the current size of the QR matrix</dd>
  132. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  133. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  134. <span>
  135. &nbsp;: array&lt;string|int, mixed&gt; </span>
  136. </dt>
  137. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  138. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  139. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  140. <span>
  141. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  142. </dt>
  143. <dd></dd>
  144. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  145. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  146. <span>
  147. &nbsp;: int </span>
  148. </dt>
  149. <dd>the current scaling for a QR pixel</dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  151. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  152. <span>
  153. &nbsp;: mixed </span>
  154. </dt>
  155. <dd>QROutputAbstract constructor.</dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  157. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_dump">dump()</a>
  158. <span>
  159. &nbsp;: string </span>
  160. </dt>
  161. <dd></dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  163. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode">base64encode()</a>
  164. <span>
  165. &nbsp;: string </span>
  166. </dt>
  167. <dd>Returns a base64 data URI for the given string and mime type</dd>
  168. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  170. <span>
  171. &nbsp;: array&lt;string|int, mixed&gt; </span>
  172. </dt>
  173. <dd>collects the modules per QRMatrix::M_* type and runs a $transform functio on each module and
  174. returns an array with the transformed modules</dd>
  175. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  176. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  177. <span>
  178. &nbsp;: mixed </span>
  179. </dt>
  180. <dd>Returns a defualt value for either dark or light modules (return value depends on the output module)</dd>
  181. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  182. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_getModuleValue">getModuleValue()</a>
  183. <span>
  184. &nbsp;: mixed </span>
  185. </dt>
  186. <dd>Returns the final value for the given input (return value depends on the output module)</dd>
  187. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  188. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_json">json()</a>
  189. <span>
  190. &nbsp;: string </span>
  191. </dt>
  192. <dd>JSON output</dd>
  193. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  194. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  195. <span>
  196. &nbsp;: bool </span>
  197. </dt>
  198. <dd>Determines whether the given value is valid</dd>
  199. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  200. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  201. <span>
  202. &nbsp;: void </span>
  203. </dt>
  204. <dd>saves the qr data to a file</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  206. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  207. <span>
  208. &nbsp;: void </span>
  209. </dt>
  210. <dd>Sets the initial module values</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  212. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_text">text()</a>
  213. <span>
  214. &nbsp;: string </span>
  215. </dt>
  216. <dd>string output</dd>
  217. </dl>
  218. <section class="phpdocumentor-properties">
  219. <h3 class="phpdocumentor-elements__header" id="properties">
  220. Properties
  221. <a href="classes/chillerlan-QRCode-Output-QRString.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  222. </h3>
  223. <article
  224. class="
  225. phpdocumentor-element
  226. -property
  227. -protected
  228. "
  229. >
  230. <h4 class="phpdocumentor-element__name" id="property_length">
  231. $length
  232. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  233. <span class="phpdocumentor-element__modifiers">
  234. </span>
  235. </h4>
  236. <aside class="phpdocumentor-element-found-in">
  237. <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>
  238. :
  239. <span class="phpdocumentor-element-found-in__line">40</span>
  240. </aside>
  241. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  242. <code class="phpdocumentor-code phpdocumentor-signature ">
  243. <span class="phpdocumentor-signature__visibility">protected</span>
  244. <span class="phpdocumentor-signature__type">int</span>
  245. <span class="phpdocumentor-signature__name">$length</span>
  246. </code>
  247. <section class="phpdocumentor-description"></section>
  248. </article>
  249. <article
  250. class="
  251. phpdocumentor-element
  252. -property
  253. -protected
  254. "
  255. >
  256. <h4 class="phpdocumentor-element__name" id="property_matrix">
  257. $matrix
  258. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  259. <span class="phpdocumentor-element__modifiers">
  260. </span>
  261. </h4>
  262. <aside class="phpdocumentor-element-found-in">
  263. <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>
  264. :
  265. <span class="phpdocumentor-element-found-in__line">50</span>
  266. </aside>
  267. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  268. <code class="phpdocumentor-code phpdocumentor-signature ">
  269. <span class="phpdocumentor-signature__visibility">protected</span>
  270. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  271. <span class="phpdocumentor-signature__name">$matrix</span>
  272. </code>
  273. <section class="phpdocumentor-description"></section>
  274. </article>
  275. <article
  276. class="
  277. phpdocumentor-element
  278. -property
  279. -protected
  280. "
  281. >
  282. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  283. $moduleCount
  284. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  285. <span class="phpdocumentor-element__modifiers">
  286. </span>
  287. </h4>
  288. <aside class="phpdocumentor-element-found-in">
  289. <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>
  290. :
  291. <span class="phpdocumentor-element-found-in__line">28</span>
  292. </aside>
  293. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  294. <code class="phpdocumentor-code phpdocumentor-signature ">
  295. <span class="phpdocumentor-signature__visibility">protected</span>
  296. <span class="phpdocumentor-signature__type">int</span>
  297. <span class="phpdocumentor-signature__name">$moduleCount</span>
  298. </code>
  299. <section class="phpdocumentor-description"></section>
  300. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  301. Tags
  302. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  303. </h5>
  304. <dl class="phpdocumentor-tag-list">
  305. <dt class="phpdocumentor-tag-list__entry">
  306. <span class="phpdocumentor-tag__name">see</span>
  307. </dt>
  308. <dd class="phpdocumentor-tag-list__definition">
  309. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size"><abbr title="\chillerlan\QRCode\Data\QRMatrix::size()">QRMatrix::size()</abbr></a></span>
  310. </dd>
  311. </dl>
  312. </article>
  313. <article
  314. class="
  315. phpdocumentor-element
  316. -property
  317. -protected
  318. "
  319. >
  320. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  321. $moduleValues
  322. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  323. <span class="phpdocumentor-element__modifiers">
  324. </span>
  325. </h4>
  326. <aside class="phpdocumentor-element-found-in">
  327. <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>
  328. :
  329. <span class="phpdocumentor-element-found-in__line">45</span>
  330. </aside>
  331. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  332. <code class="phpdocumentor-code phpdocumentor-signature ">
  333. <span class="phpdocumentor-signature__visibility">protected</span>
  334. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  335. <span class="phpdocumentor-signature__name">$moduleValues</span>
  336. </code>
  337. <section class="phpdocumentor-description"></section>
  338. </article>
  339. <article
  340. class="
  341. phpdocumentor-element
  342. -property
  343. -protected
  344. "
  345. >
  346. <h4 class="phpdocumentor-element__name" id="property_options">
  347. $options
  348. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  349. <span class="phpdocumentor-element__modifiers">
  350. </span>
  351. </h4>
  352. <aside class="phpdocumentor-element-found-in">
  353. <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>
  354. :
  355. <span class="phpdocumentor-element-found-in__line">55</span>
  356. </aside>
  357. <code class="phpdocumentor-code phpdocumentor-signature ">
  358. <span class="phpdocumentor-signature__visibility">protected</span>
  359. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  360. <span class="phpdocumentor-signature__name">$options</span>
  361. </code>
  362. </article>
  363. <article
  364. class="
  365. phpdocumentor-element
  366. -property
  367. -protected
  368. "
  369. >
  370. <h4 class="phpdocumentor-element__name" id="property_scale">
  371. $scale
  372. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  373. <span class="phpdocumentor-element__modifiers">
  374. </span>
  375. </h4>
  376. <aside class="phpdocumentor-element-found-in">
  377. <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>
  378. :
  379. <span class="phpdocumentor-element-found-in__line">35</span>
  380. </aside>
  381. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  382. <code class="phpdocumentor-code phpdocumentor-signature ">
  383. <span class="phpdocumentor-signature__visibility">protected</span>
  384. <span class="phpdocumentor-signature__type">int</span>
  385. <span class="phpdocumentor-signature__name">$scale</span>
  386. </code>
  387. <section class="phpdocumentor-description"></section>
  388. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  389. Tags
  390. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  391. </h5>
  392. <dl class="phpdocumentor-tag-list">
  393. <dt class="phpdocumentor-tag-list__entry">
  394. <span class="phpdocumentor-tag__name">see</span>
  395. </dt>
  396. <dd class="phpdocumentor-tag-list__definition">
  397. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  398. </dd>
  399. </dl>
  400. </article>
  401. </section>
  402. <section class="phpdocumentor-methods">
  403. <h3 class="phpdocumentor-elements__header" id="methods">
  404. Methods
  405. <a href="classes/chillerlan-QRCode-Output-QRString.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  406. </h3>
  407. <article
  408. class="phpdocumentor-element
  409. -method
  410. -public
  411. "
  412. >
  413. <h4 class="phpdocumentor-element__name" id="method___construct">
  414. __construct()
  415. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  416. </h4>
  417. <aside class="phpdocumentor-element-found-in">
  418. <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>
  419. :
  420. <span class="phpdocumentor-element-found-in__line">60</span>
  421. </aside>
  422. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  423. <code class="phpdocumentor-code phpdocumentor-signature ">
  424. <span class="phpdocumentor-signature__visibility">public</span>
  425. <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>
  426. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  427. <dl class="phpdocumentor-argument-list">
  428. <dt class="phpdocumentor-argument-list__entry">
  429. <span class="phpdocumentor-signature__argument__name">$options</span>
  430. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  431. </dt>
  432. <dd class="phpdocumentor-argument-list__definition">
  433. <section class="phpdocumentor-description"></section>
  434. </dd>
  435. <dt class="phpdocumentor-argument-list__entry">
  436. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  437. : <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>
  438. </dt>
  439. <dd class="phpdocumentor-argument-list__definition">
  440. <section class="phpdocumentor-description"></section>
  441. </dd>
  442. </dl>
  443. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  444. <span class="phpdocumentor-signature__response_type">mixed</span>
  445. &mdash;
  446. </article>
  447. <article
  448. class="phpdocumentor-element
  449. -method
  450. -public
  451. "
  452. >
  453. <h4 class="phpdocumentor-element__name" id="method_dump">
  454. dump()
  455. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  456. </h4>
  457. <aside class="phpdocumentor-element-found-in">
  458. <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>
  459. :
  460. <span class="phpdocumentor-element-found-in__line">49</span>
  461. </aside>
  462. <code class="phpdocumentor-code phpdocumentor-signature ">
  463. <span class="phpdocumentor-signature__visibility">public</span>
  464. <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>
  465. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  466. <dl class="phpdocumentor-argument-list">
  467. <dt class="phpdocumentor-argument-list__entry">
  468. <span class="phpdocumentor-signature__argument__name">$file</span>
  469. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  470. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  471. <dd class="phpdocumentor-argument-list__definition">
  472. <section class="phpdocumentor-description"></section>
  473. </dd>
  474. </dl>
  475. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  476. Tags
  477. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  478. </h5>
  479. <dl class="phpdocumentor-tag-list">
  480. <dt class="phpdocumentor-tag-list__entry">
  481. <span class="phpdocumentor-tag__name">inheritDoc</span>
  482. </dt>
  483. <dd class="phpdocumentor-tag-list__definition">
  484. </dd>
  485. </dl>
  486. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  487. <span class="phpdocumentor-signature__response_type">string</span>
  488. &mdash;
  489. </article>
  490. <article
  491. class="phpdocumentor-element
  492. -method
  493. -protected
  494. "
  495. >
  496. <h4 class="phpdocumentor-element__name" id="method_base64encode">
  497. base64encode()
  498. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode" class="headerlink"><i class="fas fa-link"></i></a>
  499. </h4>
  500. <aside class="phpdocumentor-element-found-in">
  501. <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>
  502. :
  503. <span class="phpdocumentor-element-found-in__line">111</span>
  504. </aside>
  505. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  506. <code class="phpdocumentor-code phpdocumentor-signature ">
  507. <span class="phpdocumentor-signature__visibility">protected</span>
  508. <span class="phpdocumentor-signature__name">base64encode</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>
  509. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  510. <dl class="phpdocumentor-argument-list">
  511. <dt class="phpdocumentor-argument-list__entry">
  512. <span class="phpdocumentor-signature__argument__name">$data</span>
  513. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  514. </dt>
  515. <dd class="phpdocumentor-argument-list__definition">
  516. <section class="phpdocumentor-description"></section>
  517. </dd>
  518. <dt class="phpdocumentor-argument-list__entry">
  519. <span class="phpdocumentor-signature__argument__name">$mime</span>
  520. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  521. </dt>
  522. <dd class="phpdocumentor-argument-list__definition">
  523. <section class="phpdocumentor-description"></section>
  524. </dd>
  525. </dl>
  526. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  527. <span class="phpdocumentor-signature__response_type">string</span>
  528. &mdash;
  529. </article>
  530. <article
  531. class="phpdocumentor-element
  532. -method
  533. -protected
  534. "
  535. >
  536. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  537. collectModules()
  538. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  539. </h4>
  540. <aside class="phpdocumentor-element-found-in">
  541. <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>
  542. :
  543. <span class="phpdocumentor-element-found-in__line">138</span>
  544. </aside>
  545. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform functio on each module and
  546. returns an array with the transformed modules</p>
  547. <code class="phpdocumentor-code phpdocumentor-signature ">
  548. <span class="phpdocumentor-signature__visibility">protected</span>
  549. <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>
  550. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  551. <dl class="phpdocumentor-argument-list">
  552. <dt class="phpdocumentor-argument-list__entry">
  553. <span class="phpdocumentor-signature__argument__name">$transform</span>
  554. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  555. </dt>
  556. <dd class="phpdocumentor-argument-list__definition">
  557. <section class="phpdocumentor-description"></section>
  558. </dd>
  559. </dl>
  560. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  561. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  562. &mdash;
  563. </article>
  564. <article
  565. class="phpdocumentor-element
  566. -method
  567. -protected
  568. "
  569. >
  570. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  571. getDefaultModuleValue()
  572. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_getDefaultModuleValue" 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">42</span>
  578. </aside>
  579. <p class="phpdocumentor-summary">Returns a defualt value for either dark or light modules (return value depends on the output module)</p>
  580. <code class="phpdocumentor-code phpdocumentor-signature ">
  581. <span class="phpdocumentor-signature__visibility">protected</span>
  582. <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</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">$isDark</span>
  587. : <span class="phpdocumentor-signature__argument__return-type">bool</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">inheritDoc</span>
  600. </dt>
  601. <dd class="phpdocumentor-tag-list__definition">
  602. </dd>
  603. </dl>
  604. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  605. <span class="phpdocumentor-signature__response_type">mixed</span>
  606. &mdash;
  607. </article>
  608. <article
  609. class="phpdocumentor-element
  610. -method
  611. -protected
  612. "
  613. >
  614. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  615. getModuleValue()
  616. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  617. </h4>
  618. <aside class="phpdocumentor-element-found-in">
  619. <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>
  620. :
  621. <span class="phpdocumentor-element-found-in__line">35</span>
  622. </aside>
  623. <p class="phpdocumentor-summary">Returns the final value for the given input (return value depends on the output module)</p>
  624. <code class="phpdocumentor-code phpdocumentor-signature ">
  625. <span class="phpdocumentor-signature__visibility">protected</span>
  626. <span class="phpdocumentor-signature__name">getModuleValue</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</span></code>
  627. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  628. <dl class="phpdocumentor-argument-list">
  629. <dt class="phpdocumentor-argument-list__entry">
  630. <span class="phpdocumentor-signature__argument__name">$value</span>
  631. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  632. </dt>
  633. <dd class="phpdocumentor-argument-list__definition">
  634. </dd>
  635. </dl>
  636. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  637. Tags
  638. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  639. </h5>
  640. <dl class="phpdocumentor-tag-list">
  641. <dt class="phpdocumentor-tag-list__entry">
  642. <span class="phpdocumentor-tag__name">inheritDoc</span>
  643. </dt>
  644. <dd class="phpdocumentor-tag-list__definition">
  645. </dd>
  646. </dl>
  647. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  648. <span class="phpdocumentor-signature__response_type">mixed</span>
  649. &mdash;
  650. </article>
  651. <article
  652. class="phpdocumentor-element
  653. -method
  654. -protected
  655. "
  656. >
  657. <h4 class="phpdocumentor-element__name" id="method_json">
  658. json()
  659. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_json" class="headerlink"><i class="fas fa-link"></i></a>
  660. </h4>
  661. <aside class="phpdocumentor-element-found-in">
  662. <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>
  663. :
  664. <span class="phpdocumentor-element-found-in__line">90</span>
  665. </aside>
  666. <p class="phpdocumentor-summary">JSON output</p>
  667. <code class="phpdocumentor-code phpdocumentor-signature ">
  668. <span class="phpdocumentor-signature__visibility">protected</span>
  669. <span class="phpdocumentor-signature__name">json</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  670. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  671. <span class="phpdocumentor-signature__response_type">string</span>
  672. &mdash;
  673. </article>
  674. <article
  675. class="phpdocumentor-element
  676. -method
  677. -protected
  678. "
  679. >
  680. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  681. moduleValueIsValid()
  682. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  683. </h4>
  684. <aside class="phpdocumentor-element-found-in">
  685. <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>
  686. :
  687. <span class="phpdocumentor-element-found-in__line">28</span>
  688. </aside>
  689. <p class="phpdocumentor-summary">Determines whether the given value is valid</p>
  690. <code class="phpdocumentor-code phpdocumentor-signature ">
  691. <span class="phpdocumentor-signature__visibility">protected</span>
  692. <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>
  693. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  694. <dl class="phpdocumentor-argument-list">
  695. <dt class="phpdocumentor-argument-list__entry">
  696. <span class="phpdocumentor-signature__argument__name">$value</span>
  697. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  698. </dt>
  699. <dd class="phpdocumentor-argument-list__definition">
  700. </dd>
  701. </dl>
  702. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  703. Tags
  704. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  705. </h5>
  706. <dl class="phpdocumentor-tag-list">
  707. <dt class="phpdocumentor-tag-list__entry">
  708. <span class="phpdocumentor-tag__name">inheritDoc</span>
  709. </dt>
  710. <dd class="phpdocumentor-tag-list__definition">
  711. </dd>
  712. </dl>
  713. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  714. <span class="phpdocumentor-signature__response_type">bool</span>
  715. &mdash;
  716. </article>
  717. <article
  718. class="phpdocumentor-element
  719. -method
  720. -protected
  721. "
  722. >
  723. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  724. saveToFile()
  725. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  726. </h4>
  727. <aside class="phpdocumentor-element-found-in">
  728. <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>
  729. :
  730. <span class="phpdocumentor-element-found-in__line">123</span>
  731. </aside>
  732. <p class="phpdocumentor-summary">saves the qr data to a file</p>
  733. <code class="phpdocumentor-code phpdocumentor-signature ">
  734. <span class="phpdocumentor-signature__visibility">protected</span>
  735. <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 class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  736. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  737. <dl class="phpdocumentor-argument-list">
  738. <dt class="phpdocumentor-argument-list__entry">
  739. <span class="phpdocumentor-signature__argument__name">$data</span>
  740. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  741. </dt>
  742. <dd class="phpdocumentor-argument-list__definition">
  743. <section class="phpdocumentor-description"></section>
  744. </dd>
  745. <dt class="phpdocumentor-argument-list__entry">
  746. <span class="phpdocumentor-signature__argument__name">$file</span>
  747. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  748. </dt>
  749. <dd class="phpdocumentor-argument-list__definition">
  750. <section class="phpdocumentor-description"></section>
  751. </dd>
  752. </dl>
  753. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  754. Tags
  755. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  756. </h5>
  757. <dl class="phpdocumentor-tag-list">
  758. <dt class="phpdocumentor-tag-list__entry">
  759. <span class="phpdocumentor-tag__name">see</span>
  760. </dt>
  761. <dd class="phpdocumentor-tag-list__definition">
  762. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  763. </dd>
  764. <dt class="phpdocumentor-tag-list__entry">
  765. <span class="phpdocumentor-tag__name">see</span>
  766. </dt>
  767. <dd class="phpdocumentor-tag-list__definition">
  768. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::cachefile">QROptions::cachefile</abbr></span>
  769. </dd>
  770. <dt class="phpdocumentor-tag-list__entry">
  771. <span class="phpdocumentor-tag__name">throws</span>
  772. </dt>
  773. <dd class="phpdocumentor-tag-list__definition">
  774. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  775. </dd>
  776. </dl>
  777. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  778. <span class="phpdocumentor-signature__response_type">void</span>
  779. &mdash;
  780. </article>
  781. <article
  782. class="phpdocumentor-element
  783. -method
  784. -protected
  785. "
  786. >
  787. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  788. setModuleValues()
  789. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  790. </h4>
  791. <aside class="phpdocumentor-element-found-in">
  792. <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>
  793. :
  794. <span class="phpdocumentor-element-found-in__line">73</span>
  795. </aside>
  796. <p class="phpdocumentor-summary">Sets the initial module values</p>
  797. <code class="phpdocumentor-code phpdocumentor-signature ">
  798. <span class="phpdocumentor-signature__visibility">protected</span>
  799. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  800. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  801. <span class="phpdocumentor-signature__response_type">void</span>
  802. &mdash;
  803. </article>
  804. <article
  805. class="phpdocumentor-element
  806. -method
  807. -protected
  808. "
  809. >
  810. <h4 class="phpdocumentor-element__name" id="method_text">
  811. text()
  812. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_text" class="headerlink"><i class="fas fa-link"></i></a>
  813. </h4>
  814. <aside class="phpdocumentor-element-found-in">
  815. <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>
  816. :
  817. <span class="phpdocumentor-element-found-in__line">71</span>
  818. </aside>
  819. <p class="phpdocumentor-summary">string output</p>
  820. <code class="phpdocumentor-code phpdocumentor-signature ">
  821. <span class="phpdocumentor-signature__visibility">protected</span>
  822. <span class="phpdocumentor-signature__name">text</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  823. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  824. <span class="phpdocumentor-signature__response_type">string</span>
  825. &mdash;
  826. </article>
  827. </section>
  828. <script type="text/javascript">
  829. function loadExternalCodeSnippets(line) {
  830. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  831. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  832. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  833. var language = 'php';
  834. var code = document.createElement('code');
  835. code.className = 'language-' + language;
  836. pre.textContent = '';
  837. pre.setAttribute('data-line', line)
  838. code.textContent = 'Loading…';
  839. pre.appendChild(code);
  840. var xhr = new XMLHttpRequest();
  841. xhr.open('GET', src, true);
  842. xhr.onreadystatechange = function () {
  843. if (xhr.readyState == 4) {
  844. if (xhr.status < 400 && xhr.responseText) {
  845. code.textContent = xhr.responseText;
  846. Prism.highlightElement(code);
  847. }
  848. else if (xhr.status >= 400) {
  849. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  850. }
  851. else {
  852. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  853. }
  854. }
  855. };
  856. xhr.send(null);
  857. });
  858. }
  859. var modals = document.querySelectorAll("[data-modal]");
  860. modals.forEach(function (trigger) {
  861. trigger.addEventListener("click", function (event) {
  862. //event.preventDefault();
  863. const modal = document.getElementById(trigger.dataset.modal);
  864. modal.classList.add("phpdocumentor-modal__open");
  865. loadExternalCodeSnippets(trigger.dataset.line)
  866. const exits = modal.querySelectorAll("[data-exit-button]");
  867. exits.forEach(function (exit) {
  868. exit.addEventListener("click", function (event) {
  869. event.preventDefault();
  870. modal.classList.remove("phpdocumentor-modal__open");
  871. });
  872. });
  873. });
  874. });
  875. </script>
  876. </article>
  877. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  878. <section class="phpdocumentor-search-results__dialog">
  879. <header class="phpdocumentor-search-results__header">
  880. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  881. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  882. </header>
  883. <section class="phpdocumentor-search-results__body">
  884. <ul class="phpdocumentor-search-results__entries"></ul>
  885. </section>
  886. </section>
  887. </section>
  888. </div>
  889. </div>
  890. <a href="classes/chillerlan-QRCode-Output-QRString.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  891. </main>
  892. <script>
  893. cssVars({});
  894. </script>
  895. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  896. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  897. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  898. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  899. </body>
  900. </html>