chillerlan-QRCode-Output-QRFpdf.html 105 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185
  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. <h4 class="phpdocumentor-sidebar__root-namespace">
  82. <a href="namespaces/output.html" class="">Output</a>
  83. </h4>
  84. </section>
  85. <section class="phpdocumentor-sidebar__category">
  86. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  87. <h4 class="phpdocumentor-sidebar__root-namespace">
  88. <a href="packages/Application.html" class="">Application</a>
  89. </h4>
  90. </section>
  91. <section class="phpdocumentor-sidebar__category">
  92. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  93. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  94. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  95. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  96. </section>
  97. <section class="phpdocumentor-sidebar__category">
  98. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  99. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  100. </section>
  101. </aside>
  102. <div class="phpdocumentor-column -nine phpdocumentor-content">
  103. <section>
  104. <ul class="phpdocumentor-breadcrumbs">
  105. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  106. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  107. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  108. </ul>
  109. <article class="phpdocumentor-element -class">
  110. <h2 class="phpdocumentor-content__title">
  111. QRFpdf
  112. <span class="phpdocumentor-element__extends">
  113. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  114. </span>
  115. <div class="phpdocumentor-element__package">
  116. in package
  117. <ul class="phpdocumentor-breadcrumbs">
  118. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  119. </ul>
  120. </div>
  121. </h2>
  122. <div class="phpdocumentor-label-line">
  123. </div>
  124. <aside class="phpdocumentor-element-found-in">
  125. <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>
  126. :
  127. <span class="phpdocumentor-element-found-in__line">27</span>
  128. </aside>
  129. <p class="phpdocumentor-summary">QRFpdf output module (requires fpdf)</p>
  130. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  131. Tags
  132. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  133. </h5>
  134. <dl class="phpdocumentor-tag-list">
  135. <dt class="phpdocumentor-tag-list__entry">
  136. <span class="phpdocumentor-tag__name">see</span>
  137. </dt>
  138. <dd class="phpdocumentor-tag-list__definition">
  139. <span class="phpdocumentor-tag-link"><a href="https://github.com/Setasign/FPDF">https://github.com/Setasign/FPDF</a></span>
  140. </dd>
  141. <dt class="phpdocumentor-tag-list__entry">
  142. <span class="phpdocumentor-tag__name">see</span>
  143. </dt>
  144. <dd class="phpdocumentor-tag-list__definition">
  145. <span class="phpdocumentor-tag-link"><a href="http://www.fpdf.org/">http://www.fpdf.org/</a></span>
  146. </dd>
  147. </dl>
  148. <h3 id="toc">
  149. Table of Contents
  150. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  151. </h3>
  152. <h4 id="toc-constants">
  153. Constants
  154. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  155. </h4>
  156. <dl class="phpdocumentor-table-of-contents">
  157. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  158. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#constant_MIME_TYPE">MIME_TYPE</a>
  159. <span>
  160. &nbsp;= &#039;application/pdf&#039; </span>
  161. </dt>
  162. </dl>
  163. <h4 id="toc-properties">
  164. Properties
  165. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  166. </h4>
  167. <dl class="phpdocumentor-table-of-contents">
  168. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter</a>
  170. <span>
  171. &nbsp;: float </span>
  172. </dt>
  173. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  174. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius</a>
  175. <span>
  176. &nbsp;: float </span>
  177. </dt>
  178. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  179. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths</a>
  180. <span>
  181. &nbsp;: bool </span>
  182. </dt>
  183. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  184. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules</a>
  185. <span>
  186. &nbsp;: bool </span>
  187. </dt>
  188. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  189. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules</a>
  190. <span>
  191. &nbsp;: bool </span>
  192. </dt>
  193. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  194. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol</a>
  195. <span>
  196. &nbsp;: string </span>
  197. </dt>
  198. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  199. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect</a>
  200. <span>
  201. &nbsp;: array&lt;string|int, mixed&gt; </span>
  202. </dt>
  203. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  204. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_fpdf">$fpdf</a>
  205. <span>
  206. &nbsp;: <abbr title="\FPDF">FPDF</abbr> </span>
  207. </dt>
  208. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  209. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare</a>
  210. <span>
  211. &nbsp;: array&lt;string|int, mixed&gt; </span>
  212. </dt>
  213. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  214. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  215. <span>
  216. &nbsp;: int </span>
  217. </dt>
  218. <dd>the side length of the QR image (modules * scale)</dd>
  219. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  220. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  221. <span>
  222. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  223. </dt>
  224. <dd>the (filled) data matrix object</dd>
  225. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  226. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  227. <span>
  228. &nbsp;: int </span>
  229. </dt>
  230. <dd>the current size of the QR matrix</dd>
  231. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  232. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  233. <span>
  234. &nbsp;: array&lt;string|int, mixed&gt; </span>
  235. </dt>
  236. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  237. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  238. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  239. <span>
  240. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  241. </dt>
  242. <dd>the options instance</dd>
  243. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  244. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_prevColor">$prevColor</a>
  245. <span>
  246. &nbsp;: array&lt;string|int, mixed&gt;|null </span>
  247. </dt>
  248. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  249. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  250. <span>
  251. &nbsp;: int </span>
  252. </dt>
  253. </dl>
  254. <h4 id="toc-methods">
  255. Methods
  256. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  257. </h4>
  258. <dl class="phpdocumentor-table-of-contents">
  259. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  260. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct">__construct()</a>
  261. <span>
  262. &nbsp;: mixed </span>
  263. </dt>
  264. <dd>QRFpdf constructor.</dd>
  265. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  266. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump">dump()</a>
  267. <span>
  268. &nbsp;: string|<abbr title="\FPDF">FPDF</abbr> </span>
  269. </dt>
  270. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  271. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  272. <span>
  273. &nbsp;: bool </span>
  274. </dt>
  275. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  276. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  277. <span>
  278. &nbsp;: array&lt;string|int, mixed&gt; </span>
  279. </dt>
  280. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  281. returns an array with the transformed modules</dd>
  282. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  283. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a>
  284. <span>
  285. &nbsp;: void </span>
  286. </dt>
  287. <dd>Creates copies of several QROptions values to avoid calling the magic getters
  288. in long loops for a significant performance increase.</dd>
  289. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  290. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  291. <span>
  292. &nbsp;: array&lt;string|int, mixed&gt; </span>
  293. </dt>
  294. <dd>Returns a default value for either dark or light modules (return value depends on the output class)</dd>
  295. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  296. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  297. <span>
  298. &nbsp;: mixed </span>
  299. </dt>
  300. <dd>Returns the prepared value for the given $M_TYPE</dd>
  301. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  302. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  303. <span>
  304. &nbsp;: mixed </span>
  305. </dt>
  306. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  307. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  308. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a>
  309. <span>
  310. &nbsp;: array&lt;string|int, mixed&gt; </span>
  311. </dt>
  312. <dd>Returns a 2 element array with the current output width and height</dd>
  313. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  314. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_initFPDF">initFPDF()</a>
  315. <span>
  316. &nbsp;: <abbr title="\FPDF">FPDF</abbr> </span>
  317. </dt>
  318. <dd>Initializes an FPDF instance</dd>
  319. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  320. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_module">module()</a>
  321. <span>
  322. &nbsp;: void </span>
  323. </dt>
  324. <dd>Renders a single module</dd>
  325. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  326. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue">prepareModuleValue()</a>
  327. <span>
  328. &nbsp;: array&lt;string|int, mixed&gt; </span>
  329. </dt>
  330. <dd>Prepares the value for the given input (return value depends on the output class)</dd>
  331. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  332. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  333. <span>
  334. &nbsp;: void </span>
  335. </dt>
  336. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  337. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  338. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  339. <span>
  340. &nbsp;: void </span>
  341. </dt>
  342. <dd>Sets/updates the matrix dimensions</dd>
  343. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  344. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  345. <span>
  346. &nbsp;: void </span>
  347. </dt>
  348. <dd>Sets the initial module values</dd>
  349. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  350. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  351. <span>
  352. &nbsp;: string </span>
  353. </dt>
  354. <dd>Returns a base64 data URI for the given string and mime type</dd>
  355. </dl>
  356. <section class="phpdocumentor-constants">
  357. <h3 class="phpdocumentor-elements__header" id="constants">
  358. Constants
  359. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  360. </h3>
  361. <article class="phpdocumentor-element -constant -public ">
  362. <h4 class="phpdocumentor-element__name" id="constant_MIME_TYPE">
  363. MIME_TYPE
  364. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#constant_MIME_TYPE" class="headerlink"><i class="fas fa-link"></i></a>
  365. </h4>
  366. <aside class="phpdocumentor-element-found-in">
  367. <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>
  368. :
  369. <span class="phpdocumentor-element-found-in__line">29</span>
  370. </aside>
  371. <code class="phpdocumentor-signature phpdocumentor-code ">
  372. <span class="phpdocumentor-signature__visibility">public</span>
  373. <span class="phpdocumentor-signature__final">final</span> <span class="phpdocumentor-signature__type">mixed</span>
  374. <span class="phpdocumentor-signature__name">MIME_TYPE</span>
  375. = <span class="phpdocumentor-signature__default-value">&#039;application/pdf&#039;</span>
  376. </code>
  377. </article>
  378. </section>
  379. <section class="phpdocumentor-properties">
  380. <h3 class="phpdocumentor-elements__header" id="properties">
  381. Properties
  382. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  383. </h3>
  384. <article
  385. class="
  386. phpdocumentor-element
  387. -property
  388. -protected
  389. "
  390. >
  391. <h4 class="phpdocumentor-element__name" id="property_circleDiameter">
  392. $circleDiameter
  393. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter" class="headerlink"><i class="fas fa-link"></i></a>
  394. <span class="phpdocumentor-element__modifiers">
  395. </span>
  396. </h4>
  397. <aside class="phpdocumentor-element-found-in">
  398. <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>
  399. :
  400. <span class="phpdocumentor-element-found-in__line">67</span>
  401. </aside>
  402. <code class="phpdocumentor-code phpdocumentor-signature ">
  403. <span class="phpdocumentor-signature__visibility">protected</span>
  404. <span class="phpdocumentor-signature__type">float</span>
  405. <span class="phpdocumentor-signature__name">$circleDiameter</span>
  406. </code>
  407. </article>
  408. <article
  409. class="
  410. phpdocumentor-element
  411. -property
  412. -protected
  413. "
  414. >
  415. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  416. $circleRadius
  417. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  418. <span class="phpdocumentor-element__modifiers">
  419. </span>
  420. </h4>
  421. <aside class="phpdocumentor-element-found-in">
  422. <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>
  423. :
  424. <span class="phpdocumentor-element-found-in__line">66</span>
  425. </aside>
  426. <code class="phpdocumentor-code phpdocumentor-signature ">
  427. <span class="phpdocumentor-signature__visibility">protected</span>
  428. <span class="phpdocumentor-signature__type">float</span>
  429. <span class="phpdocumentor-signature__name">$circleRadius</span>
  430. </code>
  431. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  432. Tags
  433. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius#tags" class="headerlink"><i class="fas fa-link"></i></a>
  434. </h5>
  435. <dl class="phpdocumentor-tag-list">
  436. <dt class="phpdocumentor-tag-list__entry">
  437. <span class="phpdocumentor-tag__name">see</span>
  438. </dt>
  439. <dd class="phpdocumentor-tag-list__definition">
  440. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$circleRadius">QROptions::$circleRadius</abbr></span>
  441. </dd>
  442. </dl>
  443. </article>
  444. <article
  445. class="
  446. phpdocumentor-element
  447. -property
  448. -protected
  449. "
  450. >
  451. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  452. $connectPaths
  453. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  454. <span class="phpdocumentor-element__modifiers">
  455. </span>
  456. </h4>
  457. <aside class="phpdocumentor-element-found-in">
  458. <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>
  459. :
  460. <span class="phpdocumentor-element-found-in__line">54</span>
  461. </aside>
  462. <code class="phpdocumentor-code phpdocumentor-signature ">
  463. <span class="phpdocumentor-signature__visibility">protected</span>
  464. <span class="phpdocumentor-signature__type">bool</span>
  465. <span class="phpdocumentor-signature__name">$connectPaths</span>
  466. </code>
  467. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  468. Tags
  469. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  470. </h5>
  471. <dl class="phpdocumentor-tag-list">
  472. <dt class="phpdocumentor-tag-list__entry">
  473. <span class="phpdocumentor-tag__name">see</span>
  474. </dt>
  475. <dd class="phpdocumentor-tag-list__definition">
  476. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$connectPaths">QROptions::$connectPaths</abbr></span>
  477. </dd>
  478. </dl>
  479. </article>
  480. <article
  481. class="
  482. phpdocumentor-element
  483. -property
  484. -protected
  485. "
  486. >
  487. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  488. $drawCircularModules
  489. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  490. <span class="phpdocumentor-element__modifiers">
  491. </span>
  492. </h4>
  493. <aside class="phpdocumentor-element-found-in">
  494. <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>
  495. :
  496. <span class="phpdocumentor-element-found-in__line">62</span>
  497. </aside>
  498. <code class="phpdocumentor-code phpdocumentor-signature ">
  499. <span class="phpdocumentor-signature__visibility">protected</span>
  500. <span class="phpdocumentor-signature__type">bool</span>
  501. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  502. </code>
  503. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  504. Tags
  505. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  506. </h5>
  507. <dl class="phpdocumentor-tag-list">
  508. <dt class="phpdocumentor-tag-list__entry">
  509. <span class="phpdocumentor-tag__name">see</span>
  510. </dt>
  511. <dd class="phpdocumentor-tag-list__definition">
  512. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawCircularModules">QROptions::$drawCircularModules</abbr></span>
  513. </dd>
  514. </dl>
  515. </article>
  516. <article
  517. class="
  518. phpdocumentor-element
  519. -property
  520. -protected
  521. "
  522. >
  523. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  524. $drawLightModules
  525. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  526. <span class="phpdocumentor-element__modifiers">
  527. </span>
  528. </h4>
  529. <aside class="phpdocumentor-element-found-in">
  530. <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>
  531. :
  532. <span class="phpdocumentor-element-found-in__line">60</span>
  533. </aside>
  534. <code class="phpdocumentor-code phpdocumentor-signature ">
  535. <span class="phpdocumentor-signature__visibility">protected</span>
  536. <span class="phpdocumentor-signature__type">bool</span>
  537. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  538. </code>
  539. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  540. Tags
  541. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  542. </h5>
  543. <dl class="phpdocumentor-tag-list">
  544. <dt class="phpdocumentor-tag-list__entry">
  545. <span class="phpdocumentor-tag__name">see</span>
  546. </dt>
  547. <dd class="phpdocumentor-tag-list__definition">
  548. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawLightModules">QROptions::$drawLightModules</abbr></span>
  549. </dd>
  550. </dl>
  551. </article>
  552. <article
  553. class="
  554. phpdocumentor-element
  555. -property
  556. -protected
  557. "
  558. >
  559. <h4 class="phpdocumentor-element__name" id="property_eol">
  560. $eol
  561. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  562. <span class="phpdocumentor-element__modifiers">
  563. </span>
  564. </h4>
  565. <aside class="phpdocumentor-element-found-in">
  566. <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>
  567. :
  568. <span class="phpdocumentor-element-found-in__line">58</span>
  569. </aside>
  570. <code class="phpdocumentor-code phpdocumentor-signature ">
  571. <span class="phpdocumentor-signature__visibility">protected</span>
  572. <span class="phpdocumentor-signature__type">string</span>
  573. <span class="phpdocumentor-signature__name">$eol</span>
  574. </code>
  575. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  576. Tags
  577. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol#tags" class="headerlink"><i class="fas fa-link"></i></a>
  578. </h5>
  579. <dl class="phpdocumentor-tag-list">
  580. <dt class="phpdocumentor-tag-list__entry">
  581. <span class="phpdocumentor-tag__name">see</span>
  582. </dt>
  583. <dd class="phpdocumentor-tag-list__definition">
  584. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$eol">QROptions::$eol</abbr></span>
  585. </dd>
  586. </dl>
  587. </article>
  588. <article
  589. class="
  590. phpdocumentor-element
  591. -property
  592. -protected
  593. "
  594. >
  595. <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
  596. $excludeFromConnect
  597. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  598. <span class="phpdocumentor-element__modifiers">
  599. </span>
  600. </h4>
  601. <aside class="phpdocumentor-element-found-in">
  602. <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>
  603. :
  604. <span class="phpdocumentor-element-found-in__line">56</span>
  605. </aside>
  606. <code class="phpdocumentor-code phpdocumentor-signature ">
  607. <span class="phpdocumentor-signature__visibility">protected</span>
  608. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  609. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  610. </code>
  611. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  612. Tags
  613. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect#tags" class="headerlink"><i class="fas fa-link"></i></a>
  614. </h5>
  615. <dl class="phpdocumentor-tag-list">
  616. <dt class="phpdocumentor-tag-list__entry">
  617. <span class="phpdocumentor-tag__name">see</span>
  618. </dt>
  619. <dd class="phpdocumentor-tag-list__definition">
  620. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$excludeFromConnect">QROptions::$excludeFromConnect</abbr></span>
  621. </dd>
  622. </dl>
  623. </article>
  624. <article
  625. class="
  626. phpdocumentor-element
  627. -property
  628. -protected
  629. "
  630. >
  631. <h4 class="phpdocumentor-element__name" id="property_fpdf">
  632. $fpdf
  633. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_fpdf" class="headerlink"><i class="fas fa-link"></i></a>
  634. <span class="phpdocumentor-element__modifiers">
  635. </span>
  636. </h4>
  637. <aside class="phpdocumentor-element-found-in">
  638. <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>
  639. :
  640. <span class="phpdocumentor-element-found-in__line">31</span>
  641. </aside>
  642. <code class="phpdocumentor-code phpdocumentor-signature ">
  643. <span class="phpdocumentor-signature__visibility">protected</span>
  644. <span class="phpdocumentor-signature__type"><abbr title="\FPDF">FPDF</abbr></span>
  645. <span class="phpdocumentor-signature__name">$fpdf</span>
  646. </code>
  647. </article>
  648. <article
  649. class="
  650. phpdocumentor-element
  651. -property
  652. -protected
  653. "
  654. >
  655. <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
  656. $keepAsSquare
  657. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  658. <span class="phpdocumentor-element__modifiers">
  659. </span>
  660. </h4>
  661. <aside class="phpdocumentor-element-found-in">
  662. <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>
  663. :
  664. <span class="phpdocumentor-element-found-in__line">64</span>
  665. </aside>
  666. <code class="phpdocumentor-code phpdocumentor-signature ">
  667. <span class="phpdocumentor-signature__visibility">protected</span>
  668. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  669. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  670. </code>
  671. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  672. Tags
  673. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare#tags" class="headerlink"><i class="fas fa-link"></i></a>
  674. </h5>
  675. <dl class="phpdocumentor-tag-list">
  676. <dt class="phpdocumentor-tag-list__entry">
  677. <span class="phpdocumentor-tag__name">see</span>
  678. </dt>
  679. <dd class="phpdocumentor-tag-list__definition">
  680. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$keepAsSquare">QROptions::$keepAsSquare</abbr></span>
  681. </dd>
  682. </dl>
  683. </article>
  684. <article
  685. class="
  686. phpdocumentor-element
  687. -property
  688. -protected
  689. "
  690. >
  691. <h4 class="phpdocumentor-element__name" id="property_length">
  692. $length
  693. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  694. <span class="phpdocumentor-element__modifiers">
  695. </span>
  696. </h4>
  697. <aside class="phpdocumentor-element-found-in">
  698. <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>
  699. :
  700. <span class="phpdocumentor-element-found-in__line">34</span>
  701. </aside>
  702. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  703. <code class="phpdocumentor-code phpdocumentor-signature ">
  704. <span class="phpdocumentor-signature__visibility">protected</span>
  705. <span class="phpdocumentor-signature__type">int</span>
  706. <span class="phpdocumentor-signature__name">$length</span>
  707. </code>
  708. </article>
  709. <article
  710. class="
  711. phpdocumentor-element
  712. -property
  713. -protected
  714. "
  715. >
  716. <h4 class="phpdocumentor-element__name" id="property_matrix">
  717. $matrix
  718. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  719. <span class="phpdocumentor-element__modifiers">
  720. </span>
  721. </h4>
  722. <aside class="phpdocumentor-element-found-in">
  723. <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>
  724. :
  725. <span class="phpdocumentor-element-found-in__line">44</span>
  726. </aside>
  727. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  728. <code class="phpdocumentor-code phpdocumentor-signature ">
  729. <span class="phpdocumentor-signature__visibility">protected</span>
  730. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  731. <span class="phpdocumentor-signature__name">$matrix</span>
  732. </code>
  733. </article>
  734. <article
  735. class="
  736. phpdocumentor-element
  737. -property
  738. -protected
  739. "
  740. >
  741. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  742. $moduleCount
  743. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  744. <span class="phpdocumentor-element__modifiers">
  745. </span>
  746. </h4>
  747. <aside class="phpdocumentor-element-found-in">
  748. <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>
  749. :
  750. <span class="phpdocumentor-element-found-in__line">29</span>
  751. </aside>
  752. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  753. <code class="phpdocumentor-code phpdocumentor-signature ">
  754. <span class="phpdocumentor-signature__visibility">protected</span>
  755. <span class="phpdocumentor-signature__type">int</span>
  756. <span class="phpdocumentor-signature__name">$moduleCount</span>
  757. </code>
  758. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  759. Tags
  760. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  761. </h5>
  762. <dl class="phpdocumentor-tag-list">
  763. <dt class="phpdocumentor-tag-list__entry">
  764. <span class="phpdocumentor-tag__name">see</span>
  765. </dt>
  766. <dd class="phpdocumentor-tag-list__definition">
  767. <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>
  768. </dd>
  769. </dl>
  770. </article>
  771. <article
  772. class="
  773. phpdocumentor-element
  774. -property
  775. -protected
  776. "
  777. >
  778. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  779. $moduleValues
  780. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  781. <span class="phpdocumentor-element__modifiers">
  782. </span>
  783. </h4>
  784. <aside class="phpdocumentor-element-found-in">
  785. <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>
  786. :
  787. <span class="phpdocumentor-element-found-in__line">39</span>
  788. </aside>
  789. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  790. <code class="phpdocumentor-code phpdocumentor-signature ">
  791. <span class="phpdocumentor-signature__visibility">protected</span>
  792. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  793. <span class="phpdocumentor-signature__name">$moduleValues</span>
  794. </code>
  795. </article>
  796. <article
  797. class="
  798. phpdocumentor-element
  799. -property
  800. -protected
  801. "
  802. >
  803. <h4 class="phpdocumentor-element__name" id="property_options">
  804. $options
  805. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  806. <span class="phpdocumentor-element__modifiers">
  807. </span>
  808. </h4>
  809. <aside class="phpdocumentor-element-found-in">
  810. <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>
  811. :
  812. <span class="phpdocumentor-element-found-in__line">49</span>
  813. </aside>
  814. <p class="phpdocumentor-summary">the options instance</p>
  815. <code class="phpdocumentor-code phpdocumentor-signature ">
  816. <span class="phpdocumentor-signature__visibility">protected</span>
  817. <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>
  818. <span class="phpdocumentor-signature__name">$options</span>
  819. </code>
  820. </article>
  821. <article
  822. class="
  823. phpdocumentor-element
  824. -property
  825. -protected
  826. "
  827. >
  828. <h4 class="phpdocumentor-element__name" id="property_prevColor">
  829. $prevColor
  830. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_prevColor" class="headerlink"><i class="fas fa-link"></i></a>
  831. <span class="phpdocumentor-element__modifiers">
  832. </span>
  833. </h4>
  834. <aside class="phpdocumentor-element-found-in">
  835. <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>
  836. :
  837. <span class="phpdocumentor-element-found-in__line">32</span>
  838. </aside>
  839. <code class="phpdocumentor-code phpdocumentor-signature ">
  840. <span class="phpdocumentor-signature__visibility">protected</span>
  841. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;|null</span>
  842. <span class="phpdocumentor-signature__name">$prevColor</span>
  843. = <span class="phpdocumentor-signature__default-value">null</span></code>
  844. </article>
  845. <article
  846. class="
  847. phpdocumentor-element
  848. -property
  849. -protected
  850. "
  851. >
  852. <h4 class="phpdocumentor-element__name" id="property_scale">
  853. $scale
  854. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  855. <span class="phpdocumentor-element__modifiers">
  856. </span>
  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">52</span>
  862. </aside>
  863. <code class="phpdocumentor-code phpdocumentor-signature ">
  864. <span class="phpdocumentor-signature__visibility">protected</span>
  865. <span class="phpdocumentor-signature__type">int</span>
  866. <span class="phpdocumentor-signature__name">$scale</span>
  867. </code>
  868. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  869. Tags
  870. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  871. </h5>
  872. <dl class="phpdocumentor-tag-list">
  873. <dt class="phpdocumentor-tag-list__entry">
  874. <span class="phpdocumentor-tag__name">see</span>
  875. </dt>
  876. <dd class="phpdocumentor-tag-list__definition">
  877. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  878. </dd>
  879. </dl>
  880. </article>
  881. </section>
  882. <section class="phpdocumentor-methods">
  883. <h3 class="phpdocumentor-elements__header" id="methods">
  884. Methods
  885. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  886. </h3>
  887. <article
  888. class="phpdocumentor-element
  889. -method
  890. -public
  891. "
  892. >
  893. <h4 class="phpdocumentor-element__name" id="method___construct">
  894. __construct()
  895. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  896. </h4>
  897. <aside class="phpdocumentor-element-found-in">
  898. <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>
  899. :
  900. <span class="phpdocumentor-element-found-in__line">39</span>
  901. </aside>
  902. <p class="phpdocumentor-summary">QRFpdf constructor.</p>
  903. <code class="phpdocumentor-code phpdocumentor-signature ">
  904. <span class="phpdocumentor-signature__visibility">public</span>
  905. <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>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a>&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>
  906. <div class="phpdocumentor-label-line">
  907. </div>
  908. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  909. <dl class="phpdocumentor-argument-list">
  910. <dt class="phpdocumentor-argument-list__entry">
  911. <span class="phpdocumentor-signature__argument__name">$options</span>
  912. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  913. </dt>
  914. <dd class="phpdocumentor-argument-list__definition">
  915. </dd>
  916. <dt class="phpdocumentor-argument-list__entry">
  917. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  918. : <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>
  919. </dt>
  920. <dd class="phpdocumentor-argument-list__definition">
  921. </dd>
  922. </dl>
  923. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  924. Tags
  925. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
  926. </h5>
  927. <dl class="phpdocumentor-tag-list">
  928. <dt class="phpdocumentor-tag-list__entry">
  929. <span class="phpdocumentor-tag__name">throws</span>
  930. </dt>
  931. <dd class="phpdocumentor-tag-list__definition">
  932. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  933. </dd>
  934. </dl>
  935. </article>
  936. <article
  937. class="phpdocumentor-element
  938. -method
  939. -public
  940. "
  941. >
  942. <h4 class="phpdocumentor-element__name" id="method_dump">
  943. dump()
  944. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  945. </h4>
  946. <aside class="phpdocumentor-element-found-in">
  947. <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>
  948. :
  949. <span class="phpdocumentor-element-found-in__line">118</span>
  950. </aside>
  951. <code class="phpdocumentor-code phpdocumentor-signature ">
  952. <span class="phpdocumentor-signature__visibility">public</span>
  953. <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>
  954. <div class="phpdocumentor-label-line">
  955. </div>
  956. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  957. <dl class="phpdocumentor-argument-list">
  958. <dt class="phpdocumentor-argument-list__entry">
  959. <span class="phpdocumentor-signature__argument__name">$file</span>
  960. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  961. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  962. <dd class="phpdocumentor-argument-list__definition">
  963. </dd>
  964. </dl>
  965. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  966. Tags
  967. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  968. </h5>
  969. <dl class="phpdocumentor-tag-list">
  970. <dt class="phpdocumentor-tag-list__entry">
  971. <span class="phpdocumentor-tag__name">inheritDoc</span>
  972. </dt>
  973. <dd class="phpdocumentor-tag-list__definition">
  974. </dd>
  975. </dl>
  976. <section>
  977. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  978. <span class="phpdocumentor-signature__response_type">string|<abbr title="\FPDF">FPDF</abbr></span>
  979. </section>
  980. </article>
  981. <article
  982. class="phpdocumentor-element
  983. -method
  984. -public
  985. -static "
  986. >
  987. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  988. moduleValueIsValid()
  989. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  990. </h4>
  991. <aside class="phpdocumentor-element-found-in">
  992. <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>
  993. :
  994. <span class="phpdocumentor-element-found-in__line">56</span>
  995. </aside>
  996. <code class="phpdocumentor-code phpdocumentor-signature ">
  997. <span class="phpdocumentor-signature__visibility">public</span>
  998. <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>
  999. <div class="phpdocumentor-label-line">
  1000. </div>
  1001. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1002. <dl class="phpdocumentor-argument-list">
  1003. <dt class="phpdocumentor-argument-list__entry">
  1004. <span class="phpdocumentor-signature__argument__name">$value</span>
  1005. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1006. </dt>
  1007. <dd class="phpdocumentor-argument-list__definition">
  1008. </dd>
  1009. </dl>
  1010. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1011. Tags
  1012. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1013. </h5>
  1014. <dl class="phpdocumentor-tag-list">
  1015. <dt class="phpdocumentor-tag-list__entry">
  1016. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1017. </dt>
  1018. <dd class="phpdocumentor-tag-list__definition">
  1019. </dd>
  1020. </dl>
  1021. <section>
  1022. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1023. <span class="phpdocumentor-signature__response_type">bool</span>
  1024. </section>
  1025. </article>
  1026. <article
  1027. class="phpdocumentor-element
  1028. -method
  1029. -protected
  1030. "
  1031. >
  1032. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  1033. collectModules()
  1034. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  1035. </h4>
  1036. <aside class="phpdocumentor-element-found-in">
  1037. <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>
  1038. :
  1039. <span class="phpdocumentor-element-found-in__line">221</span>
  1040. </aside>
  1041. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  1042. returns an array with the transformed modules</p>
  1043. <code class="phpdocumentor-code phpdocumentor-signature ">
  1044. <span class="phpdocumentor-signature__visibility">protected</span>
  1045. <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>
  1046. <div class="phpdocumentor-label-line">
  1047. </div>
  1048. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  1049. <p>$x - current column
  1050. $y - current row
  1051. $M_TYPE - field value
  1052. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  1053. </section>
  1054. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1055. <dl class="phpdocumentor-argument-list">
  1056. <dt class="phpdocumentor-argument-list__entry">
  1057. <span class="phpdocumentor-signature__argument__name">$transform</span>
  1058. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  1059. </dt>
  1060. <dd class="phpdocumentor-argument-list__definition">
  1061. </dd>
  1062. </dl>
  1063. <section>
  1064. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1065. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1066. </section>
  1067. </article>
  1068. <article
  1069. class="phpdocumentor-element
  1070. -method
  1071. -protected
  1072. "
  1073. >
  1074. <h4 class="phpdocumentor-element__name" id="method_copyVars">
  1075. copyVars()
  1076. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars" class="headerlink"><i class="fas fa-link"></i></a>
  1077. </h4>
  1078. <aside class="phpdocumentor-element-found-in">
  1079. <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>
  1080. :
  1081. <span class="phpdocumentor-element-found-in__line">91</span>
  1082. </aside>
  1083. <p class="phpdocumentor-summary">Creates copies of several QROptions values to avoid calling the magic getters
  1084. in long loops for a significant performance increase.</p>
  1085. <code class="phpdocumentor-code phpdocumentor-signature ">
  1086. <span class="phpdocumentor-signature__visibility">protected</span>
  1087. <span class="phpdocumentor-signature__name">copyVars</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1088. <div class="phpdocumentor-label-line">
  1089. </div>
  1090. <section class="phpdocumentor-description"><p>These variables are usually used in the &quot;module&quot; methods and are called up to 31329 times (at version 40).</p>
  1091. </section>
  1092. </article>
  1093. <article
  1094. class="phpdocumentor-element
  1095. -method
  1096. -protected
  1097. "
  1098. >
  1099. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  1100. getDefaultModuleValue()
  1101. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1102. </h4>
  1103. <aside class="phpdocumentor-element-found-in">
  1104. <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>
  1105. :
  1106. <span class="phpdocumentor-element-found-in__line">104</span>
  1107. </aside>
  1108. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output class)</p>
  1109. <code class="phpdocumentor-code phpdocumentor-signature ">
  1110. <span class="phpdocumentor-signature__visibility">protected</span>
  1111. <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">array&lt;string|int, mixed&gt;</span></code>
  1112. <div class="phpdocumentor-label-line">
  1113. </div>
  1114. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1115. <dl class="phpdocumentor-argument-list">
  1116. <dt class="phpdocumentor-argument-list__entry">
  1117. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  1118. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1119. </dt>
  1120. <dd class="phpdocumentor-argument-list__definition">
  1121. </dd>
  1122. </dl>
  1123. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1124. Tags
  1125. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1126. </h5>
  1127. <dl class="phpdocumentor-tag-list">
  1128. <dt class="phpdocumentor-tag-list__entry">
  1129. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1130. </dt>
  1131. <dd class="phpdocumentor-tag-list__definition">
  1132. </dd>
  1133. </dl>
  1134. <section>
  1135. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1136. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1137. </section>
  1138. </article>
  1139. <article
  1140. class="phpdocumentor-element
  1141. -method
  1142. -protected
  1143. "
  1144. >
  1145. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  1146. getModuleValue()
  1147. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1148. </h4>
  1149. <aside class="phpdocumentor-element-found-in">
  1150. <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>
  1151. :
  1152. <span class="phpdocumentor-element-found-in__line">164</span>
  1153. </aside>
  1154. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  1155. <code class="phpdocumentor-code phpdocumentor-signature ">
  1156. <span class="phpdocumentor-signature__visibility">protected</span>
  1157. <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</span></code>
  1158. <div class="phpdocumentor-label-line">
  1159. </div>
  1160. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1161. <dl class="phpdocumentor-argument-list">
  1162. <dt class="phpdocumentor-argument-list__entry">
  1163. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1164. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1165. </dt>
  1166. <dd class="phpdocumentor-argument-list__definition">
  1167. </dd>
  1168. </dl>
  1169. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1170. Tags
  1171. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1172. </h5>
  1173. <dl class="phpdocumentor-tag-list">
  1174. <dt class="phpdocumentor-tag-list__entry">
  1175. <span class="phpdocumentor-tag__name">throws</span>
  1176. </dt>
  1177. <dd class="phpdocumentor-tag-list__definition">
  1178. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1179. <section class="phpdocumentor-description"><p>if $moduleValues[$M_TYPE] doesn't exist</p>
  1180. </section>
  1181. </dd>
  1182. </dl>
  1183. </article>
  1184. <article
  1185. class="phpdocumentor-element
  1186. -method
  1187. -protected
  1188. "
  1189. >
  1190. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  1191. getModuleValueAt()
  1192. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  1193. </h4>
  1194. <aside class="phpdocumentor-element-found-in">
  1195. <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>
  1196. :
  1197. <span class="phpdocumentor-element-found-in__line">176</span>
  1198. </aside>
  1199. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  1200. <code class="phpdocumentor-code phpdocumentor-signature ">
  1201. <span class="phpdocumentor-signature__visibility">protected</span>
  1202. <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</span></code>
  1203. <div class="phpdocumentor-label-line">
  1204. </div>
  1205. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1206. <dl class="phpdocumentor-argument-list">
  1207. <dt class="phpdocumentor-argument-list__entry">
  1208. <span class="phpdocumentor-signature__argument__name">$x</span>
  1209. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1210. </dt>
  1211. <dd class="phpdocumentor-argument-list__definition">
  1212. </dd>
  1213. <dt class="phpdocumentor-argument-list__entry">
  1214. <span class="phpdocumentor-signature__argument__name">$y</span>
  1215. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1216. </dt>
  1217. <dd class="phpdocumentor-argument-list__definition">
  1218. </dd>
  1219. </dl>
  1220. </article>
  1221. <article
  1222. class="phpdocumentor-element
  1223. -method
  1224. -protected
  1225. "
  1226. >
  1227. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  1228. getOutputDimensions()
  1229. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1230. </h4>
  1231. <aside class="phpdocumentor-element-found-in">
  1232. <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>
  1233. :
  1234. <span class="phpdocumentor-element-found-in__line">126</span>
  1235. </aside>
  1236. <p class="phpdocumentor-summary">Returns a 2 element array with the current output width and height</p>
  1237. <code class="phpdocumentor-code phpdocumentor-signature ">
  1238. <span class="phpdocumentor-signature__visibility">protected</span>
  1239. <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>
  1240. <div class="phpdocumentor-label-line">
  1241. </div>
  1242. <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>
  1243. </section>
  1244. <section>
  1245. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1246. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1247. </section>
  1248. </article>
  1249. <article
  1250. class="phpdocumentor-element
  1251. -method
  1252. -protected
  1253. "
  1254. >
  1255. <h4 class="phpdocumentor-element__name" id="method_initFPDF">
  1256. initFPDF()
  1257. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_initFPDF" class="headerlink"><i class="fas fa-link"></i></a>
  1258. </h4>
  1259. <aside class="phpdocumentor-element-found-in">
  1260. <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>
  1261. :
  1262. <span class="phpdocumentor-element-found-in__line">111</span>
  1263. </aside>
  1264. <p class="phpdocumentor-summary">Initializes an FPDF instance</p>
  1265. <code class="phpdocumentor-code phpdocumentor-signature ">
  1266. <span class="phpdocumentor-signature__visibility">protected</span>
  1267. <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>
  1268. <div class="phpdocumentor-label-line">
  1269. </div>
  1270. <section>
  1271. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1272. <span class="phpdocumentor-signature__response_type"><abbr title="\FPDF">FPDF</abbr></span>
  1273. </section>
  1274. </article>
  1275. <article
  1276. class="phpdocumentor-element
  1277. -method
  1278. -protected
  1279. "
  1280. >
  1281. <h4 class="phpdocumentor-element__name" id="method_module">
  1282. module()
  1283. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  1284. </h4>
  1285. <aside class="phpdocumentor-element-found-in">
  1286. <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>
  1287. :
  1288. <span class="phpdocumentor-element-found-in__line">157</span>
  1289. </aside>
  1290. <p class="phpdocumentor-summary">Renders a single module</p>
  1291. <code class="phpdocumentor-code phpdocumentor-signature ">
  1292. <span class="phpdocumentor-signature__visibility">protected</span>
  1293. <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>
  1294. <div class="phpdocumentor-label-line">
  1295. </div>
  1296. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1297. <dl class="phpdocumentor-argument-list">
  1298. <dt class="phpdocumentor-argument-list__entry">
  1299. <span class="phpdocumentor-signature__argument__name">$x</span>
  1300. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1301. </dt>
  1302. <dd class="phpdocumentor-argument-list__definition">
  1303. </dd>
  1304. <dt class="phpdocumentor-argument-list__entry">
  1305. <span class="phpdocumentor-signature__argument__name">$y</span>
  1306. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1307. </dt>
  1308. <dd class="phpdocumentor-argument-list__definition">
  1309. </dd>
  1310. <dt class="phpdocumentor-argument-list__entry">
  1311. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1312. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1313. </dt>
  1314. <dd class="phpdocumentor-argument-list__definition">
  1315. </dd>
  1316. </dl>
  1317. </article>
  1318. <article
  1319. class="phpdocumentor-element
  1320. -method
  1321. -protected
  1322. "
  1323. >
  1324. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  1325. prepareModuleValue()
  1326. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1327. </h4>
  1328. <aside class="phpdocumentor-element-found-in">
  1329. <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>
  1330. :
  1331. <span class="phpdocumentor-element-found-in__line">82</span>
  1332. </aside>
  1333. <p class="phpdocumentor-summary">Prepares the value for the given input (return value depends on the output class)</p>
  1334. <code class="phpdocumentor-code phpdocumentor-signature ">
  1335. <span class="phpdocumentor-signature__visibility">protected</span>
  1336. <span class="phpdocumentor-signature__name">prepareModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1337. <div class="phpdocumentor-label-line">
  1338. </div>
  1339. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1340. <dl class="phpdocumentor-argument-list">
  1341. <dt class="phpdocumentor-argument-list__entry">
  1342. <span class="phpdocumentor-signature__argument__name">$value</span>
  1343. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1344. </dt>
  1345. <dd class="phpdocumentor-argument-list__definition">
  1346. </dd>
  1347. </dl>
  1348. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1349. Tags
  1350. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1351. </h5>
  1352. <dl class="phpdocumentor-tag-list">
  1353. <dt class="phpdocumentor-tag-list__entry">
  1354. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1355. </dt>
  1356. <dd class="phpdocumentor-tag-list__definition">
  1357. </dd>
  1358. <dt class="phpdocumentor-tag-list__entry">
  1359. <span class="phpdocumentor-tag__name">throws</span>
  1360. </dt>
  1361. <dd class="phpdocumentor-tag-list__definition">
  1362. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1363. </dd>
  1364. </dl>
  1365. <section>
  1366. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1367. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1368. </section>
  1369. </article>
  1370. <article
  1371. class="phpdocumentor-element
  1372. -method
  1373. -protected
  1374. "
  1375. >
  1376. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1377. saveToFile()
  1378. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1379. </h4>
  1380. <aside class="phpdocumentor-element-found-in">
  1381. <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>
  1382. :
  1383. <span class="phpdocumentor-element-found-in__line">195</span>
  1384. </aside>
  1385. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1386. <code class="phpdocumentor-code phpdocumentor-signature ">
  1387. <span class="phpdocumentor-signature__visibility">protected</span>
  1388. <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>
  1389. <div class="phpdocumentor-label-line">
  1390. </div>
  1391. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1392. <dl class="phpdocumentor-argument-list">
  1393. <dt class="phpdocumentor-argument-list__entry">
  1394. <span class="phpdocumentor-signature__argument__name">$data</span>
  1395. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1396. </dt>
  1397. <dd class="phpdocumentor-argument-list__definition">
  1398. </dd>
  1399. <dt class="phpdocumentor-argument-list__entry">
  1400. <span class="phpdocumentor-signature__argument__name">$file</span>
  1401. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1402. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1403. <dd class="phpdocumentor-argument-list__definition">
  1404. </dd>
  1405. </dl>
  1406. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1407. Tags
  1408. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1409. </h5>
  1410. <dl class="phpdocumentor-tag-list">
  1411. <dt class="phpdocumentor-tag-list__entry">
  1412. <span class="phpdocumentor-tag__name">see</span>
  1413. </dt>
  1414. <dd class="phpdocumentor-tag-list__definition">
  1415. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1416. </dd>
  1417. <dt class="phpdocumentor-tag-list__entry">
  1418. <span class="phpdocumentor-tag__name">see</span>
  1419. </dt>
  1420. <dd class="phpdocumentor-tag-list__definition">
  1421. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1422. </dd>
  1423. <dt class="phpdocumentor-tag-list__entry">
  1424. <span class="phpdocumentor-tag__name">throws</span>
  1425. </dt>
  1426. <dd class="phpdocumentor-tag-list__definition">
  1427. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1428. </dd>
  1429. </dl>
  1430. </article>
  1431. <article
  1432. class="phpdocumentor-element
  1433. -method
  1434. -protected
  1435. "
  1436. >
  1437. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1438. setMatrixDimensions()
  1439. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1440. </h4>
  1441. <aside class="phpdocumentor-element-found-in">
  1442. <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>
  1443. :
  1444. <span class="phpdocumentor-element-found-in__line">115</span>
  1445. </aside>
  1446. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1447. <code class="phpdocumentor-code phpdocumentor-signature ">
  1448. <span class="phpdocumentor-signature__visibility">protected</span>
  1449. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1450. <div class="phpdocumentor-label-line">
  1451. </div>
  1452. <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>
  1453. </section>
  1454. </article>
  1455. <article
  1456. class="phpdocumentor-element
  1457. -method
  1458. -protected
  1459. "
  1460. >
  1461. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1462. setModuleValues()
  1463. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1464. </h4>
  1465. <aside class="phpdocumentor-element-found-in">
  1466. <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>
  1467. :
  1468. <span class="phpdocumentor-element-found-in__line">133</span>
  1469. </aside>
  1470. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1471. <code class="phpdocumentor-code phpdocumentor-signature ">
  1472. <span class="phpdocumentor-signature__visibility">protected</span>
  1473. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1474. <div class="phpdocumentor-label-line">
  1475. </div>
  1476. </article>
  1477. <article
  1478. class="phpdocumentor-element
  1479. -method
  1480. -protected
  1481. "
  1482. >
  1483. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1484. toBase64DataURI()
  1485. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1486. </h4>
  1487. <aside class="phpdocumentor-element-found-in">
  1488. <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>
  1489. :
  1490. <span class="phpdocumentor-element-found-in__line">183</span>
  1491. </aside>
  1492. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1493. <code class="phpdocumentor-code phpdocumentor-signature ">
  1494. <span class="phpdocumentor-signature__visibility">protected</span>
  1495. <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>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</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>
  1496. <div class="phpdocumentor-label-line">
  1497. </div>
  1498. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1499. <dl class="phpdocumentor-argument-list">
  1500. <dt class="phpdocumentor-argument-list__entry">
  1501. <span class="phpdocumentor-signature__argument__name">$data</span>
  1502. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1503. </dt>
  1504. <dd class="phpdocumentor-argument-list__definition">
  1505. </dd>
  1506. <dt class="phpdocumentor-argument-list__entry">
  1507. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1508. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1509. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1510. <dd class="phpdocumentor-argument-list__definition">
  1511. </dd>
  1512. </dl>
  1513. <section>
  1514. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1515. <span class="phpdocumentor-signature__response_type">string</span>
  1516. </section>
  1517. </article>
  1518. </section>
  1519. <div class="phpdocumentor-modal" id="source-view">
  1520. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1521. <div class="phpdocumentor-modal-container">
  1522. <div class="phpdocumentor-modal-content">
  1523. <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>
  1524. </div>
  1525. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1526. </div>
  1527. </div>
  1528. <script type="text/javascript">
  1529. (function () {
  1530. function loadExternalCodeSnippet(el, url, line) {
  1531. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1532. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1533. const language = 'php';
  1534. const code = document.createElement('code');
  1535. code.className = 'language-' + language;
  1536. pre.textContent = '';
  1537. pre.setAttribute('data-line', line)
  1538. code.textContent = 'Loading…';
  1539. pre.appendChild(code);
  1540. var xhr = new XMLHttpRequest();
  1541. xhr.open('GET', src, true);
  1542. xhr.onreadystatechange = function () {
  1543. if (xhr.readyState !== 4) {
  1544. return;
  1545. }
  1546. if (xhr.status < 400 && xhr.responseText) {
  1547. code.textContent = xhr.responseText;
  1548. Prism.highlightElement(code);
  1549. return;
  1550. }
  1551. if (xhr.status === 404) {
  1552. code.textContent = '✖ Error: File could not be found';
  1553. return;
  1554. }
  1555. if (xhr.status >= 400) {
  1556. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1557. return;
  1558. }
  1559. code.textContent = '✖ Error: An unknown error occurred';
  1560. };
  1561. xhr.send(null);
  1562. });
  1563. }
  1564. const modalButtons = document.querySelectorAll("[data-modal]");
  1565. const openedAsLocalFile = window.location.protocol === 'file:';
  1566. if (modalButtons.length > 0 && openedAsLocalFile) {
  1567. console.warn(
  1568. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1569. 'browsers block XHR requests when a page is opened this way'
  1570. );
  1571. }
  1572. modalButtons.forEach(function (trigger) {
  1573. if (openedAsLocalFile) {
  1574. trigger.setAttribute("hidden", "hidden");
  1575. }
  1576. trigger.addEventListener("click", function (event) {
  1577. event.preventDefault();
  1578. const modal = document.getElementById(trigger.dataset.modal);
  1579. if (!modal) {
  1580. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1581. return;
  1582. }
  1583. modal.classList.add("phpdocumentor-modal__open");
  1584. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1585. const exits = modal.querySelectorAll("[data-exit-button]");
  1586. exits.forEach(function (exit) {
  1587. exit.addEventListener("click", function (event) {
  1588. event.preventDefault();
  1589. modal.classList.remove("phpdocumentor-modal__open");
  1590. });
  1591. });
  1592. });
  1593. });
  1594. })();
  1595. </script>
  1596. </article>
  1597. </section>
  1598. <section class="phpdocumentor-on-this-page__sidebar">
  1599. <section class="phpdocumentor-on-this-page__content">
  1600. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1601. <ul class="phpdocumentor-list -clean">
  1602. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1603. <li>
  1604. <ul class="phpdocumentor-list -clean">
  1605. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-constants">Constants</a></li>
  1606. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-properties">Properties</a></li>
  1607. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-methods">Methods</a></li>
  1608. </ul>
  1609. </li>
  1610. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  1611. <li>
  1612. <ul class="phpdocumentor-list -clean">
  1613. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#constant_MIME_TYPE">MIME_TYPE</a></li>
  1614. </ul>
  1615. </li>
  1616. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1617. <li>
  1618. <ul class="phpdocumentor-list -clean">
  1619. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1620. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1621. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1622. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1623. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1624. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1625. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1626. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_fpdf">$fpdf<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1627. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1628. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1629. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1630. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1631. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1632. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1633. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_prevColor">$prevColor<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1634. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1635. </ul>
  1636. </li>
  1637. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1638. <li>
  1639. <ul class="phpdocumentor-list -clean">
  1640. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct">__construct()</a></li>
  1641. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump">dump()</a></li>
  1642. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  1643. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1644. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a></li>
  1645. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1646. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1647. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1648. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1649. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_initFPDF">initFPDF()</a></li>
  1650. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_module">module()</a></li>
  1651. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1652. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1653. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1654. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1655. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1656. </ul>
  1657. </li>
  1658. </ul>
  1659. </section>
  1660. </section>
  1661. </div>
  1662. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1663. <section class="phpdocumentor-search-results__dialog">
  1664. <header class="phpdocumentor-search-results__header">
  1665. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1666. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1667. </header>
  1668. <section class="phpdocumentor-search-results__body">
  1669. <ul class="phpdocumentor-search-results__entries"></ul>
  1670. </section>
  1671. </section>
  1672. </section>
  1673. </div>
  1674. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1675. </main>
  1676. <script>
  1677. cssVars({});
  1678. </script>
  1679. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1680. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1681. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1682. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1683. </body>
  1684. </html>