chillerlan-QRCode-Output-QRFpdf.html 63 KB

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