chillerlan-QRCode-Output-QRFpdf.html 111 KB

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