chillerlan-QRCode-Output-QROutputAbstract.html 54 KB

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