chillerlan-QRCode-Output-QRMarkupHTML.html 58 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. QRMarkupHTML
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Output-QRMarkup.html"><abbr title="\chillerlan\QRCode\Output\QRMarkup">QRMarkup</abbr></a>
  95. </span>
  96. <div class="phpdocumentor-element__package">
  97. in package
  98. <ul class="phpdocumentor-breadcrumbs">
  99. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  100. </ul>
  101. </div>
  102. </h2>
  103. <aside class="phpdocumentor-element-found-in">
  104. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupHTML.php"><a href="files/src-output-qrmarkuphtml.html"><abbr title="src/Output/QRMarkupHTML.php">QRMarkupHTML.php</abbr></a></abbr>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">18</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">HTML output</p>
  109. <h3 id="toc">
  110. Table of Contents
  111. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  112. </h3>
  113. <dl class="phpdocumentor-table-of-contents">
  114. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  115. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  116. <span>
  117. &nbsp;: int </span>
  118. </dt>
  119. <dd>the side length of the QR image (modules * scale)</dd>
  120. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  121. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  122. <span>
  123. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  124. </dt>
  125. <dd>the (filled) data matrix object</dd>
  126. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  127. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  128. <span>
  129. &nbsp;: int </span>
  130. </dt>
  131. <dd>the current size of the QR matrix</dd>
  132. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  133. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  134. <span>
  135. &nbsp;: array&lt;string|int, mixed&gt; </span>
  136. </dt>
  137. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  138. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  139. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  140. <span>
  141. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  142. </dt>
  143. <dd></dd>
  144. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  145. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  146. <span>
  147. &nbsp;: int </span>
  148. </dt>
  149. <dd>the current scaling for a QR pixel</dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  151. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  152. <span>
  153. &nbsp;: mixed </span>
  154. </dt>
  155. <dd>QROutputAbstract constructor.</dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  157. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump">dump()</a>
  158. <span>
  159. &nbsp;: string </span>
  160. </dt>
  161. <dd></dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  163. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  164. <span>
  165. &nbsp;: bool </span>
  166. </dt>
  167. <dd></dd>
  168. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  170. <span>
  171. &nbsp;: array&lt;string|int, mixed&gt; </span>
  172. </dt>
  173. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  174. returns an array with the transformed modules</dd>
  175. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  176. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#method_createMarkup">createMarkup()</a>
  177. <span>
  178. &nbsp;: string </span>
  179. </dt>
  180. <dd></dd>
  181. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  182. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#method_getCssClass">getCssClass()</a>
  183. <span>
  184. &nbsp;: string </span>
  185. </dt>
  186. <dd>returns a string with all css classes for the current element</dd>
  187. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  188. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  189. <span>
  190. &nbsp;: mixed </span>
  191. </dt>
  192. <dd>Returns a default value for either dark or light modules (return value depends on the output module)</dd>
  193. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  194. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  195. <span>
  196. &nbsp;: mixed </span>
  197. </dt>
  198. <dd>Returns the final value for the given input (return value depends on the output module)</dd>
  199. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  200. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  201. <span>
  202. &nbsp;: void </span>
  203. </dt>
  204. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  206. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  207. <span>
  208. &nbsp;: void </span>
  209. </dt>
  210. <dd>Sets/updates the matrix dimensions</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  212. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  213. <span>
  214. &nbsp;: void </span>
  215. </dt>
  216. <dd>Sets the initial module values</dd>
  217. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  218. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  219. <span>
  220. &nbsp;: string </span>
  221. </dt>
  222. <dd>Returns a base64 data URI for the given string and mime type</dd>
  223. </dl>
  224. <section class="phpdocumentor-properties">
  225. <h3 class="phpdocumentor-elements__header" id="properties">
  226. Properties
  227. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  228. </h3>
  229. <article
  230. class="
  231. phpdocumentor-element
  232. -property
  233. -protected
  234. "
  235. >
  236. <h4 class="phpdocumentor-element__name" id="property_length">
  237. $length
  238. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  239. <span class="phpdocumentor-element__modifiers">
  240. </span>
  241. </h4>
  242. <aside class="phpdocumentor-element-found-in">
  243. <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>
  244. :
  245. <span class="phpdocumentor-element-found-in__line">40</span>
  246. </aside>
  247. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  248. <code class="phpdocumentor-code phpdocumentor-signature ">
  249. <span class="phpdocumentor-signature__visibility">protected</span>
  250. <span class="phpdocumentor-signature__type">int</span>
  251. <span class="phpdocumentor-signature__name">$length</span>
  252. </code>
  253. <section class="phpdocumentor-description"></section>
  254. </article>
  255. <article
  256. class="
  257. phpdocumentor-element
  258. -property
  259. -protected
  260. "
  261. >
  262. <h4 class="phpdocumentor-element__name" id="property_matrix">
  263. $matrix
  264. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  265. <span class="phpdocumentor-element__modifiers">
  266. </span>
  267. </h4>
  268. <aside class="phpdocumentor-element-found-in">
  269. <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>
  270. :
  271. <span class="phpdocumentor-element-found-in__line">50</span>
  272. </aside>
  273. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  274. <code class="phpdocumentor-code phpdocumentor-signature ">
  275. <span class="phpdocumentor-signature__visibility">protected</span>
  276. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  277. <span class="phpdocumentor-signature__name">$matrix</span>
  278. </code>
  279. <section class="phpdocumentor-description"></section>
  280. </article>
  281. <article
  282. class="
  283. phpdocumentor-element
  284. -property
  285. -protected
  286. "
  287. >
  288. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  289. $moduleCount
  290. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  291. <span class="phpdocumentor-element__modifiers">
  292. </span>
  293. </h4>
  294. <aside class="phpdocumentor-element-found-in">
  295. <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>
  296. :
  297. <span class="phpdocumentor-element-found-in__line">28</span>
  298. </aside>
  299. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  300. <code class="phpdocumentor-code phpdocumentor-signature ">
  301. <span class="phpdocumentor-signature__visibility">protected</span>
  302. <span class="phpdocumentor-signature__type">int</span>
  303. <span class="phpdocumentor-signature__name">$moduleCount</span>
  304. </code>
  305. <section class="phpdocumentor-description"></section>
  306. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  307. Tags
  308. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  309. </h5>
  310. <dl class="phpdocumentor-tag-list">
  311. <dt class="phpdocumentor-tag-list__entry">
  312. <span class="phpdocumentor-tag__name">see</span>
  313. </dt>
  314. <dd class="phpdocumentor-tag-list__definition">
  315. <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>
  316. </dd>
  317. </dl>
  318. </article>
  319. <article
  320. class="
  321. phpdocumentor-element
  322. -property
  323. -protected
  324. "
  325. >
  326. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  327. $moduleValues
  328. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  329. <span class="phpdocumentor-element__modifiers">
  330. </span>
  331. </h4>
  332. <aside class="phpdocumentor-element-found-in">
  333. <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>
  334. :
  335. <span class="phpdocumentor-element-found-in__line">45</span>
  336. </aside>
  337. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  338. <code class="phpdocumentor-code phpdocumentor-signature ">
  339. <span class="phpdocumentor-signature__visibility">protected</span>
  340. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  341. <span class="phpdocumentor-signature__name">$moduleValues</span>
  342. </code>
  343. <section class="phpdocumentor-description"></section>
  344. </article>
  345. <article
  346. class="
  347. phpdocumentor-element
  348. -property
  349. -protected
  350. "
  351. >
  352. <h4 class="phpdocumentor-element__name" id="property_options">
  353. $options
  354. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  355. <span class="phpdocumentor-element__modifiers">
  356. </span>
  357. </h4>
  358. <aside class="phpdocumentor-element-found-in">
  359. <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>
  360. :
  361. <span class="phpdocumentor-element-found-in__line">55</span>
  362. </aside>
  363. <code class="phpdocumentor-code phpdocumentor-signature ">
  364. <span class="phpdocumentor-signature__visibility">protected</span>
  365. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  366. <span class="phpdocumentor-signature__name">$options</span>
  367. </code>
  368. </article>
  369. <article
  370. class="
  371. phpdocumentor-element
  372. -property
  373. -protected
  374. "
  375. >
  376. <h4 class="phpdocumentor-element__name" id="property_scale">
  377. $scale
  378. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  379. <span class="phpdocumentor-element__modifiers">
  380. </span>
  381. </h4>
  382. <aside class="phpdocumentor-element-found-in">
  383. <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>
  384. :
  385. <span class="phpdocumentor-element-found-in__line">35</span>
  386. </aside>
  387. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  388. <code class="phpdocumentor-code phpdocumentor-signature ">
  389. <span class="phpdocumentor-signature__visibility">protected</span>
  390. <span class="phpdocumentor-signature__type">int</span>
  391. <span class="phpdocumentor-signature__name">$scale</span>
  392. </code>
  393. <section class="phpdocumentor-description"></section>
  394. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  395. Tags
  396. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  397. </h5>
  398. <dl class="phpdocumentor-tag-list">
  399. <dt class="phpdocumentor-tag-list__entry">
  400. <span class="phpdocumentor-tag__name">see</span>
  401. </dt>
  402. <dd class="phpdocumentor-tag-list__definition">
  403. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  404. </dd>
  405. </dl>
  406. </article>
  407. </section>
  408. <section class="phpdocumentor-methods">
  409. <h3 class="phpdocumentor-elements__header" id="methods">
  410. Methods
  411. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  412. </h3>
  413. <article
  414. class="phpdocumentor-element
  415. -method
  416. -public
  417. "
  418. >
  419. <h4 class="phpdocumentor-element__name" id="method___construct">
  420. __construct()
  421. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  422. </h4>
  423. <aside class="phpdocumentor-element-found-in">
  424. <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>
  425. :
  426. <span class="phpdocumentor-element-found-in__line">60</span>
  427. </aside>
  428. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  429. <code class="phpdocumentor-code phpdocumentor-signature ">
  430. <span class="phpdocumentor-signature__visibility">public</span>
  431. <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>
  432. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  433. <dl class="phpdocumentor-argument-list">
  434. <dt class="phpdocumentor-argument-list__entry">
  435. <span class="phpdocumentor-signature__argument__name">$options</span>
  436. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  437. </dt>
  438. <dd class="phpdocumentor-argument-list__definition">
  439. <section class="phpdocumentor-description"></section>
  440. </dd>
  441. <dt class="phpdocumentor-argument-list__entry">
  442. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  443. : <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>
  444. </dt>
  445. <dd class="phpdocumentor-argument-list__definition">
  446. <section class="phpdocumentor-description"></section>
  447. </dd>
  448. </dl>
  449. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  450. <span class="phpdocumentor-signature__response_type">mixed</span>
  451. &mdash;
  452. </article>
  453. <article
  454. class="phpdocumentor-element
  455. -method
  456. -public
  457. "
  458. >
  459. <h4 class="phpdocumentor-element__name" id="method_dump">
  460. dump()
  461. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  462. </h4>
  463. <aside class="phpdocumentor-element-found-in">
  464. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkup.php"><a href="files/src-output-qrmarkup.html"><abbr title="src/Output/QRMarkup.php">QRMarkup.php</abbr></a></abbr>
  465. :
  466. <span class="phpdocumentor-element-found-in__line">44</span>
  467. </aside>
  468. <code class="phpdocumentor-code phpdocumentor-signature ">
  469. <span class="phpdocumentor-signature__visibility">public</span>
  470. <span class="phpdocumentor-signature__name">dump</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  471. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  472. <dl class="phpdocumentor-argument-list">
  473. <dt class="phpdocumentor-argument-list__entry">
  474. <span class="phpdocumentor-signature__argument__name">$file</span>
  475. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  476. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  477. <dd class="phpdocumentor-argument-list__definition">
  478. <section class="phpdocumentor-description"></section>
  479. </dd>
  480. </dl>
  481. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  482. Tags
  483. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  484. </h5>
  485. <dl class="phpdocumentor-tag-list">
  486. <dt class="phpdocumentor-tag-list__entry">
  487. <span class="phpdocumentor-tag__name">inheritDoc</span>
  488. </dt>
  489. <dd class="phpdocumentor-tag-list__definition">
  490. </dd>
  491. </dl>
  492. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  493. <span class="phpdocumentor-signature__response_type">string</span>
  494. &mdash;
  495. </article>
  496. <article
  497. class="phpdocumentor-element
  498. -method
  499. -public
  500. -static "
  501. >
  502. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  503. moduleValueIsValid()
  504. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  505. </h4>
  506. <aside class="phpdocumentor-element-found-in">
  507. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkup.php"><a href="files/src-output-qrmarkup.html"><abbr title="src/Output/QRMarkup.php">QRMarkup.php</abbr></a></abbr>
  508. :
  509. <span class="phpdocumentor-element-found-in__line">23</span>
  510. </aside>
  511. <code class="phpdocumentor-code phpdocumentor-signature ">
  512. <span class="phpdocumentor-signature__visibility">public</span>
  513. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">moduleValueIsValid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  514. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  515. <dl class="phpdocumentor-argument-list">
  516. <dt class="phpdocumentor-argument-list__entry">
  517. <span class="phpdocumentor-signature__argument__name">$value</span>
  518. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  519. </dt>
  520. <dd class="phpdocumentor-argument-list__definition">
  521. <section class="phpdocumentor-description"></section>
  522. </dd>
  523. </dl>
  524. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  525. Tags
  526. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  527. </h5>
  528. <dl class="phpdocumentor-tag-list">
  529. <dt class="phpdocumentor-tag-list__entry">
  530. <span class="phpdocumentor-tag__name">inheritDoc</span>
  531. </dt>
  532. <dd class="phpdocumentor-tag-list__definition">
  533. </dd>
  534. </dl>
  535. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  536. <span class="phpdocumentor-signature__response_type">bool</span>
  537. &mdash;
  538. </article>
  539. <article
  540. class="phpdocumentor-element
  541. -method
  542. -protected
  543. "
  544. >
  545. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  546. collectModules()
  547. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  548. </h4>
  549. <aside class="phpdocumentor-element-found-in">
  550. <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>
  551. :
  552. <span class="phpdocumentor-element-found-in__line">151</span>
  553. </aside>
  554. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  555. returns an array with the transformed modules</p>
  556. <code class="phpdocumentor-code phpdocumentor-signature ">
  557. <span class="phpdocumentor-signature__visibility">protected</span>
  558. <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>
  559. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  560. <p>$x - current column
  561. $y - current row
  562. $M_TYPE - field value
  563. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  564. </section>
  565. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  566. <dl class="phpdocumentor-argument-list">
  567. <dt class="phpdocumentor-argument-list__entry">
  568. <span class="phpdocumentor-signature__argument__name">$transform</span>
  569. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  570. </dt>
  571. <dd class="phpdocumentor-argument-list__definition">
  572. <section class="phpdocumentor-description"></section>
  573. </dd>
  574. </dl>
  575. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  576. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  577. &mdash;
  578. </article>
  579. <article
  580. class="phpdocumentor-element
  581. -method
  582. -protected
  583. "
  584. >
  585. <h4 class="phpdocumentor-element__name" id="method_createMarkup">
  586. createMarkup()
  587. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#method_createMarkup" class="headerlink"><i class="fas fa-link"></i></a>
  588. </h4>
  589. <aside class="phpdocumentor-element-found-in">
  590. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupHTML.php"><a href="files/src-output-qrmarkuphtml.html"><abbr title="src/Output/QRMarkupHTML.php">QRMarkupHTML.php</abbr></a></abbr>
  591. :
  592. <span class="phpdocumentor-element-found-in__line">23</span>
  593. </aside>
  594. <code class="phpdocumentor-code phpdocumentor-signature ">
  595. <span class="phpdocumentor-signature__visibility">protected</span>
  596. <span class="phpdocumentor-signature__name">createMarkup</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$saveToFile</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  597. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  598. <dl class="phpdocumentor-argument-list">
  599. <dt class="phpdocumentor-argument-list__entry">
  600. <span class="phpdocumentor-signature__argument__name">$saveToFile</span>
  601. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  602. </dt>
  603. <dd class="phpdocumentor-argument-list__definition">
  604. <section class="phpdocumentor-description"></section>
  605. </dd>
  606. </dl>
  607. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  608. Tags
  609. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  610. </h5>
  611. <dl class="phpdocumentor-tag-list">
  612. <dt class="phpdocumentor-tag-list__entry">
  613. <span class="phpdocumentor-tag__name">inheritDoc</span>
  614. </dt>
  615. <dd class="phpdocumentor-tag-list__definition">
  616. </dd>
  617. </dl>
  618. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  619. <span class="phpdocumentor-signature__response_type">string</span>
  620. &mdash;
  621. </article>
  622. <article
  623. class="phpdocumentor-element
  624. -method
  625. -protected
  626. "
  627. >
  628. <h4 class="phpdocumentor-element__name" id="method_getCssClass">
  629. getCssClass()
  630. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#method_getCssClass" class="headerlink"><i class="fas fa-link"></i></a>
  631. </h4>
  632. <aside class="phpdocumentor-element-found-in">
  633. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupHTML.php"><a href="files/src-output-qrmarkuphtml.html"><abbr title="src/Output/QRMarkupHTML.php">QRMarkupHTML.php</abbr></a></abbr>
  634. :
  635. <span class="phpdocumentor-element-found-in__line">56</span>
  636. </aside>
  637. <p class="phpdocumentor-summary">returns a string with all css classes for the current element</p>
  638. <code class="phpdocumentor-code phpdocumentor-signature ">
  639. <span class="phpdocumentor-signature__visibility">protected</span>
  640. <span class="phpdocumentor-signature__name">getCssClass</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">string</span></code>
  641. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  642. <dl class="phpdocumentor-argument-list">
  643. <dt class="phpdocumentor-argument-list__entry">
  644. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  645. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  646. </dt>
  647. <dd class="phpdocumentor-argument-list__definition">
  648. <section class="phpdocumentor-description"></section>
  649. </dd>
  650. </dl>
  651. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  652. Tags
  653. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  654. </h5>
  655. <dl class="phpdocumentor-tag-list">
  656. <dt class="phpdocumentor-tag-list__entry">
  657. <span class="phpdocumentor-tag__name">inheritDoc</span>
  658. </dt>
  659. <dd class="phpdocumentor-tag-list__definition">
  660. </dd>
  661. </dl>
  662. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  663. <span class="phpdocumentor-signature__response_type">string</span>
  664. &mdash;
  665. </article>
  666. <article
  667. class="phpdocumentor-element
  668. -method
  669. -protected
  670. -abstract "
  671. >
  672. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  673. getDefaultModuleValue()
  674. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  675. </h4>
  676. <aside class="phpdocumentor-element-found-in">
  677. <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>
  678. :
  679. <span class="phpdocumentor-element-found-in__line">108</span>
  680. </aside>
  681. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output module)</p>
  682. <code class="phpdocumentor-code phpdocumentor-signature ">
  683. <span class="phpdocumentor-signature__visibility">protected</span>
  684. <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>
  685. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  686. <dl class="phpdocumentor-argument-list">
  687. <dt class="phpdocumentor-argument-list__entry">
  688. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  689. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  690. </dt>
  691. <dd class="phpdocumentor-argument-list__definition">
  692. <section class="phpdocumentor-description"></section>
  693. </dd>
  694. </dl>
  695. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  696. <span class="phpdocumentor-signature__response_type">mixed</span>
  697. &mdash;
  698. </article>
  699. <article
  700. class="phpdocumentor-element
  701. -method
  702. -protected
  703. -abstract "
  704. >
  705. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  706. getModuleValue()
  707. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  708. </h4>
  709. <aside class="phpdocumentor-element-found-in">
  710. <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>
  711. :
  712. <span class="phpdocumentor-element-found-in__line">101</span>
  713. </aside>
  714. <p class="phpdocumentor-summary">Returns the final value for the given input (return value depends on the output module)</p>
  715. <code class="phpdocumentor-code phpdocumentor-signature ">
  716. <span class="phpdocumentor-signature__visibility">protected</span>
  717. <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>
  718. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  719. <dl class="phpdocumentor-argument-list">
  720. <dt class="phpdocumentor-argument-list__entry">
  721. <span class="phpdocumentor-signature__argument__name">$value</span>
  722. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  723. </dt>
  724. <dd class="phpdocumentor-argument-list__definition">
  725. </dd>
  726. </dl>
  727. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  728. <span class="phpdocumentor-signature__response_type">mixed</span>
  729. &mdash;
  730. </article>
  731. <article
  732. class="phpdocumentor-element
  733. -method
  734. -protected
  735. "
  736. >
  737. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  738. saveToFile()
  739. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  740. </h4>
  741. <aside class="phpdocumentor-element-found-in">
  742. <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>
  743. :
  744. <span class="phpdocumentor-element-found-in__line">125</span>
  745. </aside>
  746. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  747. <code class="phpdocumentor-code phpdocumentor-signature ">
  748. <span class="phpdocumentor-signature__visibility">protected</span>
  749. <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>
  750. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  751. <dl class="phpdocumentor-argument-list">
  752. <dt class="phpdocumentor-argument-list__entry">
  753. <span class="phpdocumentor-signature__argument__name">$data</span>
  754. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  755. </dt>
  756. <dd class="phpdocumentor-argument-list__definition">
  757. <section class="phpdocumentor-description"></section>
  758. </dd>
  759. <dt class="phpdocumentor-argument-list__entry">
  760. <span class="phpdocumentor-signature__argument__name">$file</span>
  761. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  762. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  763. <dd class="phpdocumentor-argument-list__definition">
  764. <section class="phpdocumentor-description"></section>
  765. </dd>
  766. </dl>
  767. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  768. Tags
  769. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  770. </h5>
  771. <dl class="phpdocumentor-tag-list">
  772. <dt class="phpdocumentor-tag-list__entry">
  773. <span class="phpdocumentor-tag__name">see</span>
  774. </dt>
  775. <dd class="phpdocumentor-tag-list__definition">
  776. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  777. </dd>
  778. <dt class="phpdocumentor-tag-list__entry">
  779. <span class="phpdocumentor-tag__name">see</span>
  780. </dt>
  781. <dd class="phpdocumentor-tag-list__definition">
  782. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  783. </dd>
  784. <dt class="phpdocumentor-tag-list__entry">
  785. <span class="phpdocumentor-tag__name">throws</span>
  786. </dt>
  787. <dd class="phpdocumentor-tag-list__definition">
  788. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  789. </dd>
  790. </dl>
  791. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  792. <span class="phpdocumentor-signature__response_type">void</span>
  793. &mdash;
  794. </article>
  795. <article
  796. class="phpdocumentor-element
  797. -method
  798. -protected
  799. "
  800. >
  801. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  802. setMatrixDimensions()
  803. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  804. </h4>
  805. <aside class="phpdocumentor-element-found-in">
  806. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  807. :
  808. <span class="phpdocumentor-element-found-in__line">73</span>
  809. </aside>
  810. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  811. <code class="phpdocumentor-code phpdocumentor-signature ">
  812. <span class="phpdocumentor-signature__visibility">protected</span>
  813. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  814. <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>
  815. </section>
  816. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  817. <span class="phpdocumentor-signature__response_type">void</span>
  818. &mdash;
  819. </article>
  820. <article
  821. class="phpdocumentor-element
  822. -method
  823. -protected
  824. "
  825. >
  826. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  827. setModuleValues()
  828. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  829. </h4>
  830. <aside class="phpdocumentor-element-found-in">
  831. <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>
  832. :
  833. <span class="phpdocumentor-element-found-in__line">82</span>
  834. </aside>
  835. <p class="phpdocumentor-summary">Sets the initial module values</p>
  836. <code class="phpdocumentor-code phpdocumentor-signature ">
  837. <span class="phpdocumentor-signature__visibility">protected</span>
  838. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  839. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  840. <span class="phpdocumentor-signature__response_type">void</span>
  841. &mdash;
  842. </article>
  843. <article
  844. class="phpdocumentor-element
  845. -method
  846. -protected
  847. "
  848. >
  849. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  850. toBase64DataURI()
  851. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  852. </h4>
  853. <aside class="phpdocumentor-element-found-in">
  854. <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>
  855. :
  856. <span class="phpdocumentor-element-found-in__line">113</span>
  857. </aside>
  858. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  859. <code class="phpdocumentor-code phpdocumentor-signature ">
  860. <span class="phpdocumentor-signature__visibility">protected</span>
  861. <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>
  862. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  863. <dl class="phpdocumentor-argument-list">
  864. <dt class="phpdocumentor-argument-list__entry">
  865. <span class="phpdocumentor-signature__argument__name">$data</span>
  866. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  867. </dt>
  868. <dd class="phpdocumentor-argument-list__definition">
  869. <section class="phpdocumentor-description"></section>
  870. </dd>
  871. <dt class="phpdocumentor-argument-list__entry">
  872. <span class="phpdocumentor-signature__argument__name">$mime</span>
  873. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  874. </dt>
  875. <dd class="phpdocumentor-argument-list__definition">
  876. <section class="phpdocumentor-description"></section>
  877. </dd>
  878. </dl>
  879. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  880. <span class="phpdocumentor-signature__response_type">string</span>
  881. &mdash;
  882. </article>
  883. </section>
  884. <script type="text/javascript">
  885. function loadExternalCodeSnippets(line) {
  886. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  887. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  888. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  889. var language = 'php';
  890. var code = document.createElement('code');
  891. code.className = 'language-' + language;
  892. pre.textContent = '';
  893. pre.setAttribute('data-line', line)
  894. code.textContent = 'Loading…';
  895. pre.appendChild(code);
  896. var xhr = new XMLHttpRequest();
  897. xhr.open('GET', src, true);
  898. xhr.onreadystatechange = function () {
  899. if (xhr.readyState == 4) {
  900. if (xhr.status < 400 && xhr.responseText) {
  901. code.textContent = xhr.responseText;
  902. Prism.highlightElement(code);
  903. }
  904. else if (xhr.status >= 400) {
  905. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  906. }
  907. else {
  908. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  909. }
  910. }
  911. };
  912. xhr.send(null);
  913. });
  914. }
  915. var modals = document.querySelectorAll("[data-modal]");
  916. modals.forEach(function (trigger) {
  917. trigger.addEventListener("click", function (event) {
  918. //event.preventDefault();
  919. const modal = document.getElementById(trigger.dataset.modal);
  920. modal.classList.add("phpdocumentor-modal__open");
  921. loadExternalCodeSnippets(trigger.dataset.line)
  922. const exits = modal.querySelectorAll("[data-exit-button]");
  923. exits.forEach(function (exit) {
  924. exit.addEventListener("click", function (event) {
  925. event.preventDefault();
  926. modal.classList.remove("phpdocumentor-modal__open");
  927. });
  928. });
  929. });
  930. });
  931. </script>
  932. </article>
  933. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  934. <section class="phpdocumentor-search-results__dialog">
  935. <header class="phpdocumentor-search-results__header">
  936. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  937. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  938. </header>
  939. <section class="phpdocumentor-search-results__body">
  940. <ul class="phpdocumentor-search-results__entries"></ul>
  941. </section>
  942. </section>
  943. </section>
  944. </div>
  945. </div>
  946. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  947. </main>
  948. <script>
  949. cssVars({});
  950. </script>
  951. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  952. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  953. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  954. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  955. </body>
  956. </html>