chillerlan-QRCode-Output-QRString.html 53 KB

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