chillerlan-QRCode-Output-QROutputAbstract.html 51 KB

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