chillerlan-QRCode-Output-QRFpdf.html 79 KB

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