chillerlan-QRCode-Output-QRFpdf.html 62 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290
  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=Source+Sans+Pro:wght@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/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. QRFpdf
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  95. </span>
  96. <div class="phpdocumentor-element__package">
  97. in package
  98. <ul class="phpdocumentor-breadcrumbs">
  99. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  100. </ul>
  101. </div>
  102. </h2>
  103. <aside class="phpdocumentor-element-found-in">
  104. <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>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">26</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">QRFpdf output module (requires fpdf)</p>
  109. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  110. Tags
  111. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  112. </h5>
  113. <dl class="phpdocumentor-tag-list">
  114. <dt class="phpdocumentor-tag-list__entry">
  115. <span class="phpdocumentor-tag__name">see</span>
  116. </dt>
  117. <dd class="phpdocumentor-tag-list__definition">
  118. <span class="phpdocumentor-tag-link"><a href="https://github.com/Setasign/FPDF"><abbr title="https://github.com/Setasign/FPDF">https://github.com/Setasign/FPDF</abbr></a></span>
  119. </dd>
  120. <dt class="phpdocumentor-tag-list__entry">
  121. <span class="phpdocumentor-tag__name">see</span>
  122. </dt>
  123. <dd class="phpdocumentor-tag-list__definition">
  124. <span class="phpdocumentor-tag-link"><a href="http://www.fpdf.org/"><abbr title="http://www.fpdf.org/">http://www.fpdf.org/</abbr></a></span>
  125. </dd>
  126. </dl>
  127. <h3 id="toc">
  128. Table of Contents
  129. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  130. </h3>
  131. <dl class="phpdocumentor-table-of-contents">
  132. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  133. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  134. <span>
  135. &nbsp;: int </span>
  136. </dt>
  137. <dd>the side length of the QR image (modules * scale)</dd>
  138. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  139. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  140. <span>
  141. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  142. </dt>
  143. <dd>the (filled) data matrix object</dd>
  144. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  145. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  146. <span>
  147. &nbsp;: int </span>
  148. </dt>
  149. <dd>the current size of the QR matrix</dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  151. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  152. <span>
  153. &nbsp;: array&lt;string|int, mixed&gt; </span>
  154. </dt>
  155. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  157. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  158. <span>
  159. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  160. </dt>
  161. <dd></dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  163. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  164. <span>
  165. &nbsp;: int </span>
  166. </dt>
  167. <dd>the current scaling for a QR pixel</dd>
  168. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  169. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct">__construct()</a>
  170. <span>
  171. &nbsp;: mixed </span>
  172. </dt>
  173. <dd>QRFpdf constructor.</dd>
  174. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  175. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump">dump()</a>
  176. <span>
  177. &nbsp;: string|<abbr title="\FPDF">FPDF</abbr> </span>
  178. </dt>
  179. <dd></dd>
  180. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  181. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  182. <span>
  183. &nbsp;: bool </span>
  184. </dt>
  185. <dd></dd>
  186. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  187. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  188. <span>
  189. &nbsp;: array&lt;string|int, mixed&gt; </span>
  190. </dt>
  191. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  192. returns an array with the transformed modules</dd>
  193. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  194. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  195. <span>
  196. &nbsp;: mixed|null </span>
  197. </dt>
  198. <dd>Returns a default value for either dark or light modules</dd>
  199. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  200. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  201. <span>
  202. &nbsp;: mixed|null </span>
  203. </dt>
  204. <dd>Returns the prepared value for the given $M_TYPE</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  206. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  207. <span>
  208. &nbsp;: mixed|null </span>
  209. </dt>
  210. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  212. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue">prepareModuleValue()</a>
  213. <span>
  214. &nbsp;: mixed|null </span>
  215. </dt>
  216. <dd>Prepares the value for the given input ()</dd>
  217. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  218. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  219. <span>
  220. &nbsp;: void </span>
  221. </dt>
  222. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  223. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  224. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  225. <span>
  226. &nbsp;: void </span>
  227. </dt>
  228. <dd>Sets/updates the matrix dimensions</dd>
  229. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  230. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  231. <span>
  232. &nbsp;: void </span>
  233. </dt>
  234. <dd>Sets the initial module values</dd>
  235. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  236. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  237. <span>
  238. &nbsp;: string </span>
  239. </dt>
  240. <dd>Returns a base64 data URI for the given string and mime type</dd>
  241. </dl>
  242. <section class="phpdocumentor-properties">
  243. <h3 class="phpdocumentor-elements__header" id="properties">
  244. Properties
  245. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  246. </h3>
  247. <article
  248. class="
  249. phpdocumentor-element
  250. -property
  251. -protected
  252. "
  253. >
  254. <h4 class="phpdocumentor-element__name" id="property_length">
  255. $length
  256. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  257. <span class="phpdocumentor-element__modifiers">
  258. </span>
  259. </h4>
  260. <aside class="phpdocumentor-element-found-in">
  261. <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>
  262. :
  263. <span class="phpdocumentor-element-found-in__line">40</span>
  264. </aside>
  265. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  266. <code class="phpdocumentor-code phpdocumentor-signature ">
  267. <span class="phpdocumentor-signature__visibility">protected</span>
  268. <span class="phpdocumentor-signature__type">int</span>
  269. <span class="phpdocumentor-signature__name">$length</span>
  270. </code>
  271. <section class="phpdocumentor-description"></section>
  272. </article>
  273. <article
  274. class="
  275. phpdocumentor-element
  276. -property
  277. -protected
  278. "
  279. >
  280. <h4 class="phpdocumentor-element__name" id="property_matrix">
  281. $matrix
  282. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  283. <span class="phpdocumentor-element__modifiers">
  284. </span>
  285. </h4>
  286. <aside class="phpdocumentor-element-found-in">
  287. <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>
  288. :
  289. <span class="phpdocumentor-element-found-in__line">50</span>
  290. </aside>
  291. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  292. <code class="phpdocumentor-code phpdocumentor-signature ">
  293. <span class="phpdocumentor-signature__visibility">protected</span>
  294. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  295. <span class="phpdocumentor-signature__name">$matrix</span>
  296. </code>
  297. <section class="phpdocumentor-description"></section>
  298. </article>
  299. <article
  300. class="
  301. phpdocumentor-element
  302. -property
  303. -protected
  304. "
  305. >
  306. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  307. $moduleCount
  308. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  309. <span class="phpdocumentor-element__modifiers">
  310. </span>
  311. </h4>
  312. <aside class="phpdocumentor-element-found-in">
  313. <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>
  314. :
  315. <span class="phpdocumentor-element-found-in__line">28</span>
  316. </aside>
  317. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  318. <code class="phpdocumentor-code phpdocumentor-signature ">
  319. <span class="phpdocumentor-signature__visibility">protected</span>
  320. <span class="phpdocumentor-signature__type">int</span>
  321. <span class="phpdocumentor-signature__name">$moduleCount</span>
  322. </code>
  323. <section class="phpdocumentor-description"></section>
  324. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  325. Tags
  326. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  327. </h5>
  328. <dl class="phpdocumentor-tag-list">
  329. <dt class="phpdocumentor-tag-list__entry">
  330. <span class="phpdocumentor-tag__name">see</span>
  331. </dt>
  332. <dd class="phpdocumentor-tag-list__definition">
  333. <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>
  334. </dd>
  335. </dl>
  336. </article>
  337. <article
  338. class="
  339. phpdocumentor-element
  340. -property
  341. -protected
  342. "
  343. >
  344. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  345. $moduleValues
  346. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  347. <span class="phpdocumentor-element__modifiers">
  348. </span>
  349. </h4>
  350. <aside class="phpdocumentor-element-found-in">
  351. <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>
  352. :
  353. <span class="phpdocumentor-element-found-in__line">45</span>
  354. </aside>
  355. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  356. <code class="phpdocumentor-code phpdocumentor-signature ">
  357. <span class="phpdocumentor-signature__visibility">protected</span>
  358. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  359. <span class="phpdocumentor-signature__name">$moduleValues</span>
  360. </code>
  361. <section class="phpdocumentor-description"></section>
  362. </article>
  363. <article
  364. class="
  365. phpdocumentor-element
  366. -property
  367. -protected
  368. "
  369. >
  370. <h4 class="phpdocumentor-element__name" id="property_options">
  371. $options
  372. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  373. <span class="phpdocumentor-element__modifiers">
  374. </span>
  375. </h4>
  376. <aside class="phpdocumentor-element-found-in">
  377. <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>
  378. :
  379. <span class="phpdocumentor-element-found-in__line">55</span>
  380. </aside>
  381. <code class="phpdocumentor-code phpdocumentor-signature ">
  382. <span class="phpdocumentor-signature__visibility">protected</span>
  383. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  384. <span class="phpdocumentor-signature__name">$options</span>
  385. </code>
  386. </article>
  387. <article
  388. class="
  389. phpdocumentor-element
  390. -property
  391. -protected
  392. "
  393. >
  394. <h4 class="phpdocumentor-element__name" id="property_scale">
  395. $scale
  396. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" 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">35</span>
  404. </aside>
  405. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  406. <code class="phpdocumentor-code phpdocumentor-signature ">
  407. <span class="phpdocumentor-signature__visibility">protected</span>
  408. <span class="phpdocumentor-signature__type">int</span>
  409. <span class="phpdocumentor-signature__name">$scale</span>
  410. </code>
  411. <section class="phpdocumentor-description"></section>
  412. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  413. Tags
  414. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  415. </h5>
  416. <dl class="phpdocumentor-tag-list">
  417. <dt class="phpdocumentor-tag-list__entry">
  418. <span class="phpdocumentor-tag__name">see</span>
  419. </dt>
  420. <dd class="phpdocumentor-tag-list__definition">
  421. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  422. </dd>
  423. </dl>
  424. </article>
  425. </section>
  426. <section class="phpdocumentor-methods">
  427. <h3 class="phpdocumentor-elements__header" id="methods">
  428. Methods
  429. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  430. </h3>
  431. <article
  432. class="phpdocumentor-element
  433. -method
  434. -public
  435. "
  436. >
  437. <h4 class="phpdocumentor-element__name" id="method___construct">
  438. __construct()
  439. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  440. </h4>
  441. <aside class="phpdocumentor-element-found-in">
  442. <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>
  443. :
  444. <span class="phpdocumentor-element-found-in__line">33</span>
  445. </aside>
  446. <p class="phpdocumentor-summary">QRFpdf constructor.</p>
  447. <code class="phpdocumentor-code phpdocumentor-signature ">
  448. <span class="phpdocumentor-signature__visibility">public</span>
  449. <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>
  450. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  451. <dl class="phpdocumentor-argument-list">
  452. <dt class="phpdocumentor-argument-list__entry">
  453. <span class="phpdocumentor-signature__argument__name">$options</span>
  454. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  455. </dt>
  456. <dd class="phpdocumentor-argument-list__definition">
  457. <section class="phpdocumentor-description"></section>
  458. </dd>
  459. <dt class="phpdocumentor-argument-list__entry">
  460. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  461. : <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>
  462. </dt>
  463. <dd class="phpdocumentor-argument-list__definition">
  464. <section class="phpdocumentor-description"></section>
  465. </dd>
  466. </dl>
  467. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  468. Tags
  469. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  470. </h5>
  471. <dl class="phpdocumentor-tag-list">
  472. <dt class="phpdocumentor-tag-list__entry">
  473. <span class="phpdocumentor-tag__name">throws</span>
  474. </dt>
  475. <dd class="phpdocumentor-tag-list__definition">
  476. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  477. </dd>
  478. </dl>
  479. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  480. <span class="phpdocumentor-signature__response_type">mixed</span>
  481. &mdash;
  482. </article>
  483. <article
  484. class="phpdocumentor-element
  485. -method
  486. -public
  487. "
  488. >
  489. <h4 class="phpdocumentor-element__name" id="method_dump">
  490. dump()
  491. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  492. </h4>
  493. <aside class="phpdocumentor-element-found-in">
  494. <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>
  495. :
  496. <span class="phpdocumentor-element-found-in__line">104</span>
  497. </aside>
  498. <code class="phpdocumentor-code phpdocumentor-signature ">
  499. <span class="phpdocumentor-signature__visibility">public</span>
  500. <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>
  501. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  502. <dl class="phpdocumentor-argument-list">
  503. <dt class="phpdocumentor-argument-list__entry">
  504. <span class="phpdocumentor-signature__argument__name">$file</span>
  505. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  506. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  507. <dd class="phpdocumentor-argument-list__definition">
  508. <section class="phpdocumentor-description"></section>
  509. </dd>
  510. </dl>
  511. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  512. Tags
  513. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  514. </h5>
  515. <dl class="phpdocumentor-tag-list">
  516. <dt class="phpdocumentor-tag-list__entry">
  517. <span class="phpdocumentor-tag__name">inheritDoc</span>
  518. </dt>
  519. <dd class="phpdocumentor-tag-list__definition">
  520. </dd>
  521. </dl>
  522. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  523. <span class="phpdocumentor-signature__response_type">string|<abbr title="\FPDF">FPDF</abbr></span>
  524. &mdash;
  525. </article>
  526. <article
  527. class="phpdocumentor-element
  528. -method
  529. -public
  530. -static "
  531. >
  532. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  533. moduleValueIsValid()
  534. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  535. </h4>
  536. <aside class="phpdocumentor-element-found-in">
  537. <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>
  538. :
  539. <span class="phpdocumentor-element-found-in__line">50</span>
  540. </aside>
  541. <code class="phpdocumentor-code phpdocumentor-signature ">
  542. <span class="phpdocumentor-signature__visibility">public</span>
  543. <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>
  544. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  545. <dl class="phpdocumentor-argument-list">
  546. <dt class="phpdocumentor-argument-list__entry">
  547. <span class="phpdocumentor-signature__argument__name">$value</span>
  548. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  549. </dt>
  550. <dd class="phpdocumentor-argument-list__definition">
  551. <section class="phpdocumentor-description"></section>
  552. </dd>
  553. </dl>
  554. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  555. Tags
  556. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  557. </h5>
  558. <dl class="phpdocumentor-tag-list">
  559. <dt class="phpdocumentor-tag-list__entry">
  560. <span class="phpdocumentor-tag__name">inheritDoc</span>
  561. </dt>
  562. <dd class="phpdocumentor-tag-list__definition">
  563. </dd>
  564. </dl>
  565. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  566. <span class="phpdocumentor-signature__response_type">bool</span>
  567. &mdash;
  568. </article>
  569. <article
  570. class="phpdocumentor-element
  571. -method
  572. -protected
  573. "
  574. >
  575. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  576. collectModules()
  577. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  578. </h4>
  579. <aside class="phpdocumentor-element-found-in">
  580. <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>
  581. :
  582. <span class="phpdocumentor-element-found-in__line">176</span>
  583. </aside>
  584. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  585. returns an array with the transformed modules</p>
  586. <code class="phpdocumentor-code phpdocumentor-signature ">
  587. <span class="phpdocumentor-signature__visibility">protected</span>
  588. <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>
  589. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  590. <p>$x - current column
  591. $y - current row
  592. $M_TYPE - field value
  593. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  594. </section>
  595. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  596. <dl class="phpdocumentor-argument-list">
  597. <dt class="phpdocumentor-argument-list__entry">
  598. <span class="phpdocumentor-signature__argument__name">$transform</span>
  599. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  600. </dt>
  601. <dd class="phpdocumentor-argument-list__definition">
  602. <section class="phpdocumentor-description"></section>
  603. </dd>
  604. </dl>
  605. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  606. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  607. &mdash;
  608. </article>
  609. <article
  610. class="phpdocumentor-element
  611. -method
  612. -protected
  613. "
  614. >
  615. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  616. getDefaultModuleValue()
  617. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  618. </h4>
  619. <aside class="phpdocumentor-element-found-in">
  620. <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>
  621. :
  622. <span class="phpdocumentor-element-found-in__line">95</span>
  623. </aside>
  624. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
  625. <code class="phpdocumentor-code phpdocumentor-signature ">
  626. <span class="phpdocumentor-signature__visibility">protected</span>
  627. <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>
  628. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  629. <dl class="phpdocumentor-argument-list">
  630. <dt class="phpdocumentor-argument-list__entry">
  631. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  632. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  633. </dt>
  634. <dd class="phpdocumentor-argument-list__definition">
  635. <section class="phpdocumentor-description"></section>
  636. </dd>
  637. </dl>
  638. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  639. Tags
  640. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  641. </h5>
  642. <dl class="phpdocumentor-tag-list">
  643. <dt class="phpdocumentor-tag-list__entry">
  644. <span class="phpdocumentor-tag__name">inheritDoc</span>
  645. </dt>
  646. <dd class="phpdocumentor-tag-list__definition">
  647. </dd>
  648. </dl>
  649. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  650. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  651. &mdash;
  652. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  653. </section>
  654. </article>
  655. <article
  656. class="phpdocumentor-element
  657. -method
  658. -protected
  659. "
  660. >
  661. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  662. getModuleValue()
  663. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  664. </h4>
  665. <aside class="phpdocumentor-element-found-in">
  666. <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>
  667. :
  668. <span class="phpdocumentor-element-found-in__line">100</span>
  669. </aside>
  670. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  671. <code class="phpdocumentor-code phpdocumentor-signature ">
  672. <span class="phpdocumentor-signature__visibility">protected</span>
  673. <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>
  674. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  675. <dl class="phpdocumentor-argument-list">
  676. <dt class="phpdocumentor-argument-list__entry">
  677. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  678. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  679. </dt>
  680. <dd class="phpdocumentor-argument-list__definition">
  681. <section class="phpdocumentor-description"></section>
  682. </dd>
  683. </dl>
  684. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  685. Tags
  686. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  687. </h5>
  688. <dl class="phpdocumentor-tag-list">
  689. <dt class="phpdocumentor-tag-list__entry">
  690. <span class="phpdocumentor-tag__name">throws</span>
  691. </dt>
  692. <dd class="phpdocumentor-tag-list__definition">
  693. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  694. </dd>
  695. </dl>
  696. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  697. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  698. &mdash;
  699. <section class="phpdocumentor-description"><p>return value depends on the output class, null if $moduleValues[$M_TYPE] doesn't exist</p>
  700. </section>
  701. </article>
  702. <article
  703. class="phpdocumentor-element
  704. -method
  705. -protected
  706. "
  707. >
  708. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  709. getModuleValueAt()
  710. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  714. :
  715. <span class="phpdocumentor-element-found-in__line">115</span>
  716. </aside>
  717. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  718. <code class="phpdocumentor-code phpdocumentor-signature ">
  719. <span class="phpdocumentor-signature__visibility">protected</span>
  720. <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>
  721. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  722. <dl class="phpdocumentor-argument-list">
  723. <dt class="phpdocumentor-argument-list__entry">
  724. <span class="phpdocumentor-signature__argument__name">$x</span>
  725. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  726. </dt>
  727. <dd class="phpdocumentor-argument-list__definition">
  728. <section class="phpdocumentor-description"></section>
  729. </dd>
  730. <dt class="phpdocumentor-argument-list__entry">
  731. <span class="phpdocumentor-signature__argument__name">$y</span>
  732. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  733. </dt>
  734. <dd class="phpdocumentor-argument-list__definition">
  735. <section class="phpdocumentor-description"></section>
  736. </dd>
  737. </dl>
  738. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  739. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  740. &mdash;
  741. </article>
  742. <article
  743. class="phpdocumentor-element
  744. -method
  745. -protected
  746. "
  747. >
  748. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  749. prepareModuleValue()
  750. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  751. </h4>
  752. <aside class="phpdocumentor-element-found-in">
  753. <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>
  754. :
  755. <span class="phpdocumentor-element-found-in__line">77</span>
  756. </aside>
  757. <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
  758. <code class="phpdocumentor-code phpdocumentor-signature ">
  759. <span class="phpdocumentor-signature__visibility">protected</span>
  760. <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>
  761. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  762. <dl class="phpdocumentor-argument-list">
  763. <dt class="phpdocumentor-argument-list__entry">
  764. <span class="phpdocumentor-signature__argument__name">$value</span>
  765. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  766. </dt>
  767. <dd class="phpdocumentor-argument-list__definition">
  768. </dd>
  769. </dl>
  770. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  771. Tags
  772. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  773. </h5>
  774. <dl class="phpdocumentor-tag-list">
  775. <dt class="phpdocumentor-tag-list__entry">
  776. <span class="phpdocumentor-tag__name">inheritDoc</span>
  777. </dt>
  778. <dd class="phpdocumentor-tag-list__definition">
  779. </dd>
  780. </dl>
  781. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  782. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  783. &mdash;
  784. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  785. </section>
  786. </article>
  787. <article
  788. class="phpdocumentor-element
  789. -method
  790. -protected
  791. "
  792. >
  793. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  794. saveToFile()
  795. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  796. </h4>
  797. <aside class="phpdocumentor-element-found-in">
  798. <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>
  799. :
  800. <span class="phpdocumentor-element-found-in__line">150</span>
  801. </aside>
  802. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  803. <code class="phpdocumentor-code phpdocumentor-signature ">
  804. <span class="phpdocumentor-signature__visibility">protected</span>
  805. <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>
  806. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  807. <dl class="phpdocumentor-argument-list">
  808. <dt class="phpdocumentor-argument-list__entry">
  809. <span class="phpdocumentor-signature__argument__name">$data</span>
  810. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  811. </dt>
  812. <dd class="phpdocumentor-argument-list__definition">
  813. <section class="phpdocumentor-description"></section>
  814. </dd>
  815. <dt class="phpdocumentor-argument-list__entry">
  816. <span class="phpdocumentor-signature__argument__name">$file</span>
  817. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  818. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  819. <dd class="phpdocumentor-argument-list__definition">
  820. <section class="phpdocumentor-description"></section>
  821. </dd>
  822. </dl>
  823. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  824. Tags
  825. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  826. </h5>
  827. <dl class="phpdocumentor-tag-list">
  828. <dt class="phpdocumentor-tag-list__entry">
  829. <span class="phpdocumentor-tag__name">see</span>
  830. </dt>
  831. <dd class="phpdocumentor-tag-list__definition">
  832. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  833. </dd>
  834. <dt class="phpdocumentor-tag-list__entry">
  835. <span class="phpdocumentor-tag__name">see</span>
  836. </dt>
  837. <dd class="phpdocumentor-tag-list__definition">
  838. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  839. </dd>
  840. <dt class="phpdocumentor-tag-list__entry">
  841. <span class="phpdocumentor-tag__name">throws</span>
  842. </dt>
  843. <dd class="phpdocumentor-tag-list__definition">
  844. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  845. </dd>
  846. </dl>
  847. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  848. <span class="phpdocumentor-signature__response_type">void</span>
  849. &mdash;
  850. </article>
  851. <article
  852. class="phpdocumentor-element
  853. -method
  854. -protected
  855. "
  856. >
  857. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  858. setMatrixDimensions()
  859. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  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">73</span>
  865. </aside>
  866. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  867. <code class="phpdocumentor-code phpdocumentor-signature ">
  868. <span class="phpdocumentor-signature__visibility">protected</span>
  869. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  870. <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>
  871. </section>
  872. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  873. <span class="phpdocumentor-signature__response_type">void</span>
  874. &mdash;
  875. </article>
  876. <article
  877. class="phpdocumentor-element
  878. -method
  879. -protected
  880. "
  881. >
  882. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  883. setModuleValues()
  884. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  885. </h4>
  886. <aside class="phpdocumentor-element-found-in">
  887. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  888. :
  889. <span class="phpdocumentor-element-found-in__line">82</span>
  890. </aside>
  891. <p class="phpdocumentor-summary">Sets the initial module values</p>
  892. <code class="phpdocumentor-code phpdocumentor-signature ">
  893. <span class="phpdocumentor-signature__visibility">protected</span>
  894. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  895. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  896. <span class="phpdocumentor-signature__response_type">void</span>
  897. &mdash;
  898. </article>
  899. <article
  900. class="phpdocumentor-element
  901. -method
  902. -protected
  903. "
  904. >
  905. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  906. toBase64DataURI()
  907. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  908. </h4>
  909. <aside class="phpdocumentor-element-found-in">
  910. <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>
  911. :
  912. <span class="phpdocumentor-element-found-in__line">138</span>
  913. </aside>
  914. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  915. <code class="phpdocumentor-code phpdocumentor-signature ">
  916. <span class="phpdocumentor-signature__visibility">protected</span>
  917. <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>
  918. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  919. <dl class="phpdocumentor-argument-list">
  920. <dt class="phpdocumentor-argument-list__entry">
  921. <span class="phpdocumentor-signature__argument__name">$data</span>
  922. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  923. </dt>
  924. <dd class="phpdocumentor-argument-list__definition">
  925. <section class="phpdocumentor-description"></section>
  926. </dd>
  927. <dt class="phpdocumentor-argument-list__entry">
  928. <span class="phpdocumentor-signature__argument__name">$mime</span>
  929. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  930. </dt>
  931. <dd class="phpdocumentor-argument-list__definition">
  932. <section class="phpdocumentor-description"></section>
  933. </dd>
  934. </dl>
  935. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  936. <span class="phpdocumentor-signature__response_type">string</span>
  937. &mdash;
  938. </article>
  939. </section>
  940. <script type="text/javascript">
  941. function loadExternalCodeSnippets(line) {
  942. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  943. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  944. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  945. var language = 'php';
  946. var code = document.createElement('code');
  947. code.className = 'language-' + language;
  948. pre.textContent = '';
  949. pre.setAttribute('data-line', line)
  950. code.textContent = 'Loading…';
  951. pre.appendChild(code);
  952. var xhr = new XMLHttpRequest();
  953. xhr.open('GET', src, true);
  954. xhr.onreadystatechange = function () {
  955. if (xhr.readyState == 4) {
  956. if (xhr.status < 400 && xhr.responseText) {
  957. code.textContent = xhr.responseText;
  958. Prism.highlightElement(code);
  959. }
  960. else if (xhr.status >= 400) {
  961. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  962. }
  963. else {
  964. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  965. }
  966. }
  967. };
  968. xhr.send(null);
  969. });
  970. }
  971. var modals = document.querySelectorAll("[data-modal]");
  972. modals.forEach(function (trigger) {
  973. trigger.addEventListener("click", function (event) {
  974. //event.preventDefault();
  975. const modal = document.getElementById(trigger.dataset.modal);
  976. modal.classList.add("phpdocumentor-modal__open");
  977. loadExternalCodeSnippets(trigger.dataset.line)
  978. const exits = modal.querySelectorAll("[data-exit-button]");
  979. exits.forEach(function (exit) {
  980. exit.addEventListener("click", function (event) {
  981. event.preventDefault();
  982. modal.classList.remove("phpdocumentor-modal__open");
  983. });
  984. });
  985. });
  986. });
  987. </script>
  988. </article>
  989. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  990. <section class="phpdocumentor-search-results__dialog">
  991. <header class="phpdocumentor-search-results__header">
  992. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  993. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  994. </header>
  995. <section class="phpdocumentor-search-results__body">
  996. <ul class="phpdocumentor-search-results__entries"></ul>
  997. </section>
  998. </section>
  999. </section>
  1000. </div>
  1001. </div>
  1002. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1003. </main>
  1004. <script>
  1005. cssVars({});
  1006. </script>
  1007. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1008. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1009. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1010. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1011. </body>
  1012. </html>