chillerlan-QRCode-Output-QRFpdf.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974
  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"><a href="namespaces/chillerlan.html">chillerlan</a></h4>
  56. <ul class="phpdocumentor-list">
  57. <li>
  58. <a href="namespaces/chillerlan-qrcode.html">QRCode</a>
  59. </li>
  60. <li>
  61. <a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a>
  62. </li>
  63. </ul>
  64. </section>
  65. <section class="phpdocumentor-sidebar__category">
  66. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  67. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
  68. </section>
  69. <section class="phpdocumentor-sidebar__category">
  70. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  71. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  72. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  73. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  74. </section>
  75. <section class="phpdocumentor-sidebar__category">
  76. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  78. </section>
  79. </aside>
  80. <div class="phpdocumentor-column -eight phpdocumentor-content">
  81. <ul class="phpdocumentor-breadcrumbs">
  82. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  83. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  84. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  85. </ul>
  86. <article class="phpdocumentor-element -class">
  87. <h2 class="phpdocumentor-content__title">
  88. QRFpdf
  89. <span class="phpdocumentor-element__extends">
  90. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  91. </span>
  92. <div class="phpdocumentor-element__package">
  93. in package
  94. <ul class="phpdocumentor-breadcrumbs">
  95. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  96. </ul>
  97. </div>
  98. </h2>
  99. <aside class="phpdocumentor-element-found-in">
  100. <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>
  101. :
  102. <span class="phpdocumentor-element-found-in__line">26</span>
  103. </aside>
  104. <p class="phpdocumentor-summary">QRFpdf output module (requires fpdf)</p>
  105. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  106. Tags
  107. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  108. </h5>
  109. <dl class="phpdocumentor-tag-list">
  110. <dt class="phpdocumentor-tag-list__entry">
  111. <span class="phpdocumentor-tag__name">see</span>
  112. </dt>
  113. <dd class="phpdocumentor-tag-list__definition">
  114. <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>
  115. </dd>
  116. <dt class="phpdocumentor-tag-list__entry">
  117. <span class="phpdocumentor-tag__name">see</span>
  118. </dt>
  119. <dd class="phpdocumentor-tag-list__definition">
  120. <span class="phpdocumentor-tag-link"><a href="http://www.fpdf.org/"><abbr title="http://www.fpdf.org/">http://www.fpdf.org/</abbr></a></span>
  121. </dd>
  122. </dl>
  123. <h3 id="toc">
  124. Table of Contents
  125. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  126. </h3>
  127. <dl class="phpdocumentor-table-of-contents">
  128. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  129. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_defaultMode">$defaultMode</a>
  130. <span>
  131. &nbsp;: string </span>
  132. </dt>
  133. <dd>the default output mode of the current output module</dd>
  134. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  135. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  136. <span>
  137. &nbsp;: int </span>
  138. </dt>
  139. <dd>the side length of the QR image (modules * scale)</dd>
  140. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  141. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  142. <span>
  143. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  144. </dt>
  145. <dd>the (filled) data matrix object</dd>
  146. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  147. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  148. <span>
  149. &nbsp;: int </span>
  150. </dt>
  151. <dd>the current size of the QR matrix</dd>
  152. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  153. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  154. <span>
  155. &nbsp;: array&lt;string|int, mixed&gt; </span>
  156. </dt>
  157. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  158. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  159. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  160. <span>
  161. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  162. </dt>
  163. <dd></dd>
  164. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  165. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_outputMode">$outputMode</a>
  166. <span>
  167. &nbsp;: string </span>
  168. </dt>
  169. <dd>the current output mode</dd>
  170. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  171. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  172. <span>
  173. &nbsp;: int </span>
  174. </dt>
  175. <dd>the current scaling for a QR pixel</dd>
  176. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  177. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct">__construct()</a>
  178. <span>
  179. &nbsp;: mixed </span>
  180. </dt>
  181. <dd>QRFpdf constructor.</dd>
  182. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  183. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump">dump()</a>
  184. <span>
  185. &nbsp;: string|<abbr title="\FPDF">FPDF</abbr> </span>
  186. </dt>
  187. <dd>generates the output, optionally dumps it to a file, and returns it</dd>
  188. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  189. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode">base64encode()</a>
  190. <span>
  191. &nbsp;: string </span>
  192. </dt>
  193. <dd>Returns a base64 data URI for the given string and mime type</dd>
  194. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  195. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  196. <span>
  197. &nbsp;: bool </span>
  198. </dt>
  199. <dd>saves the qr data to a file</dd>
  200. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  201. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_setModuleValues">setModuleValues()</a>
  202. <span>
  203. &nbsp;: void </span>
  204. </dt>
  205. <dd>Sets the initial module values (clean-up &amp; defaults)</dd>
  206. </dl>
  207. <section class="phpdocumentor-properties">
  208. <h3 class="phpdocumentor-elements__header" id="properties">
  209. Properties
  210. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  211. </h3>
  212. <article
  213. class="
  214. phpdocumentor-element
  215. -property
  216. -protected
  217. "
  218. >
  219. <h4 class="phpdocumentor-element__name" id="property_defaultMode">
  220. $defaultMode
  221. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_defaultMode" class="headerlink"><i class="fas fa-link"></i></a>
  222. <span class="phpdocumentor-element__modifiers">
  223. </span>
  224. </h4>
  225. <aside class="phpdocumentor-element-found-in">
  226. <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>
  227. :
  228. <span class="phpdocumentor-element-found-in__line">39</span>
  229. </aside>
  230. <p class="phpdocumentor-summary">the default output mode of the current output module</p>
  231. <code class="phpdocumentor-code phpdocumentor-signature ">
  232. <span class="phpdocumentor-signature__visibility">protected</span>
  233. <span class="phpdocumentor-signature__type">string</span>
  234. <span class="phpdocumentor-signature__name">$defaultMode</span>
  235. </code>
  236. <section class="phpdocumentor-description"></section>
  237. </article>
  238. <article
  239. class="
  240. phpdocumentor-element
  241. -property
  242. -protected
  243. "
  244. >
  245. <h4 class="phpdocumentor-element__name" id="property_length">
  246. $length
  247. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  248. <span class="phpdocumentor-element__modifiers">
  249. </span>
  250. </h4>
  251. <aside class="phpdocumentor-element-found-in">
  252. <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>
  253. :
  254. <span class="phpdocumentor-element-found-in__line">51</span>
  255. </aside>
  256. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  257. <code class="phpdocumentor-code phpdocumentor-signature ">
  258. <span class="phpdocumentor-signature__visibility">protected</span>
  259. <span class="phpdocumentor-signature__type">int</span>
  260. <span class="phpdocumentor-signature__name">$length</span>
  261. </code>
  262. <section class="phpdocumentor-description"></section>
  263. </article>
  264. <article
  265. class="
  266. phpdocumentor-element
  267. -property
  268. -protected
  269. "
  270. >
  271. <h4 class="phpdocumentor-element__name" id="property_matrix">
  272. $matrix
  273. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  274. <span class="phpdocumentor-element__modifiers">
  275. </span>
  276. </h4>
  277. <aside class="phpdocumentor-element-found-in">
  278. <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>
  279. :
  280. <span class="phpdocumentor-element-found-in__line">61</span>
  281. </aside>
  282. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  283. <code class="phpdocumentor-code phpdocumentor-signature ">
  284. <span class="phpdocumentor-signature__visibility">protected</span>
  285. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  286. <span class="phpdocumentor-signature__name">$matrix</span>
  287. </code>
  288. <section class="phpdocumentor-description"></section>
  289. </article>
  290. <article
  291. class="
  292. phpdocumentor-element
  293. -property
  294. -protected
  295. "
  296. >
  297. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  298. $moduleCount
  299. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  300. <span class="phpdocumentor-element__modifiers">
  301. </span>
  302. </h4>
  303. <aside class="phpdocumentor-element-found-in">
  304. <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>
  305. :
  306. <span class="phpdocumentor-element-found-in__line">27</span>
  307. </aside>
  308. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  309. <code class="phpdocumentor-code phpdocumentor-signature ">
  310. <span class="phpdocumentor-signature__visibility">protected</span>
  311. <span class="phpdocumentor-signature__type">int</span>
  312. <span class="phpdocumentor-signature__name">$moduleCount</span>
  313. </code>
  314. <section class="phpdocumentor-description"></section>
  315. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  316. Tags
  317. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  318. </h5>
  319. <dl class="phpdocumentor-tag-list">
  320. <dt class="phpdocumentor-tag-list__entry">
  321. <span class="phpdocumentor-tag__name">see</span>
  322. </dt>
  323. <dd class="phpdocumentor-tag-list__definition">
  324. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size"><abbr title="\chillerlan\QRCode\Data\QRMatrix::size()">QRMatrix::size()</abbr></a></span>
  325. </dd>
  326. </dl>
  327. </article>
  328. <article
  329. class="
  330. phpdocumentor-element
  331. -property
  332. -protected
  333. "
  334. >
  335. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  336. $moduleValues
  337. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  338. <span class="phpdocumentor-element__modifiers">
  339. </span>
  340. </h4>
  341. <aside class="phpdocumentor-element-found-in">
  342. <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>
  343. :
  344. <span class="phpdocumentor-element-found-in__line">56</span>
  345. </aside>
  346. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  347. <code class="phpdocumentor-code phpdocumentor-signature ">
  348. <span class="phpdocumentor-signature__visibility">protected</span>
  349. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  350. <span class="phpdocumentor-signature__name">$moduleValues</span>
  351. </code>
  352. <section class="phpdocumentor-description"></section>
  353. </article>
  354. <article
  355. class="
  356. phpdocumentor-element
  357. -property
  358. -protected
  359. "
  360. >
  361. <h4 class="phpdocumentor-element__name" id="property_options">
  362. $options
  363. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  364. <span class="phpdocumentor-element__modifiers">
  365. </span>
  366. </h4>
  367. <aside class="phpdocumentor-element-found-in">
  368. <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>
  369. :
  370. <span class="phpdocumentor-element-found-in__line">66</span>
  371. </aside>
  372. <code class="phpdocumentor-code phpdocumentor-signature ">
  373. <span class="phpdocumentor-signature__visibility">protected</span>
  374. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  375. <span class="phpdocumentor-signature__name">$options</span>
  376. </code>
  377. </article>
  378. <article
  379. class="
  380. phpdocumentor-element
  381. -property
  382. -protected
  383. "
  384. >
  385. <h4 class="phpdocumentor-element__name" id="property_outputMode">
  386. $outputMode
  387. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_outputMode" class="headerlink"><i class="fas fa-link"></i></a>
  388. <span class="phpdocumentor-element__modifiers">
  389. </span>
  390. </h4>
  391. <aside class="phpdocumentor-element-found-in">
  392. <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>
  393. :
  394. <span class="phpdocumentor-element-found-in__line">34</span>
  395. </aside>
  396. <p class="phpdocumentor-summary">the current output mode</p>
  397. <code class="phpdocumentor-code phpdocumentor-signature ">
  398. <span class="phpdocumentor-signature__visibility">protected</span>
  399. <span class="phpdocumentor-signature__type">string</span>
  400. <span class="phpdocumentor-signature__name">$outputMode</span>
  401. </code>
  402. <section class="phpdocumentor-description"></section>
  403. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  404. Tags
  405. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  406. </h5>
  407. <dl class="phpdocumentor-tag-list">
  408. <dt class="phpdocumentor-tag-list__entry">
  409. <span class="phpdocumentor-tag__name">see</span>
  410. </dt>
  411. <dd class="phpdocumentor-tag-list__definition">
  412. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$outputType">QROptions::$outputType</abbr></span>
  413. </dd>
  414. </dl>
  415. </article>
  416. <article
  417. class="
  418. phpdocumentor-element
  419. -property
  420. -protected
  421. "
  422. >
  423. <h4 class="phpdocumentor-element__name" id="property_scale">
  424. $scale
  425. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  426. <span class="phpdocumentor-element__modifiers">
  427. </span>
  428. </h4>
  429. <aside class="phpdocumentor-element-found-in">
  430. <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>
  431. :
  432. <span class="phpdocumentor-element-found-in__line">46</span>
  433. </aside>
  434. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  435. <code class="phpdocumentor-code phpdocumentor-signature ">
  436. <span class="phpdocumentor-signature__visibility">protected</span>
  437. <span class="phpdocumentor-signature__type">int</span>
  438. <span class="phpdocumentor-signature__name">$scale</span>
  439. </code>
  440. <section class="phpdocumentor-description"></section>
  441. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  442. Tags
  443. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  444. </h5>
  445. <dl class="phpdocumentor-tag-list">
  446. <dt class="phpdocumentor-tag-list__entry">
  447. <span class="phpdocumentor-tag__name">see</span>
  448. </dt>
  449. <dd class="phpdocumentor-tag-list__definition">
  450. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  451. </dd>
  452. </dl>
  453. </article>
  454. </section>
  455. <section class="phpdocumentor-methods">
  456. <h3 class="phpdocumentor-elements__header" id="methods">
  457. Methods
  458. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  459. </h3>
  460. <article
  461. class="phpdocumentor-element
  462. -method
  463. -public
  464. "
  465. >
  466. <h4 class="phpdocumentor-element__name" id="method___construct">
  467. __construct()
  468. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  469. </h4>
  470. <aside class="phpdocumentor-element-found-in">
  471. <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>
  472. :
  473. <span class="phpdocumentor-element-found-in__line">33</span>
  474. </aside>
  475. <p class="phpdocumentor-summary">QRFpdf constructor.</p>
  476. <code class="phpdocumentor-code phpdocumentor-signature ">
  477. <span class="phpdocumentor-signature__visibility">public</span>
  478. <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>
  479. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  480. <dl class="phpdocumentor-argument-list">
  481. <dt class="phpdocumentor-argument-list__entry">
  482. <span class="phpdocumentor-signature__argument__name">$options</span>
  483. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  484. </dt>
  485. <dd class="phpdocumentor-argument-list__definition">
  486. <section class="phpdocumentor-description"></section>
  487. </dd>
  488. <dt class="phpdocumentor-argument-list__entry">
  489. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  490. : <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>
  491. </dt>
  492. <dd class="phpdocumentor-argument-list__definition">
  493. <section class="phpdocumentor-description"></section>
  494. </dd>
  495. </dl>
  496. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  497. Tags
  498. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  499. </h5>
  500. <dl class="phpdocumentor-tag-list">
  501. <dt class="phpdocumentor-tag-list__entry">
  502. <span class="phpdocumentor-tag__name">throws</span>
  503. </dt>
  504. <dd class="phpdocumentor-tag-list__definition">
  505. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  506. </dd>
  507. </dl>
  508. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  509. <span class="phpdocumentor-signature__response_type">mixed</span>
  510. &mdash;
  511. </article>
  512. <article
  513. class="phpdocumentor-element
  514. -method
  515. -public
  516. "
  517. >
  518. <h4 class="phpdocumentor-element__name" id="method_dump">
  519. dump()
  520. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  521. </h4>
  522. <aside class="phpdocumentor-element-found-in">
  523. <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>
  524. :
  525. <span class="phpdocumentor-element-found-in__line">73</span>
  526. </aside>
  527. <p class="phpdocumentor-summary">generates the output, optionally dumps it to a file, and returns it</p>
  528. <code class="phpdocumentor-code phpdocumentor-signature ">
  529. <span class="phpdocumentor-signature__visibility">public</span>
  530. <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>
  531. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  532. <dl class="phpdocumentor-argument-list">
  533. <dt class="phpdocumentor-argument-list__entry">
  534. <span class="phpdocumentor-signature__argument__name">$file</span>
  535. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  536. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  537. <dd class="phpdocumentor-argument-list__definition">
  538. <section class="phpdocumentor-description"></section>
  539. </dd>
  540. </dl>
  541. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  542. Tags
  543. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  544. </h5>
  545. <dl class="phpdocumentor-tag-list">
  546. <dt class="phpdocumentor-tag-list__entry">
  547. <span class="phpdocumentor-tag__name">inheritDoc</span>
  548. </dt>
  549. <dd class="phpdocumentor-tag-list__definition">
  550. </dd>
  551. </dl>
  552. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  553. <span class="phpdocumentor-signature__response_type">string|<abbr title="\FPDF">FPDF</abbr></span>
  554. &mdash;
  555. </article>
  556. <article
  557. class="phpdocumentor-element
  558. -method
  559. -protected
  560. "
  561. >
  562. <h4 class="phpdocumentor-element__name" id="method_base64encode">
  563. base64encode()
  564. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode" class="headerlink"><i class="fas fa-link"></i></a>
  565. </h4>
  566. <aside class="phpdocumentor-element-found-in">
  567. <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>
  568. :
  569. <span class="phpdocumentor-element-found-in__line">95</span>
  570. </aside>
  571. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  572. <code class="phpdocumentor-code phpdocumentor-signature ">
  573. <span class="phpdocumentor-signature__visibility">protected</span>
  574. <span class="phpdocumentor-signature__name">base64encode</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>
  575. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  576. <dl class="phpdocumentor-argument-list">
  577. <dt class="phpdocumentor-argument-list__entry">
  578. <span class="phpdocumentor-signature__argument__name">$data</span>
  579. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  580. </dt>
  581. <dd class="phpdocumentor-argument-list__definition">
  582. <section class="phpdocumentor-description"></section>
  583. </dd>
  584. <dt class="phpdocumentor-argument-list__entry">
  585. <span class="phpdocumentor-signature__argument__name">$mime</span>
  586. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  587. </dt>
  588. <dd class="phpdocumentor-argument-list__definition">
  589. <section class="phpdocumentor-description"></section>
  590. </dd>
  591. </dl>
  592. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  593. <span class="phpdocumentor-signature__response_type">string</span>
  594. &mdash;
  595. </article>
  596. <article
  597. class="phpdocumentor-element
  598. -method
  599. -protected
  600. "
  601. >
  602. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  603. saveToFile()
  604. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  605. </h4>
  606. <aside class="phpdocumentor-element-found-in">
  607. <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>
  608. :
  609. <span class="phpdocumentor-element-found-in__line">107</span>
  610. </aside>
  611. <p class="phpdocumentor-summary">saves the qr data to a file</p>
  612. <code class="phpdocumentor-code phpdocumentor-signature ">
  613. <span class="phpdocumentor-signature__visibility">protected</span>
  614. <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 class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  615. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  616. <dl class="phpdocumentor-argument-list">
  617. <dt class="phpdocumentor-argument-list__entry">
  618. <span class="phpdocumentor-signature__argument__name">$data</span>
  619. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  620. </dt>
  621. <dd class="phpdocumentor-argument-list__definition">
  622. <section class="phpdocumentor-description"></section>
  623. </dd>
  624. <dt class="phpdocumentor-argument-list__entry">
  625. <span class="phpdocumentor-signature__argument__name">$file</span>
  626. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  627. </dt>
  628. <dd class="phpdocumentor-argument-list__definition">
  629. <section class="phpdocumentor-description"></section>
  630. </dd>
  631. </dl>
  632. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  633. Tags
  634. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  635. </h5>
  636. <dl class="phpdocumentor-tag-list">
  637. <dt class="phpdocumentor-tag-list__entry">
  638. <span class="phpdocumentor-tag__name">see</span>
  639. </dt>
  640. <dd class="phpdocumentor-tag-list__definition">
  641. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  642. </dd>
  643. <dt class="phpdocumentor-tag-list__entry">
  644. <span class="phpdocumentor-tag__name">see</span>
  645. </dt>
  646. <dd class="phpdocumentor-tag-list__definition">
  647. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::cachefile">QROptions::cachefile</abbr></span>
  648. </dd>
  649. <dt class="phpdocumentor-tag-list__entry">
  650. <span class="phpdocumentor-tag__name">throws</span>
  651. </dt>
  652. <dd class="phpdocumentor-tag-list__definition">
  653. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  654. </dd>
  655. </dl>
  656. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  657. <span class="phpdocumentor-signature__response_type">bool</span>
  658. &mdash;
  659. </article>
  660. <article
  661. class="phpdocumentor-element
  662. -method
  663. -protected
  664. "
  665. >
  666. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  667. setModuleValues()
  668. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  669. </h4>
  670. <aside class="phpdocumentor-element-found-in">
  671. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRFpdf.php"><a href="files/src-output-qrfpdf.html"><abbr title="src/Output/QRFpdf.php">QRFpdf.php</abbr></a></abbr>
  672. :
  673. <span class="phpdocumentor-element-found-in__line">50</span>
  674. </aside>
  675. <p class="phpdocumentor-summary">Sets the initial module values (clean-up &amp; defaults)</p>
  676. <code class="phpdocumentor-code phpdocumentor-signature ">
  677. <span class="phpdocumentor-signature__visibility">protected</span>
  678. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  679. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  680. Tags
  681. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  682. </h5>
  683. <dl class="phpdocumentor-tag-list">
  684. <dt class="phpdocumentor-tag-list__entry">
  685. <span class="phpdocumentor-tag__name">inheritDoc</span>
  686. </dt>
  687. <dd class="phpdocumentor-tag-list__definition">
  688. </dd>
  689. </dl>
  690. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  691. <span class="phpdocumentor-signature__response_type">void</span>
  692. &mdash;
  693. </article>
  694. </section>
  695. <script type="text/javascript">
  696. function loadExternalCodeSnippets(line) {
  697. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  698. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  699. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  700. var language = 'php';
  701. var code = document.createElement('code');
  702. code.className = 'language-' + language;
  703. pre.textContent = '';
  704. pre.setAttribute('data-line', line)
  705. code.textContent = 'Loading…';
  706. pre.appendChild(code);
  707. var xhr = new XMLHttpRequest();
  708. xhr.open('GET', src, true);
  709. xhr.onreadystatechange = function () {
  710. if (xhr.readyState == 4) {
  711. if (xhr.status < 400 && xhr.responseText) {
  712. code.textContent = xhr.responseText;
  713. Prism.highlightElement(code);
  714. }
  715. else if (xhr.status >= 400) {
  716. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  717. }
  718. else {
  719. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  720. }
  721. }
  722. };
  723. xhr.send(null);
  724. });
  725. }
  726. var modals = document.querySelectorAll("[data-modal]");
  727. modals.forEach(function (trigger) {
  728. trigger.addEventListener("click", function (event) {
  729. //event.preventDefault();
  730. const modal = document.getElementById(trigger.dataset.modal);
  731. modal.classList.add("phpdocumentor-modal__open");
  732. loadExternalCodeSnippets(trigger.dataset.line)
  733. const exits = modal.querySelectorAll("[data-exit-button]");
  734. exits.forEach(function (exit) {
  735. exit.addEventListener("click", function (event) {
  736. event.preventDefault();
  737. modal.classList.remove("phpdocumentor-modal__open");
  738. });
  739. });
  740. });
  741. });
  742. </script>
  743. </article>
  744. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  745. <section class="phpdocumentor-search-results__dialog">
  746. <header class="phpdocumentor-search-results__header">
  747. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  748. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  749. </header>
  750. <section class="phpdocumentor-search-results__body">
  751. <ul class="phpdocumentor-search-results__entries"></ul>
  752. </section>
  753. </section>
  754. </section>
  755. </div>
  756. </div>
  757. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  758. </main>
  759. <script>
  760. cssVars({});
  761. </script>
  762. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  763. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  764. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  765. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  766. </body>
  767. </html>