chillerlan-QRCode-Output-QRFpdf.html 81 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675
  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=Open+Sans:wght@100;200;300;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/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. </ul>
  59. </nav>
  60. </header>
  61. <main class="phpdocumentor">
  62. <div class="phpdocumentor-section">
  63. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  64. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  65. Menu
  66. </label>
  67. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  68. <section class="phpdocumentor-sidebar__category">
  69. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  70. <h4 class="phpdocumentor-sidebar__root-namespace">
  71. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  72. </h4>
  73. <ul class="phpdocumentor-list">
  74. <li>
  75. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  76. </li>
  77. <li>
  78. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  79. </li>
  80. </ul>
  81. </section>
  82. <section class="phpdocumentor-sidebar__category">
  83. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  84. <h4 class="phpdocumentor-sidebar__root-namespace">
  85. <a href="packages/Application.html" class="">Application</a>
  86. </h4>
  87. </section>
  88. <section class="phpdocumentor-sidebar__category">
  89. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  92. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  93. </section>
  94. <section class="phpdocumentor-sidebar__category">
  95. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  96. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  97. </section>
  98. </aside>
  99. <div class="phpdocumentor-column -nine phpdocumentor-content">
  100. <section>
  101. <ul class="phpdocumentor-breadcrumbs">
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  103. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  104. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  105. </ul>
  106. <article class="phpdocumentor-element -class">
  107. <h2 class="phpdocumentor-content__title">
  108. QRFpdf
  109. <span class="phpdocumentor-element__extends">
  110. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  111. </span>
  112. <div class="phpdocumentor-element__package">
  113. in package
  114. <ul class="phpdocumentor-breadcrumbs">
  115. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  116. </ul>
  117. </div>
  118. </h2>
  119. <div class="phpdocumentor-label-line">
  120. </div>
  121. <aside class="phpdocumentor-element-found-in">
  122. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
  123. :
  124. <span class="phpdocumentor-element-found-in__line">26</span>
  125. </aside>
  126. <p class="phpdocumentor-summary">QRFpdf output module (requires fpdf)</p>
  127. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  128. Tags
  129. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  130. </h5>
  131. <dl class="phpdocumentor-tag-list">
  132. <dt class="phpdocumentor-tag-list__entry">
  133. <span class="phpdocumentor-tag__name">see</span>
  134. </dt>
  135. <dd class="phpdocumentor-tag-list__definition">
  136. <span class="phpdocumentor-tag-link"><a href="https://github.com/Setasign/FPDF">https://github.com/Setasign/FPDF</a></span>
  137. </dd>
  138. <dt class="phpdocumentor-tag-list__entry">
  139. <span class="phpdocumentor-tag__name">see</span>
  140. </dt>
  141. <dd class="phpdocumentor-tag-list__definition">
  142. <span class="phpdocumentor-tag-link"><a href="http://www.fpdf.org/">http://www.fpdf.org/</a></span>
  143. </dd>
  144. </dl>
  145. <h3 id="toc">
  146. Table of Contents
  147. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  148. </h3>
  149. <h4 id="toc-properties">
  150. Properties
  151. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  152. </h4>
  153. <dl class="phpdocumentor-table-of-contents">
  154. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  155. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_fpdf">$fpdf</a>
  156. <span>
  157. &nbsp;: <abbr title="\FPDF">FPDF</abbr> </span>
  158. </dt>
  159. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  160. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  161. <span>
  162. &nbsp;: int </span>
  163. </dt>
  164. <dd>the side length of the QR image (modules * scale)</dd>
  165. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  166. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  167. <span>
  168. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  169. </dt>
  170. <dd>the (filled) data matrix object</dd>
  171. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  172. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  173. <span>
  174. &nbsp;: int </span>
  175. </dt>
  176. <dd>the current size of the QR matrix</dd>
  177. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  178. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  179. <span>
  180. &nbsp;: array&lt;string|int, mixed&gt; </span>
  181. </dt>
  182. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  183. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  184. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  185. <span>
  186. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  187. </dt>
  188. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  189. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_prevColor">$prevColor</a>
  190. <span>
  191. &nbsp;: array&lt;string|int, mixed&gt;|null </span>
  192. </dt>
  193. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  194. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  195. <span>
  196. &nbsp;: int </span>
  197. </dt>
  198. <dd>the current scaling for a QR pixel</dd>
  199. </dl>
  200. <h4 id="toc-methods">
  201. Methods
  202. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  203. </h4>
  204. <dl class="phpdocumentor-table-of-contents">
  205. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  206. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct">__construct()</a>
  207. <span>
  208. &nbsp;: mixed </span>
  209. </dt>
  210. <dd>QRFpdf constructor.</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  212. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump">dump()</a>
  213. <span>
  214. &nbsp;: string|<abbr title="\FPDF">FPDF</abbr> </span>
  215. </dt>
  216. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  217. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  218. <span>
  219. &nbsp;: bool </span>
  220. </dt>
  221. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  222. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  223. <span>
  224. &nbsp;: array&lt;string|int, mixed&gt; </span>
  225. </dt>
  226. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  227. returns an array with the transformed modules</dd>
  228. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  229. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  230. <span>
  231. &nbsp;: mixed|null </span>
  232. </dt>
  233. <dd>Returns a default value for either dark or light modules</dd>
  234. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  235. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  236. <span>
  237. &nbsp;: mixed|null </span>
  238. </dt>
  239. <dd>Returns the prepared value for the given $M_TYPE</dd>
  240. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  241. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  242. <span>
  243. &nbsp;: mixed|null </span>
  244. </dt>
  245. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  246. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  247. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a>
  248. <span>
  249. &nbsp;: array&lt;string|int, mixed&gt; </span>
  250. </dt>
  251. <dd>Returns a 2 element array with the current output width and height</dd>
  252. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  253. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_initFPDF">initFPDF()</a>
  254. <span>
  255. &nbsp;: <abbr title="\FPDF">FPDF</abbr> </span>
  256. </dt>
  257. <dd>Initializes an FPDF instance</dd>
  258. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  259. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_module">module()</a>
  260. <span>
  261. &nbsp;: void </span>
  262. </dt>
  263. <dd>Renders a single module</dd>
  264. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  265. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue">prepareModuleValue()</a>
  266. <span>
  267. &nbsp;: mixed|null </span>
  268. </dt>
  269. <dd>Prepares the value for the given input ()</dd>
  270. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  271. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  272. <span>
  273. &nbsp;: void </span>
  274. </dt>
  275. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  276. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  277. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  278. <span>
  279. &nbsp;: void </span>
  280. </dt>
  281. <dd>Sets/updates the matrix dimensions</dd>
  282. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  283. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  284. <span>
  285. &nbsp;: void </span>
  286. </dt>
  287. <dd>Sets the initial module values</dd>
  288. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  289. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  290. <span>
  291. &nbsp;: string </span>
  292. </dt>
  293. <dd>Returns a base64 data URI for the given string and mime type</dd>
  294. </dl>
  295. <section class="phpdocumentor-properties">
  296. <h3 class="phpdocumentor-elements__header" id="properties">
  297. Properties
  298. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  299. </h3>
  300. <article
  301. class="
  302. phpdocumentor-element
  303. -property
  304. -protected
  305. "
  306. >
  307. <h4 class="phpdocumentor-element__name" id="property_fpdf">
  308. $fpdf
  309. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_fpdf" class="headerlink"><i class="fas fa-link"></i></a>
  310. <span class="phpdocumentor-element__modifiers">
  311. </span>
  312. </h4>
  313. <aside class="phpdocumentor-element-found-in">
  314. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
  315. :
  316. <span class="phpdocumentor-element-found-in__line">28</span>
  317. </aside>
  318. <code class="phpdocumentor-code phpdocumentor-signature ">
  319. <span class="phpdocumentor-signature__visibility">protected</span>
  320. <span class="phpdocumentor-signature__type"><abbr title="\FPDF">FPDF</abbr></span>
  321. <span class="phpdocumentor-signature__name">$fpdf</span>
  322. </code>
  323. </article>
  324. <article
  325. class="
  326. phpdocumentor-element
  327. -property
  328. -protected
  329. "
  330. >
  331. <h4 class="phpdocumentor-element__name" id="property_length">
  332. $length
  333. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  334. <span class="phpdocumentor-element__modifiers">
  335. </span>
  336. </h4>
  337. <aside class="phpdocumentor-element-found-in">
  338. <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>
  339. :
  340. <span class="phpdocumentor-element-found-in__line">40</span>
  341. </aside>
  342. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  343. <code class="phpdocumentor-code phpdocumentor-signature ">
  344. <span class="phpdocumentor-signature__visibility">protected</span>
  345. <span class="phpdocumentor-signature__type">int</span>
  346. <span class="phpdocumentor-signature__name">$length</span>
  347. </code>
  348. </article>
  349. <article
  350. class="
  351. phpdocumentor-element
  352. -property
  353. -protected
  354. "
  355. >
  356. <h4 class="phpdocumentor-element__name" id="property_matrix">
  357. $matrix
  358. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  359. <span class="phpdocumentor-element__modifiers">
  360. </span>
  361. </h4>
  362. <aside class="phpdocumentor-element-found-in">
  363. <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>
  364. :
  365. <span class="phpdocumentor-element-found-in__line">50</span>
  366. </aside>
  367. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  368. <code class="phpdocumentor-code phpdocumentor-signature ">
  369. <span class="phpdocumentor-signature__visibility">protected</span>
  370. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  371. <span class="phpdocumentor-signature__name">$matrix</span>
  372. </code>
  373. </article>
  374. <article
  375. class="
  376. phpdocumentor-element
  377. -property
  378. -protected
  379. "
  380. >
  381. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  382. $moduleCount
  383. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  384. <span class="phpdocumentor-element__modifiers">
  385. </span>
  386. </h4>
  387. <aside class="phpdocumentor-element-found-in">
  388. <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>
  389. :
  390. <span class="phpdocumentor-element-found-in__line">28</span>
  391. </aside>
  392. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  393. <code class="phpdocumentor-code phpdocumentor-signature ">
  394. <span class="phpdocumentor-signature__visibility">protected</span>
  395. <span class="phpdocumentor-signature__type">int</span>
  396. <span class="phpdocumentor-signature__name">$moduleCount</span>
  397. </code>
  398. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  399. Tags
  400. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  401. </h5>
  402. <dl class="phpdocumentor-tag-list">
  403. <dt class="phpdocumentor-tag-list__entry">
  404. <span class="phpdocumentor-tag__name">see</span>
  405. </dt>
  406. <dd class="phpdocumentor-tag-list__definition">
  407. <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>
  408. </dd>
  409. </dl>
  410. </article>
  411. <article
  412. class="
  413. phpdocumentor-element
  414. -property
  415. -protected
  416. "
  417. >
  418. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  419. $moduleValues
  420. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  421. <span class="phpdocumentor-element__modifiers">
  422. </span>
  423. </h4>
  424. <aside class="phpdocumentor-element-found-in">
  425. <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>
  426. :
  427. <span class="phpdocumentor-element-found-in__line">45</span>
  428. </aside>
  429. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  430. <code class="phpdocumentor-code phpdocumentor-signature ">
  431. <span class="phpdocumentor-signature__visibility">protected</span>
  432. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  433. <span class="phpdocumentor-signature__name">$moduleValues</span>
  434. </code>
  435. </article>
  436. <article
  437. class="
  438. phpdocumentor-element
  439. -property
  440. -protected
  441. "
  442. >
  443. <h4 class="phpdocumentor-element__name" id="property_options">
  444. $options
  445. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  446. <span class="phpdocumentor-element__modifiers">
  447. </span>
  448. </h4>
  449. <aside class="phpdocumentor-element-found-in">
  450. <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>
  451. :
  452. <span class="phpdocumentor-element-found-in__line">55</span>
  453. </aside>
  454. <code class="phpdocumentor-code phpdocumentor-signature ">
  455. <span class="phpdocumentor-signature__visibility">protected</span>
  456. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  457. <span class="phpdocumentor-signature__name">$options</span>
  458. </code>
  459. </article>
  460. <article
  461. class="
  462. phpdocumentor-element
  463. -property
  464. -protected
  465. "
  466. >
  467. <h4 class="phpdocumentor-element__name" id="property_prevColor">
  468. $prevColor
  469. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_prevColor" class="headerlink"><i class="fas fa-link"></i></a>
  470. <span class="phpdocumentor-element__modifiers">
  471. </span>
  472. </h4>
  473. <aside class="phpdocumentor-element-found-in">
  474. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
  475. :
  476. <span class="phpdocumentor-element-found-in__line">29</span>
  477. </aside>
  478. <code class="phpdocumentor-code phpdocumentor-signature ">
  479. <span class="phpdocumentor-signature__visibility">protected</span>
  480. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;|null</span>
  481. <span class="phpdocumentor-signature__name">$prevColor</span>
  482. = <span class="phpdocumentor-signature__default-value">null</span></code>
  483. </article>
  484. <article
  485. class="
  486. phpdocumentor-element
  487. -property
  488. -protected
  489. "
  490. >
  491. <h4 class="phpdocumentor-element__name" id="property_scale">
  492. $scale
  493. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  494. <span class="phpdocumentor-element__modifiers">
  495. </span>
  496. </h4>
  497. <aside class="phpdocumentor-element-found-in">
  498. <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>
  499. :
  500. <span class="phpdocumentor-element-found-in__line">35</span>
  501. </aside>
  502. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  503. <code class="phpdocumentor-code phpdocumentor-signature ">
  504. <span class="phpdocumentor-signature__visibility">protected</span>
  505. <span class="phpdocumentor-signature__type">int</span>
  506. <span class="phpdocumentor-signature__name">$scale</span>
  507. </code>
  508. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  509. Tags
  510. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  511. </h5>
  512. <dl class="phpdocumentor-tag-list">
  513. <dt class="phpdocumentor-tag-list__entry">
  514. <span class="phpdocumentor-tag__name">see</span>
  515. </dt>
  516. <dd class="phpdocumentor-tag-list__definition">
  517. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  518. </dd>
  519. </dl>
  520. </article>
  521. </section>
  522. <section class="phpdocumentor-methods">
  523. <h3 class="phpdocumentor-elements__header" id="methods">
  524. Methods
  525. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  526. </h3>
  527. <article
  528. class="phpdocumentor-element
  529. -method
  530. -public
  531. "
  532. >
  533. <h4 class="phpdocumentor-element__name" id="method___construct">
  534. __construct()
  535. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  536. </h4>
  537. <aside class="phpdocumentor-element-found-in">
  538. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
  539. :
  540. <span class="phpdocumentor-element-found-in__line">36</span>
  541. </aside>
  542. <p class="phpdocumentor-summary">QRFpdf constructor.</p>
  543. <code class="phpdocumentor-code phpdocumentor-signature ">
  544. <span class="phpdocumentor-signature__visibility">public</span>
  545. <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>
  546. <div class="phpdocumentor-label-line">
  547. </div>
  548. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  549. <dl class="phpdocumentor-argument-list">
  550. <dt class="phpdocumentor-argument-list__entry">
  551. <span class="phpdocumentor-signature__argument__name">$options</span>
  552. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  553. </dt>
  554. <dd class="phpdocumentor-argument-list__definition">
  555. </dd>
  556. <dt class="phpdocumentor-argument-list__entry">
  557. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  558. : <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>
  559. </dt>
  560. <dd class="phpdocumentor-argument-list__definition">
  561. </dd>
  562. </dl>
  563. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  564. Tags
  565. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
  566. </h5>
  567. <dl class="phpdocumentor-tag-list">
  568. <dt class="phpdocumentor-tag-list__entry">
  569. <span class="phpdocumentor-tag__name">throws</span>
  570. </dt>
  571. <dd class="phpdocumentor-tag-list__definition">
  572. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  573. </dd>
  574. </dl>
  575. </article>
  576. <article
  577. class="phpdocumentor-element
  578. -method
  579. -public
  580. "
  581. >
  582. <h4 class="phpdocumentor-element__name" id="method_dump">
  583. dump()
  584. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  585. </h4>
  586. <aside class="phpdocumentor-element-found-in">
  587. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
  588. :
  589. <span class="phpdocumentor-element-found-in__line">119</span>
  590. </aside>
  591. <code class="phpdocumentor-code phpdocumentor-signature ">
  592. <span class="phpdocumentor-signature__visibility">public</span>
  593. <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|<abbr title="\FPDF">FPDF</abbr></span></code>
  594. <div class="phpdocumentor-label-line">
  595. </div>
  596. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  597. <dl class="phpdocumentor-argument-list">
  598. <dt class="phpdocumentor-argument-list__entry">
  599. <span class="phpdocumentor-signature__argument__name">$file</span>
  600. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  601. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  602. <dd class="phpdocumentor-argument-list__definition">
  603. </dd>
  604. </dl>
  605. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  606. Tags
  607. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  608. </h5>
  609. <dl class="phpdocumentor-tag-list">
  610. <dt class="phpdocumentor-tag-list__entry">
  611. <span class="phpdocumentor-tag__name">inheritDoc</span>
  612. </dt>
  613. <dd class="phpdocumentor-tag-list__definition">
  614. </dd>
  615. </dl>
  616. <section>
  617. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  618. <span class="phpdocumentor-signature__response_type">string|<abbr title="\FPDF">FPDF</abbr></span>
  619. </section>
  620. </article>
  621. <article
  622. class="phpdocumentor-element
  623. -method
  624. -public
  625. -static "
  626. >
  627. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  628. moduleValueIsValid()
  629. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  630. </h4>
  631. <aside class="phpdocumentor-element-found-in">
  632. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
  633. :
  634. <span class="phpdocumentor-element-found-in__line">53</span>
  635. </aside>
  636. <code class="phpdocumentor-code phpdocumentor-signature ">
  637. <span class="phpdocumentor-signature__visibility">public</span>
  638. <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>
  639. <div class="phpdocumentor-label-line">
  640. </div>
  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">$value</span>
  645. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  646. </dt>
  647. <dd class="phpdocumentor-argument-list__definition">
  648. </dd>
  649. </dl>
  650. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  651. Tags
  652. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid#tags" class="headerlink"><i class="fas fa-link"></i></a>
  653. </h5>
  654. <dl class="phpdocumentor-tag-list">
  655. <dt class="phpdocumentor-tag-list__entry">
  656. <span class="phpdocumentor-tag__name">inheritDoc</span>
  657. </dt>
  658. <dd class="phpdocumentor-tag-list__definition">
  659. </dd>
  660. </dl>
  661. <section>
  662. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  663. <span class="phpdocumentor-signature__response_type">bool</span>
  664. </section>
  665. </article>
  666. <article
  667. class="phpdocumentor-element
  668. -method
  669. -protected
  670. "
  671. >
  672. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  673. collectModules()
  674. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" 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">189</span>
  680. </aside>
  681. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  682. returns an array with the transformed modules</p>
  683. <code class="phpdocumentor-code phpdocumentor-signature ">
  684. <span class="phpdocumentor-signature__visibility">protected</span>
  685. <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>
  686. <div class="phpdocumentor-label-line">
  687. </div>
  688. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  689. <p>$x - current column
  690. $y - current row
  691. $M_TYPE - field value
  692. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  693. </section>
  694. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  695. <dl class="phpdocumentor-argument-list">
  696. <dt class="phpdocumentor-argument-list__entry">
  697. <span class="phpdocumentor-signature__argument__name">$transform</span>
  698. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  699. </dt>
  700. <dd class="phpdocumentor-argument-list__definition">
  701. </dd>
  702. </dl>
  703. <section>
  704. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  705. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  706. </section>
  707. </article>
  708. <article
  709. class="phpdocumentor-element
  710. -method
  711. -protected
  712. "
  713. >
  714. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  715. getDefaultModuleValue()
  716. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  717. </h4>
  718. <aside class="phpdocumentor-element-found-in">
  719. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
  720. :
  721. <span class="phpdocumentor-element-found-in__line">103</span>
  722. </aside>
  723. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
  724. <code class="phpdocumentor-code phpdocumentor-signature ">
  725. <span class="phpdocumentor-signature__visibility">protected</span>
  726. <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>
  727. <div class="phpdocumentor-label-line">
  728. </div>
  729. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  730. <dl class="phpdocumentor-argument-list">
  731. <dt class="phpdocumentor-argument-list__entry">
  732. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  733. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  734. </dt>
  735. <dd class="phpdocumentor-argument-list__definition">
  736. </dd>
  737. </dl>
  738. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  739. Tags
  740. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  741. </h5>
  742. <dl class="phpdocumentor-tag-list">
  743. <dt class="phpdocumentor-tag-list__entry">
  744. <span class="phpdocumentor-tag__name">inheritDoc</span>
  745. </dt>
  746. <dd class="phpdocumentor-tag-list__definition">
  747. </dd>
  748. </dl>
  749. <section>
  750. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  751. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  752. &mdash;
  753. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  754. </section>
  755. </section>
  756. </article>
  757. <article
  758. class="phpdocumentor-element
  759. -method
  760. -protected
  761. "
  762. >
  763. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  764. getModuleValue()
  765. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  766. </h4>
  767. <aside class="phpdocumentor-element-found-in">
  768. <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>
  769. :
  770. <span class="phpdocumentor-element-found-in__line">113</span>
  771. </aside>
  772. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  773. <code class="phpdocumentor-code phpdocumentor-signature ">
  774. <span class="phpdocumentor-signature__visibility">protected</span>
  775. <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>
  776. <div class="phpdocumentor-label-line">
  777. </div>
  778. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  779. <dl class="phpdocumentor-argument-list">
  780. <dt class="phpdocumentor-argument-list__entry">
  781. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  782. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  783. </dt>
  784. <dd class="phpdocumentor-argument-list__definition">
  785. </dd>
  786. </dl>
  787. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  788. Tags
  789. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  790. </h5>
  791. <dl class="phpdocumentor-tag-list">
  792. <dt class="phpdocumentor-tag-list__entry">
  793. <span class="phpdocumentor-tag__name">throws</span>
  794. </dt>
  795. <dd class="phpdocumentor-tag-list__definition">
  796. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  797. </dd>
  798. </dl>
  799. <section>
  800. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  801. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  802. &mdash;
  803. <section class="phpdocumentor-description"><p>return value depends on the output class, null if $moduleValues[$M_TYPE] doesn't exist</p>
  804. </section>
  805. </section>
  806. </article>
  807. <article
  808. class="phpdocumentor-element
  809. -method
  810. -protected
  811. "
  812. >
  813. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  814. getModuleValueAt()
  815. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  816. </h4>
  817. <aside class="phpdocumentor-element-found-in">
  818. <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>
  819. :
  820. <span class="phpdocumentor-element-found-in__line">128</span>
  821. </aside>
  822. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  823. <code class="phpdocumentor-code phpdocumentor-signature ">
  824. <span class="phpdocumentor-signature__visibility">protected</span>
  825. <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>
  826. <div class="phpdocumentor-label-line">
  827. </div>
  828. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  829. <dl class="phpdocumentor-argument-list">
  830. <dt class="phpdocumentor-argument-list__entry">
  831. <span class="phpdocumentor-signature__argument__name">$x</span>
  832. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  833. </dt>
  834. <dd class="phpdocumentor-argument-list__definition">
  835. </dd>
  836. <dt class="phpdocumentor-argument-list__entry">
  837. <span class="phpdocumentor-signature__argument__name">$y</span>
  838. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  839. </dt>
  840. <dd class="phpdocumentor-argument-list__definition">
  841. </dd>
  842. </dl>
  843. <section>
  844. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  845. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  846. </section>
  847. </article>
  848. <article
  849. class="phpdocumentor-element
  850. -method
  851. -protected
  852. "
  853. >
  854. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  855. getOutputDimensions()
  856. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  857. </h4>
  858. <aside class="phpdocumentor-element-found-in">
  859. <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>
  860. :
  861. <span class="phpdocumentor-element-found-in__line">88</span>
  862. </aside>
  863. <p class="phpdocumentor-summary">Returns a 2 element array with the current output width and height</p>
  864. <code class="phpdocumentor-code phpdocumentor-signature ">
  865. <span class="phpdocumentor-signature__visibility">protected</span>
  866. <span class="phpdocumentor-signature__name">getOutputDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  867. <div class="phpdocumentor-label-line">
  868. </div>
  869. <section class="phpdocumentor-description"><p>The type and units of the values depend on the output class. The default value is the current module count * scale.</p>
  870. </section>
  871. <section>
  872. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  873. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  874. </section>
  875. </article>
  876. <article
  877. class="phpdocumentor-element
  878. -method
  879. -protected
  880. "
  881. >
  882. <h4 class="phpdocumentor-element__name" id="method_initFPDF">
  883. initFPDF()
  884. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_initFPDF" class="headerlink"><i class="fas fa-link"></i></a>
  885. </h4>
  886. <aside class="phpdocumentor-element-found-in">
  887. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
  888. :
  889. <span class="phpdocumentor-element-found-in__line">110</span>
  890. </aside>
  891. <p class="phpdocumentor-summary">Initializes an FPDF instance</p>
  892. <code class="phpdocumentor-code phpdocumentor-signature ">
  893. <span class="phpdocumentor-signature__visibility">protected</span>
  894. <span class="phpdocumentor-signature__name">initFPDF</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\FPDF">FPDF</abbr></span></code>
  895. <div class="phpdocumentor-label-line">
  896. </div>
  897. <section>
  898. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  899. <span class="phpdocumentor-signature__response_type"><abbr title="\FPDF">FPDF</abbr></span>
  900. </section>
  901. </article>
  902. <article
  903. class="phpdocumentor-element
  904. -method
  905. -protected
  906. "
  907. >
  908. <h4 class="phpdocumentor-element__name" id="method_module">
  909. module()
  910. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  911. </h4>
  912. <aside class="phpdocumentor-element-found-in">
  913. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
  914. :
  915. <span class="phpdocumentor-element-found-in__line">158</span>
  916. </aside>
  917. <p class="phpdocumentor-summary">Renders a single module</p>
  918. <code class="phpdocumentor-code phpdocumentor-signature ">
  919. <span class="phpdocumentor-signature__visibility">protected</span>
  920. <span class="phpdocumentor-signature__name">module</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 class="phpdocumentor-signature__argument"><span>, </span><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">void</span></code>
  921. <div class="phpdocumentor-label-line">
  922. </div>
  923. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  924. <dl class="phpdocumentor-argument-list">
  925. <dt class="phpdocumentor-argument-list__entry">
  926. <span class="phpdocumentor-signature__argument__name">$x</span>
  927. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  928. </dt>
  929. <dd class="phpdocumentor-argument-list__definition">
  930. </dd>
  931. <dt class="phpdocumentor-argument-list__entry">
  932. <span class="phpdocumentor-signature__argument__name">$y</span>
  933. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  934. </dt>
  935. <dd class="phpdocumentor-argument-list__definition">
  936. </dd>
  937. <dt class="phpdocumentor-argument-list__entry">
  938. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  939. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  940. </dt>
  941. <dd class="phpdocumentor-argument-list__definition">
  942. </dd>
  943. </dl>
  944. </article>
  945. <article
  946. class="phpdocumentor-element
  947. -method
  948. -protected
  949. "
  950. >
  951. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  952. prepareModuleValue()
  953. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  954. </h4>
  955. <aside class="phpdocumentor-element-found-in">
  956. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
  957. :
  958. <span class="phpdocumentor-element-found-in__line">81</span>
  959. </aside>
  960. <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
  961. <code class="phpdocumentor-code phpdocumentor-signature ">
  962. <span class="phpdocumentor-signature__visibility">protected</span>
  963. <span class="phpdocumentor-signature__name">prepareModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&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>
  964. <div class="phpdocumentor-label-line">
  965. </div>
  966. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  967. <dl class="phpdocumentor-argument-list">
  968. <dt class="phpdocumentor-argument-list__entry">
  969. <span class="phpdocumentor-signature__argument__name">$value</span>
  970. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  971. </dt>
  972. <dd class="phpdocumentor-argument-list__definition">
  973. </dd>
  974. </dl>
  975. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  976. Tags
  977. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  978. </h5>
  979. <dl class="phpdocumentor-tag-list">
  980. <dt class="phpdocumentor-tag-list__entry">
  981. <span class="phpdocumentor-tag__name">inheritDoc</span>
  982. </dt>
  983. <dd class="phpdocumentor-tag-list__definition">
  984. </dd>
  985. <dt class="phpdocumentor-tag-list__entry">
  986. <span class="phpdocumentor-tag__name">throws</span>
  987. </dt>
  988. <dd class="phpdocumentor-tag-list__definition">
  989. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  990. </dd>
  991. </dl>
  992. <section>
  993. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  994. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  995. &mdash;
  996. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  997. </section>
  998. </section>
  999. </article>
  1000. <article
  1001. class="phpdocumentor-element
  1002. -method
  1003. -protected
  1004. "
  1005. >
  1006. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1007. saveToFile()
  1008. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1009. </h4>
  1010. <aside class="phpdocumentor-element-found-in">
  1011. <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>
  1012. :
  1013. <span class="phpdocumentor-element-found-in__line">163</span>
  1014. </aside>
  1015. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1016. <code class="phpdocumentor-code phpdocumentor-signature ">
  1017. <span class="phpdocumentor-signature__visibility">protected</span>
  1018. <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>
  1019. <div class="phpdocumentor-label-line">
  1020. </div>
  1021. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1022. <dl class="phpdocumentor-argument-list">
  1023. <dt class="phpdocumentor-argument-list__entry">
  1024. <span class="phpdocumentor-signature__argument__name">$data</span>
  1025. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1026. </dt>
  1027. <dd class="phpdocumentor-argument-list__definition">
  1028. </dd>
  1029. <dt class="phpdocumentor-argument-list__entry">
  1030. <span class="phpdocumentor-signature__argument__name">$file</span>
  1031. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1032. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1033. <dd class="phpdocumentor-argument-list__definition">
  1034. </dd>
  1035. </dl>
  1036. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1037. Tags
  1038. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1039. </h5>
  1040. <dl class="phpdocumentor-tag-list">
  1041. <dt class="phpdocumentor-tag-list__entry">
  1042. <span class="phpdocumentor-tag__name">see</span>
  1043. </dt>
  1044. <dd class="phpdocumentor-tag-list__definition">
  1045. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1046. </dd>
  1047. <dt class="phpdocumentor-tag-list__entry">
  1048. <span class="phpdocumentor-tag__name">see</span>
  1049. </dt>
  1050. <dd class="phpdocumentor-tag-list__definition">
  1051. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1052. </dd>
  1053. <dt class="phpdocumentor-tag-list__entry">
  1054. <span class="phpdocumentor-tag__name">throws</span>
  1055. </dt>
  1056. <dd class="phpdocumentor-tag-list__definition">
  1057. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1058. </dd>
  1059. </dl>
  1060. </article>
  1061. <article
  1062. class="phpdocumentor-element
  1063. -method
  1064. -protected
  1065. "
  1066. >
  1067. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1068. setMatrixDimensions()
  1069. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1070. </h4>
  1071. <aside class="phpdocumentor-element-found-in">
  1072. <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>
  1073. :
  1074. <span class="phpdocumentor-element-found-in__line">77</span>
  1075. </aside>
  1076. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1077. <code class="phpdocumentor-code phpdocumentor-signature ">
  1078. <span class="phpdocumentor-signature__visibility">protected</span>
  1079. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1080. <div class="phpdocumentor-label-line">
  1081. </div>
  1082. <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>
  1083. </section>
  1084. </article>
  1085. <article
  1086. class="phpdocumentor-element
  1087. -method
  1088. -protected
  1089. "
  1090. >
  1091. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1092. setModuleValues()
  1093. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1094. </h4>
  1095. <aside class="phpdocumentor-element-found-in">
  1096. <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>
  1097. :
  1098. <span class="phpdocumentor-element-found-in__line">95</span>
  1099. </aside>
  1100. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1101. <code class="phpdocumentor-code phpdocumentor-signature ">
  1102. <span class="phpdocumentor-signature__visibility">protected</span>
  1103. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1104. <div class="phpdocumentor-label-line">
  1105. </div>
  1106. </article>
  1107. <article
  1108. class="phpdocumentor-element
  1109. -method
  1110. -protected
  1111. "
  1112. >
  1113. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1114. toBase64DataURI()
  1115. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1116. </h4>
  1117. <aside class="phpdocumentor-element-found-in">
  1118. <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>
  1119. :
  1120. <span class="phpdocumentor-element-found-in__line">151</span>
  1121. </aside>
  1122. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1123. <code class="phpdocumentor-code phpdocumentor-signature ">
  1124. <span class="phpdocumentor-signature__visibility">protected</span>
  1125. <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>
  1126. <div class="phpdocumentor-label-line">
  1127. </div>
  1128. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1129. <dl class="phpdocumentor-argument-list">
  1130. <dt class="phpdocumentor-argument-list__entry">
  1131. <span class="phpdocumentor-signature__argument__name">$data</span>
  1132. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1133. </dt>
  1134. <dd class="phpdocumentor-argument-list__definition">
  1135. </dd>
  1136. <dt class="phpdocumentor-argument-list__entry">
  1137. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1138. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1139. </dt>
  1140. <dd class="phpdocumentor-argument-list__definition">
  1141. </dd>
  1142. </dl>
  1143. <section>
  1144. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1145. <span class="phpdocumentor-signature__response_type">string</span>
  1146. </section>
  1147. </article>
  1148. </section>
  1149. <div class="phpdocumentor-modal" id="source-view">
  1150. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1151. <div class="phpdocumentor-modal-container">
  1152. <div class="phpdocumentor-modal-content">
  1153. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Output/QRFpdf.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  1154. </div>
  1155. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1156. </div>
  1157. </div>
  1158. <script type="text/javascript">
  1159. (function () {
  1160. function loadExternalCodeSnippet(el, url, line) {
  1161. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1162. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1163. const language = 'php';
  1164. const code = document.createElement('code');
  1165. code.className = 'language-' + language;
  1166. pre.textContent = '';
  1167. pre.setAttribute('data-line', line)
  1168. code.textContent = 'Loading…';
  1169. pre.appendChild(code);
  1170. var xhr = new XMLHttpRequest();
  1171. xhr.open('GET', src, true);
  1172. xhr.onreadystatechange = function () {
  1173. if (xhr.readyState !== 4) {
  1174. return;
  1175. }
  1176. if (xhr.status < 400 && xhr.responseText) {
  1177. code.textContent = xhr.responseText;
  1178. Prism.highlightElement(code);
  1179. return;
  1180. }
  1181. if (xhr.status === 404) {
  1182. code.textContent = '✖ Error: File could not be found';
  1183. return;
  1184. }
  1185. if (xhr.status >= 400) {
  1186. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1187. return;
  1188. }
  1189. code.textContent = '✖ Error: An unknown error occurred';
  1190. };
  1191. xhr.send(null);
  1192. });
  1193. }
  1194. const modalButtons = document.querySelectorAll("[data-modal]");
  1195. const openedAsLocalFile = window.location.protocol === 'file:';
  1196. if (modalButtons.length > 0 && openedAsLocalFile) {
  1197. console.warn(
  1198. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1199. 'browsers block XHR requests when a page is opened this way'
  1200. );
  1201. }
  1202. modalButtons.forEach(function (trigger) {
  1203. if (openedAsLocalFile) {
  1204. trigger.setAttribute("hidden", "hidden");
  1205. }
  1206. trigger.addEventListener("click", function (event) {
  1207. event.preventDefault();
  1208. const modal = document.getElementById(trigger.dataset.modal);
  1209. if (!modal) {
  1210. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1211. return;
  1212. }
  1213. modal.classList.add("phpdocumentor-modal__open");
  1214. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1215. const exits = modal.querySelectorAll("[data-exit-button]");
  1216. exits.forEach(function (exit) {
  1217. exit.addEventListener("click", function (event) {
  1218. event.preventDefault();
  1219. modal.classList.remove("phpdocumentor-modal__open");
  1220. });
  1221. });
  1222. });
  1223. });
  1224. })();
  1225. </script>
  1226. </article>
  1227. </section>
  1228. <section class="phpdocumentor-on-this-page__sidebar">
  1229. <section class="phpdocumentor-on-this-page__content">
  1230. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1231. <ul class="phpdocumentor-list -clean">
  1232. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1233. <li>
  1234. <ul class="phpdocumentor-list -clean">
  1235. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-properties">Properties</a></li>
  1236. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-methods">Methods</a></li>
  1237. </ul>
  1238. </li>
  1239. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1240. <li>
  1241. <ul class="phpdocumentor-list -clean">
  1242. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_fpdf">$fpdf<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1243. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1244. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1245. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1246. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1247. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1248. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_prevColor">$prevColor<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1249. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1250. </ul>
  1251. </li>
  1252. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1253. <li>
  1254. <ul class="phpdocumentor-list -clean">
  1255. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct">__construct()</a></li>
  1256. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump">dump()</a></li>
  1257. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  1258. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1259. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1260. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1261. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1262. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1263. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_initFPDF">initFPDF()</a></li>
  1264. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_module">module()</a></li>
  1265. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1266. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1267. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1268. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1269. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1270. </ul>
  1271. </li>
  1272. </ul>
  1273. </section>
  1274. </section>
  1275. </div>
  1276. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1277. <section class="phpdocumentor-search-results__dialog">
  1278. <header class="phpdocumentor-search-results__header">
  1279. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1280. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1281. </header>
  1282. <section class="phpdocumentor-search-results__body">
  1283. <ul class="phpdocumentor-search-results__entries"></ul>
  1284. </section>
  1285. </section>
  1286. </section>
  1287. </div>
  1288. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1289. </main>
  1290. <script>
  1291. cssVars({});
  1292. </script>
  1293. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1294. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1295. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1296. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1297. </body>
  1298. </html>