chillerlan-QRCode-Output-QRFpdf.html 105 KB

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