chillerlan-QRCode-Output-QRFpdf.html 106 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192
  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">121</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 class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\FPDF">FPDF</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fpdf</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. <dt class="phpdocumentor-argument-list__entry">
  965. <span class="phpdocumentor-signature__argument__name">$fpdf</span>
  966. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\FPDF">FPDF</abbr></span>
  967. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  968. <dd class="phpdocumentor-argument-list__definition">
  969. </dd>
  970. </dl>
  971. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  972. Tags
  973. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  974. </h5>
  975. <dl class="phpdocumentor-tag-list">
  976. <dt class="phpdocumentor-tag-list__entry">
  977. <span class="phpdocumentor-tag__name">inheritDoc</span>
  978. </dt>
  979. <dd class="phpdocumentor-tag-list__definition">
  980. </dd>
  981. </dl>
  982. <section>
  983. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  984. <span class="phpdocumentor-signature__response_type">string|<abbr title="\FPDF">FPDF</abbr></span>
  985. </section>
  986. </article>
  987. <article
  988. class="phpdocumentor-element
  989. -method
  990. -public
  991. -static "
  992. >
  993. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  994. moduleValueIsValid()
  995. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  996. </h4>
  997. <aside class="phpdocumentor-element-found-in">
  998. <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>
  999. :
  1000. <span class="phpdocumentor-element-found-in__line">56</span>
  1001. </aside>
  1002. <code class="phpdocumentor-code phpdocumentor-signature ">
  1003. <span class="phpdocumentor-signature__visibility">public</span>
  1004. <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>
  1005. <div class="phpdocumentor-label-line">
  1006. </div>
  1007. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1008. <dl class="phpdocumentor-argument-list">
  1009. <dt class="phpdocumentor-argument-list__entry">
  1010. <span class="phpdocumentor-signature__argument__name">$value</span>
  1011. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1012. </dt>
  1013. <dd class="phpdocumentor-argument-list__definition">
  1014. </dd>
  1015. </dl>
  1016. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1017. Tags
  1018. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1019. </h5>
  1020. <dl class="phpdocumentor-tag-list">
  1021. <dt class="phpdocumentor-tag-list__entry">
  1022. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1023. </dt>
  1024. <dd class="phpdocumentor-tag-list__definition">
  1025. </dd>
  1026. </dl>
  1027. <section>
  1028. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1029. <span class="phpdocumentor-signature__response_type">bool</span>
  1030. </section>
  1031. </article>
  1032. <article
  1033. class="phpdocumentor-element
  1034. -method
  1035. -protected
  1036. "
  1037. >
  1038. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  1039. collectModules()
  1040. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  1041. </h4>
  1042. <aside class="phpdocumentor-element-found-in">
  1043. <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>
  1044. :
  1045. <span class="phpdocumentor-element-found-in__line">221</span>
  1046. </aside>
  1047. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  1048. returns an array with the transformed modules</p>
  1049. <code class="phpdocumentor-code phpdocumentor-signature ">
  1050. <span class="phpdocumentor-signature__visibility">protected</span>
  1051. <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>
  1052. <div class="phpdocumentor-label-line">
  1053. </div>
  1054. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  1055. <p>$x - current column
  1056. $y - current row
  1057. $M_TYPE - field value
  1058. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  1059. </section>
  1060. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1061. <dl class="phpdocumentor-argument-list">
  1062. <dt class="phpdocumentor-argument-list__entry">
  1063. <span class="phpdocumentor-signature__argument__name">$transform</span>
  1064. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  1065. </dt>
  1066. <dd class="phpdocumentor-argument-list__definition">
  1067. </dd>
  1068. </dl>
  1069. <section>
  1070. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1071. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1072. </section>
  1073. </article>
  1074. <article
  1075. class="phpdocumentor-element
  1076. -method
  1077. -protected
  1078. "
  1079. >
  1080. <h4 class="phpdocumentor-element__name" id="method_copyVars">
  1081. copyVars()
  1082. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars" class="headerlink"><i class="fas fa-link"></i></a>
  1083. </h4>
  1084. <aside class="phpdocumentor-element-found-in">
  1085. <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>
  1086. :
  1087. <span class="phpdocumentor-element-found-in__line">91</span>
  1088. </aside>
  1089. <p class="phpdocumentor-summary">Creates copies of several QROptions values to avoid calling the magic getters
  1090. in long loops for a significant performance increase.</p>
  1091. <code class="phpdocumentor-code phpdocumentor-signature ">
  1092. <span class="phpdocumentor-signature__visibility">protected</span>
  1093. <span class="phpdocumentor-signature__name">copyVars</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1094. <div class="phpdocumentor-label-line">
  1095. </div>
  1096. <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>
  1097. </section>
  1098. </article>
  1099. <article
  1100. class="phpdocumentor-element
  1101. -method
  1102. -protected
  1103. "
  1104. >
  1105. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  1106. getDefaultModuleValue()
  1107. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1108. </h4>
  1109. <aside class="phpdocumentor-element-found-in">
  1110. <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>
  1111. :
  1112. <span class="phpdocumentor-element-found-in__line">104</span>
  1113. </aside>
  1114. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output class)</p>
  1115. <code class="phpdocumentor-code phpdocumentor-signature ">
  1116. <span class="phpdocumentor-signature__visibility">protected</span>
  1117. <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>
  1118. <div class="phpdocumentor-label-line">
  1119. </div>
  1120. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1121. <dl class="phpdocumentor-argument-list">
  1122. <dt class="phpdocumentor-argument-list__entry">
  1123. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  1124. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1125. </dt>
  1126. <dd class="phpdocumentor-argument-list__definition">
  1127. </dd>
  1128. </dl>
  1129. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1130. Tags
  1131. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1132. </h5>
  1133. <dl class="phpdocumentor-tag-list">
  1134. <dt class="phpdocumentor-tag-list__entry">
  1135. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1136. </dt>
  1137. <dd class="phpdocumentor-tag-list__definition">
  1138. </dd>
  1139. </dl>
  1140. <section>
  1141. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1142. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1143. </section>
  1144. </article>
  1145. <article
  1146. class="phpdocumentor-element
  1147. -method
  1148. -protected
  1149. "
  1150. >
  1151. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  1152. getModuleValue()
  1153. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1154. </h4>
  1155. <aside class="phpdocumentor-element-found-in">
  1156. <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>
  1157. :
  1158. <span class="phpdocumentor-element-found-in__line">164</span>
  1159. </aside>
  1160. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  1161. <code class="phpdocumentor-code phpdocumentor-signature ">
  1162. <span class="phpdocumentor-signature__visibility">protected</span>
  1163. <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>
  1164. <div class="phpdocumentor-label-line">
  1165. </div>
  1166. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1167. <dl class="phpdocumentor-argument-list">
  1168. <dt class="phpdocumentor-argument-list__entry">
  1169. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1170. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1171. </dt>
  1172. <dd class="phpdocumentor-argument-list__definition">
  1173. </dd>
  1174. </dl>
  1175. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1176. Tags
  1177. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1178. </h5>
  1179. <dl class="phpdocumentor-tag-list">
  1180. <dt class="phpdocumentor-tag-list__entry">
  1181. <span class="phpdocumentor-tag__name">throws</span>
  1182. </dt>
  1183. <dd class="phpdocumentor-tag-list__definition">
  1184. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1185. <section class="phpdocumentor-description"><p>if $moduleValues[$M_TYPE] doesn't exist</p>
  1186. </section>
  1187. </dd>
  1188. </dl>
  1189. </article>
  1190. <article
  1191. class="phpdocumentor-element
  1192. -method
  1193. -protected
  1194. "
  1195. >
  1196. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  1197. getModuleValueAt()
  1198. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  1199. </h4>
  1200. <aside class="phpdocumentor-element-found-in">
  1201. <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>
  1202. :
  1203. <span class="phpdocumentor-element-found-in__line">176</span>
  1204. </aside>
  1205. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  1206. <code class="phpdocumentor-code phpdocumentor-signature ">
  1207. <span class="phpdocumentor-signature__visibility">protected</span>
  1208. <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>
  1209. <div class="phpdocumentor-label-line">
  1210. </div>
  1211. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1212. <dl class="phpdocumentor-argument-list">
  1213. <dt class="phpdocumentor-argument-list__entry">
  1214. <span class="phpdocumentor-signature__argument__name">$x</span>
  1215. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1216. </dt>
  1217. <dd class="phpdocumentor-argument-list__definition">
  1218. </dd>
  1219. <dt class="phpdocumentor-argument-list__entry">
  1220. <span class="phpdocumentor-signature__argument__name">$y</span>
  1221. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1222. </dt>
  1223. <dd class="phpdocumentor-argument-list__definition">
  1224. </dd>
  1225. </dl>
  1226. </article>
  1227. <article
  1228. class="phpdocumentor-element
  1229. -method
  1230. -protected
  1231. "
  1232. >
  1233. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  1234. getOutputDimensions()
  1235. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1236. </h4>
  1237. <aside class="phpdocumentor-element-found-in">
  1238. <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>
  1239. :
  1240. <span class="phpdocumentor-element-found-in__line">126</span>
  1241. </aside>
  1242. <p class="phpdocumentor-summary">Returns a 2 element array with the current output width and height</p>
  1243. <code class="phpdocumentor-code phpdocumentor-signature ">
  1244. <span class="phpdocumentor-signature__visibility">protected</span>
  1245. <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>
  1246. <div class="phpdocumentor-label-line">
  1247. </div>
  1248. <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>
  1249. </section>
  1250. <section>
  1251. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1252. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1253. </section>
  1254. </article>
  1255. <article
  1256. class="phpdocumentor-element
  1257. -method
  1258. -protected
  1259. "
  1260. >
  1261. <h4 class="phpdocumentor-element__name" id="method_initFPDF">
  1262. initFPDF()
  1263. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_initFPDF" class="headerlink"><i class="fas fa-link"></i></a>
  1264. </h4>
  1265. <aside class="phpdocumentor-element-found-in">
  1266. <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>
  1267. :
  1268. <span class="phpdocumentor-element-found-in__line">111</span>
  1269. </aside>
  1270. <p class="phpdocumentor-summary">Initializes an FPDF instance</p>
  1271. <code class="phpdocumentor-code phpdocumentor-signature ">
  1272. <span class="phpdocumentor-signature__visibility">protected</span>
  1273. <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>
  1274. <div class="phpdocumentor-label-line">
  1275. </div>
  1276. <section>
  1277. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1278. <span class="phpdocumentor-signature__response_type"><abbr title="\FPDF">FPDF</abbr></span>
  1279. </section>
  1280. </article>
  1281. <article
  1282. class="phpdocumentor-element
  1283. -method
  1284. -protected
  1285. "
  1286. >
  1287. <h4 class="phpdocumentor-element__name" id="method_module">
  1288. module()
  1289. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  1290. </h4>
  1291. <aside class="phpdocumentor-element-found-in">
  1292. <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>
  1293. :
  1294. <span class="phpdocumentor-element-found-in__line">159</span>
  1295. </aside>
  1296. <p class="phpdocumentor-summary">Renders a single module</p>
  1297. <code class="phpdocumentor-code phpdocumentor-signature ">
  1298. <span class="phpdocumentor-signature__visibility">protected</span>
  1299. <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>
  1300. <div class="phpdocumentor-label-line">
  1301. </div>
  1302. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1303. <dl class="phpdocumentor-argument-list">
  1304. <dt class="phpdocumentor-argument-list__entry">
  1305. <span class="phpdocumentor-signature__argument__name">$x</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">$y</span>
  1312. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1313. </dt>
  1314. <dd class="phpdocumentor-argument-list__definition">
  1315. </dd>
  1316. <dt class="phpdocumentor-argument-list__entry">
  1317. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1318. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1319. </dt>
  1320. <dd class="phpdocumentor-argument-list__definition">
  1321. </dd>
  1322. </dl>
  1323. </article>
  1324. <article
  1325. class="phpdocumentor-element
  1326. -method
  1327. -protected
  1328. "
  1329. >
  1330. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  1331. prepareModuleValue()
  1332. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1333. </h4>
  1334. <aside class="phpdocumentor-element-found-in">
  1335. <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>
  1336. :
  1337. <span class="phpdocumentor-element-found-in__line">82</span>
  1338. </aside>
  1339. <p class="phpdocumentor-summary">Prepares the value for the given input (return value depends on the output class)</p>
  1340. <code class="phpdocumentor-code phpdocumentor-signature ">
  1341. <span class="phpdocumentor-signature__visibility">protected</span>
  1342. <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>
  1343. <div class="phpdocumentor-label-line">
  1344. </div>
  1345. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1346. <dl class="phpdocumentor-argument-list">
  1347. <dt class="phpdocumentor-argument-list__entry">
  1348. <span class="phpdocumentor-signature__argument__name">$value</span>
  1349. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1350. </dt>
  1351. <dd class="phpdocumentor-argument-list__definition">
  1352. </dd>
  1353. </dl>
  1354. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1355. Tags
  1356. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1357. </h5>
  1358. <dl class="phpdocumentor-tag-list">
  1359. <dt class="phpdocumentor-tag-list__entry">
  1360. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1361. </dt>
  1362. <dd class="phpdocumentor-tag-list__definition">
  1363. </dd>
  1364. <dt class="phpdocumentor-tag-list__entry">
  1365. <span class="phpdocumentor-tag__name">throws</span>
  1366. </dt>
  1367. <dd class="phpdocumentor-tag-list__definition">
  1368. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1369. </dd>
  1370. </dl>
  1371. <section>
  1372. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1373. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1374. </section>
  1375. </article>
  1376. <article
  1377. class="phpdocumentor-element
  1378. -method
  1379. -protected
  1380. "
  1381. >
  1382. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1383. saveToFile()
  1384. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1385. </h4>
  1386. <aside class="phpdocumentor-element-found-in">
  1387. <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>
  1388. :
  1389. <span class="phpdocumentor-element-found-in__line">195</span>
  1390. </aside>
  1391. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1392. <code class="phpdocumentor-code phpdocumentor-signature ">
  1393. <span class="phpdocumentor-signature__visibility">protected</span>
  1394. <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>
  1395. <div class="phpdocumentor-label-line">
  1396. </div>
  1397. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1398. <dl class="phpdocumentor-argument-list">
  1399. <dt class="phpdocumentor-argument-list__entry">
  1400. <span class="phpdocumentor-signature__argument__name">$data</span>
  1401. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1402. </dt>
  1403. <dd class="phpdocumentor-argument-list__definition">
  1404. </dd>
  1405. <dt class="phpdocumentor-argument-list__entry">
  1406. <span class="phpdocumentor-signature__argument__name">$file</span>
  1407. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1408. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1409. <dd class="phpdocumentor-argument-list__definition">
  1410. </dd>
  1411. </dl>
  1412. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1413. Tags
  1414. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1415. </h5>
  1416. <dl class="phpdocumentor-tag-list">
  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\Output\file_put_contents()">file_put_contents()</abbr></span>
  1422. </dd>
  1423. <dt class="phpdocumentor-tag-list__entry">
  1424. <span class="phpdocumentor-tag__name">see</span>
  1425. </dt>
  1426. <dd class="phpdocumentor-tag-list__definition">
  1427. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1428. </dd>
  1429. <dt class="phpdocumentor-tag-list__entry">
  1430. <span class="phpdocumentor-tag__name">throws</span>
  1431. </dt>
  1432. <dd class="phpdocumentor-tag-list__definition">
  1433. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1434. </dd>
  1435. </dl>
  1436. </article>
  1437. <article
  1438. class="phpdocumentor-element
  1439. -method
  1440. -protected
  1441. "
  1442. >
  1443. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1444. setMatrixDimensions()
  1445. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1446. </h4>
  1447. <aside class="phpdocumentor-element-found-in">
  1448. <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>
  1449. :
  1450. <span class="phpdocumentor-element-found-in__line">115</span>
  1451. </aside>
  1452. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1453. <code class="phpdocumentor-code phpdocumentor-signature ">
  1454. <span class="phpdocumentor-signature__visibility">protected</span>
  1455. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1456. <div class="phpdocumentor-label-line">
  1457. </div>
  1458. <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>
  1459. </section>
  1460. </article>
  1461. <article
  1462. class="phpdocumentor-element
  1463. -method
  1464. -protected
  1465. "
  1466. >
  1467. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1468. setModuleValues()
  1469. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1470. </h4>
  1471. <aside class="phpdocumentor-element-found-in">
  1472. <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>
  1473. :
  1474. <span class="phpdocumentor-element-found-in__line">133</span>
  1475. </aside>
  1476. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1477. <code class="phpdocumentor-code phpdocumentor-signature ">
  1478. <span class="phpdocumentor-signature__visibility">protected</span>
  1479. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1480. <div class="phpdocumentor-label-line">
  1481. </div>
  1482. </article>
  1483. <article
  1484. class="phpdocumentor-element
  1485. -method
  1486. -protected
  1487. "
  1488. >
  1489. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1490. toBase64DataURI()
  1491. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1492. </h4>
  1493. <aside class="phpdocumentor-element-found-in">
  1494. <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>
  1495. :
  1496. <span class="phpdocumentor-element-found-in__line">183</span>
  1497. </aside>
  1498. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1499. <code class="phpdocumentor-code phpdocumentor-signature ">
  1500. <span class="phpdocumentor-signature__visibility">protected</span>
  1501. <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>
  1502. <div class="phpdocumentor-label-line">
  1503. </div>
  1504. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1505. <dl class="phpdocumentor-argument-list">
  1506. <dt class="phpdocumentor-argument-list__entry">
  1507. <span class="phpdocumentor-signature__argument__name">$data</span>
  1508. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1509. </dt>
  1510. <dd class="phpdocumentor-argument-list__definition">
  1511. </dd>
  1512. <dt class="phpdocumentor-argument-list__entry">
  1513. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1514. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1515. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1516. <dd class="phpdocumentor-argument-list__definition">
  1517. </dd>
  1518. </dl>
  1519. <section>
  1520. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1521. <span class="phpdocumentor-signature__response_type">string</span>
  1522. </section>
  1523. </article>
  1524. </section>
  1525. <div class="phpdocumentor-modal" id="source-view">
  1526. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1527. <div class="phpdocumentor-modal-container">
  1528. <div class="phpdocumentor-modal-content">
  1529. <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>
  1530. </div>
  1531. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1532. </div>
  1533. </div>
  1534. <script type="text/javascript">
  1535. (function () {
  1536. function loadExternalCodeSnippet(el, url, line) {
  1537. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1538. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1539. const language = 'php';
  1540. const code = document.createElement('code');
  1541. code.className = 'language-' + language;
  1542. pre.textContent = '';
  1543. pre.setAttribute('data-line', line)
  1544. code.textContent = 'Loading…';
  1545. pre.appendChild(code);
  1546. var xhr = new XMLHttpRequest();
  1547. xhr.open('GET', src, true);
  1548. xhr.onreadystatechange = function () {
  1549. if (xhr.readyState !== 4) {
  1550. return;
  1551. }
  1552. if (xhr.status < 400 && xhr.responseText) {
  1553. code.textContent = xhr.responseText;
  1554. Prism.highlightElement(code);
  1555. return;
  1556. }
  1557. if (xhr.status === 404) {
  1558. code.textContent = '✖ Error: File could not be found';
  1559. return;
  1560. }
  1561. if (xhr.status >= 400) {
  1562. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1563. return;
  1564. }
  1565. code.textContent = '✖ Error: An unknown error occurred';
  1566. };
  1567. xhr.send(null);
  1568. });
  1569. }
  1570. const modalButtons = document.querySelectorAll("[data-modal]");
  1571. const openedAsLocalFile = window.location.protocol === 'file:';
  1572. if (modalButtons.length > 0 && openedAsLocalFile) {
  1573. console.warn(
  1574. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1575. 'browsers block XHR requests when a page is opened this way'
  1576. );
  1577. }
  1578. modalButtons.forEach(function (trigger) {
  1579. if (openedAsLocalFile) {
  1580. trigger.setAttribute("hidden", "hidden");
  1581. }
  1582. trigger.addEventListener("click", function (event) {
  1583. event.preventDefault();
  1584. const modal = document.getElementById(trigger.dataset.modal);
  1585. if (!modal) {
  1586. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1587. return;
  1588. }
  1589. modal.classList.add("phpdocumentor-modal__open");
  1590. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1591. const exits = modal.querySelectorAll("[data-exit-button]");
  1592. exits.forEach(function (exit) {
  1593. exit.addEventListener("click", function (event) {
  1594. event.preventDefault();
  1595. modal.classList.remove("phpdocumentor-modal__open");
  1596. });
  1597. });
  1598. });
  1599. });
  1600. })();
  1601. </script>
  1602. </article>
  1603. </section>
  1604. <section class="phpdocumentor-on-this-page__sidebar">
  1605. <section class="phpdocumentor-on-this-page__content">
  1606. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1607. <ul class="phpdocumentor-list -clean">
  1608. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1609. <li>
  1610. <ul class="phpdocumentor-list -clean">
  1611. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-constants">Constants</a></li>
  1612. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-properties">Properties</a></li>
  1613. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#toc-methods">Methods</a></li>
  1614. </ul>
  1615. </li>
  1616. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  1617. <li>
  1618. <ul class="phpdocumentor-list -clean">
  1619. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#constant_MIME_TYPE">MIME_TYPE</a></li>
  1620. </ul>
  1621. </li>
  1622. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1623. <li>
  1624. <ul class="phpdocumentor-list -clean">
  1625. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1626. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1627. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1628. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1629. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1630. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1631. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1632. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_fpdf">$fpdf<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1633. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1634. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1635. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1636. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1637. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1638. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1639. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#property_prevColor">$prevColor<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1640. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QRFpdf.html"></li>
  1641. </ul>
  1642. </li>
  1643. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1644. <li>
  1645. <ul class="phpdocumentor-list -clean">
  1646. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct">__construct()</a></li>
  1647. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump">dump()</a></li>
  1648. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  1649. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1650. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a></li>
  1651. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1652. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1653. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1654. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1655. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_initFPDF">initFPDF()</a></li>
  1656. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_module">module()</a></li>
  1657. <li><a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1658. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1659. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1660. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1661. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1662. </ul>
  1663. </li>
  1664. </ul>
  1665. </section>
  1666. </section>
  1667. </div>
  1668. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1669. <section class="phpdocumentor-search-results__dialog">
  1670. <header class="phpdocumentor-search-results__header">
  1671. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1672. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1673. </header>
  1674. <section class="phpdocumentor-search-results__body">
  1675. <ul class="phpdocumentor-search-results__entries"></ul>
  1676. </section>
  1677. </section>
  1678. </section>
  1679. </div>
  1680. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1681. </main>
  1682. <script>
  1683. cssVars({});
  1684. </script>
  1685. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1686. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1687. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1688. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1689. </body>
  1690. </html>