chillerlan-QRCode-Output-QRFpdf.html 54 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151
  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-QRFpdf.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  196. <span>
  197. &nbsp;: mixed </span>
  198. </dt>
  199. <dd>Returns a defualt value for either dark or light modules (return value depends on the output module)</dd>
  200. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  201. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getModuleValue">getModuleValue()</a>
  202. <span>
  203. &nbsp;: mixed </span>
  204. </dt>
  205. <dd>Returns the final value for the given input (return value depends on the output module)</dd>
  206. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  207. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  208. <span>
  209. &nbsp;: bool </span>
  210. </dt>
  211. <dd>Determines whether the given value is valid</dd>
  212. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  213. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  214. <span>
  215. &nbsp;: bool </span>
  216. </dt>
  217. <dd>saves the qr data to a file</dd>
  218. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  219. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  220. <span>
  221. &nbsp;: void </span>
  222. </dt>
  223. <dd>Sets the initial module values</dd>
  224. </dl>
  225. <section class="phpdocumentor-properties">
  226. <h3 class="phpdocumentor-elements__header" id="properties">
  227. Properties
  228. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  229. </h3>
  230. <article
  231. class="
  232. phpdocumentor-element
  233. -property
  234. -protected
  235. "
  236. >
  237. <h4 class="phpdocumentor-element__name" id="property_defaultMode">
  238. $defaultMode
  239. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_defaultMode" class="headerlink"><i class="fas fa-link"></i></a>
  240. <span class="phpdocumentor-element__modifiers">
  241. </span>
  242. </h4>
  243. <aside class="phpdocumentor-element-found-in">
  244. <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>
  245. :
  246. <span class="phpdocumentor-element-found-in__line">39</span>
  247. </aside>
  248. <p class="phpdocumentor-summary">the default output mode of the current output module</p>
  249. <code class="phpdocumentor-code phpdocumentor-signature ">
  250. <span class="phpdocumentor-signature__visibility">protected</span>
  251. <span class="phpdocumentor-signature__type">string</span>
  252. <span class="phpdocumentor-signature__name">$defaultMode</span>
  253. </code>
  254. <section class="phpdocumentor-description"></section>
  255. </article>
  256. <article
  257. class="
  258. phpdocumentor-element
  259. -property
  260. -protected
  261. "
  262. >
  263. <h4 class="phpdocumentor-element__name" id="property_length">
  264. $length
  265. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  266. <span class="phpdocumentor-element__modifiers">
  267. </span>
  268. </h4>
  269. <aside class="phpdocumentor-element-found-in">
  270. <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>
  271. :
  272. <span class="phpdocumentor-element-found-in__line">51</span>
  273. </aside>
  274. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  275. <code class="phpdocumentor-code phpdocumentor-signature ">
  276. <span class="phpdocumentor-signature__visibility">protected</span>
  277. <span class="phpdocumentor-signature__type">int</span>
  278. <span class="phpdocumentor-signature__name">$length</span>
  279. </code>
  280. <section class="phpdocumentor-description"></section>
  281. </article>
  282. <article
  283. class="
  284. phpdocumentor-element
  285. -property
  286. -protected
  287. "
  288. >
  289. <h4 class="phpdocumentor-element__name" id="property_matrix">
  290. $matrix
  291. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  292. <span class="phpdocumentor-element__modifiers">
  293. </span>
  294. </h4>
  295. <aside class="phpdocumentor-element-found-in">
  296. <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>
  297. :
  298. <span class="phpdocumentor-element-found-in__line">61</span>
  299. </aside>
  300. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  301. <code class="phpdocumentor-code phpdocumentor-signature ">
  302. <span class="phpdocumentor-signature__visibility">protected</span>
  303. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  304. <span class="phpdocumentor-signature__name">$matrix</span>
  305. </code>
  306. <section class="phpdocumentor-description"></section>
  307. </article>
  308. <article
  309. class="
  310. phpdocumentor-element
  311. -property
  312. -protected
  313. "
  314. >
  315. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  316. $moduleCount
  317. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  318. <span class="phpdocumentor-element__modifiers">
  319. </span>
  320. </h4>
  321. <aside class="phpdocumentor-element-found-in">
  322. <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>
  323. :
  324. <span class="phpdocumentor-element-found-in__line">27</span>
  325. </aside>
  326. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  327. <code class="phpdocumentor-code phpdocumentor-signature ">
  328. <span class="phpdocumentor-signature__visibility">protected</span>
  329. <span class="phpdocumentor-signature__type">int</span>
  330. <span class="phpdocumentor-signature__name">$moduleCount</span>
  331. </code>
  332. <section class="phpdocumentor-description"></section>
  333. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  334. Tags
  335. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  336. </h5>
  337. <dl class="phpdocumentor-tag-list">
  338. <dt class="phpdocumentor-tag-list__entry">
  339. <span class="phpdocumentor-tag__name">see</span>
  340. </dt>
  341. <dd class="phpdocumentor-tag-list__definition">
  342. <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>
  343. </dd>
  344. </dl>
  345. </article>
  346. <article
  347. class="
  348. phpdocumentor-element
  349. -property
  350. -protected
  351. "
  352. >
  353. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  354. $moduleValues
  355. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  356. <span class="phpdocumentor-element__modifiers">
  357. </span>
  358. </h4>
  359. <aside class="phpdocumentor-element-found-in">
  360. <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>
  361. :
  362. <span class="phpdocumentor-element-found-in__line">56</span>
  363. </aside>
  364. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  365. <code class="phpdocumentor-code phpdocumentor-signature ">
  366. <span class="phpdocumentor-signature__visibility">protected</span>
  367. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  368. <span class="phpdocumentor-signature__name">$moduleValues</span>
  369. </code>
  370. <section class="phpdocumentor-description"></section>
  371. </article>
  372. <article
  373. class="
  374. phpdocumentor-element
  375. -property
  376. -protected
  377. "
  378. >
  379. <h4 class="phpdocumentor-element__name" id="property_options">
  380. $options
  381. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  382. <span class="phpdocumentor-element__modifiers">
  383. </span>
  384. </h4>
  385. <aside class="phpdocumentor-element-found-in">
  386. <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>
  387. :
  388. <span class="phpdocumentor-element-found-in__line">66</span>
  389. </aside>
  390. <code class="phpdocumentor-code phpdocumentor-signature ">
  391. <span class="phpdocumentor-signature__visibility">protected</span>
  392. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  393. <span class="phpdocumentor-signature__name">$options</span>
  394. </code>
  395. </article>
  396. <article
  397. class="
  398. phpdocumentor-element
  399. -property
  400. -protected
  401. "
  402. >
  403. <h4 class="phpdocumentor-element__name" id="property_outputMode">
  404. $outputMode
  405. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_outputMode" class="headerlink"><i class="fas fa-link"></i></a>
  406. <span class="phpdocumentor-element__modifiers">
  407. </span>
  408. </h4>
  409. <aside class="phpdocumentor-element-found-in">
  410. <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>
  411. :
  412. <span class="phpdocumentor-element-found-in__line">34</span>
  413. </aside>
  414. <p class="phpdocumentor-summary">the current output mode</p>
  415. <code class="phpdocumentor-code phpdocumentor-signature ">
  416. <span class="phpdocumentor-signature__visibility">protected</span>
  417. <span class="phpdocumentor-signature__type">string</span>
  418. <span class="phpdocumentor-signature__name">$outputMode</span>
  419. </code>
  420. <section class="phpdocumentor-description"></section>
  421. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  422. Tags
  423. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  424. </h5>
  425. <dl class="phpdocumentor-tag-list">
  426. <dt class="phpdocumentor-tag-list__entry">
  427. <span class="phpdocumentor-tag__name">see</span>
  428. </dt>
  429. <dd class="phpdocumentor-tag-list__definition">
  430. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$outputType">QROptions::$outputType</abbr></span>
  431. </dd>
  432. </dl>
  433. </article>
  434. <article
  435. class="
  436. phpdocumentor-element
  437. -property
  438. -protected
  439. "
  440. >
  441. <h4 class="phpdocumentor-element__name" id="property_scale">
  442. $scale
  443. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  444. <span class="phpdocumentor-element__modifiers">
  445. </span>
  446. </h4>
  447. <aside class="phpdocumentor-element-found-in">
  448. <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>
  449. :
  450. <span class="phpdocumentor-element-found-in__line">46</span>
  451. </aside>
  452. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  453. <code class="phpdocumentor-code phpdocumentor-signature ">
  454. <span class="phpdocumentor-signature__visibility">protected</span>
  455. <span class="phpdocumentor-signature__type">int</span>
  456. <span class="phpdocumentor-signature__name">$scale</span>
  457. </code>
  458. <section class="phpdocumentor-description"></section>
  459. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  460. Tags
  461. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  462. </h5>
  463. <dl class="phpdocumentor-tag-list">
  464. <dt class="phpdocumentor-tag-list__entry">
  465. <span class="phpdocumentor-tag__name">see</span>
  466. </dt>
  467. <dd class="phpdocumentor-tag-list__definition">
  468. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  469. </dd>
  470. </dl>
  471. </article>
  472. </section>
  473. <section class="phpdocumentor-methods">
  474. <h3 class="phpdocumentor-elements__header" id="methods">
  475. Methods
  476. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  477. </h3>
  478. <article
  479. class="phpdocumentor-element
  480. -method
  481. -public
  482. "
  483. >
  484. <h4 class="phpdocumentor-element__name" id="method___construct">
  485. __construct()
  486. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  487. </h4>
  488. <aside class="phpdocumentor-element-found-in">
  489. <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>
  490. :
  491. <span class="phpdocumentor-element-found-in__line">33</span>
  492. </aside>
  493. <p class="phpdocumentor-summary">QRFpdf constructor.</p>
  494. <code class="phpdocumentor-code phpdocumentor-signature ">
  495. <span class="phpdocumentor-signature__visibility">public</span>
  496. <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>
  497. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  498. <dl class="phpdocumentor-argument-list">
  499. <dt class="phpdocumentor-argument-list__entry">
  500. <span class="phpdocumentor-signature__argument__name">$options</span>
  501. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  502. </dt>
  503. <dd class="phpdocumentor-argument-list__definition">
  504. <section class="phpdocumentor-description"></section>
  505. </dd>
  506. <dt class="phpdocumentor-argument-list__entry">
  507. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  508. : <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>
  509. </dt>
  510. <dd class="phpdocumentor-argument-list__definition">
  511. <section class="phpdocumentor-description"></section>
  512. </dd>
  513. </dl>
  514. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  515. Tags
  516. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  517. </h5>
  518. <dl class="phpdocumentor-tag-list">
  519. <dt class="phpdocumentor-tag-list__entry">
  520. <span class="phpdocumentor-tag__name">throws</span>
  521. </dt>
  522. <dd class="phpdocumentor-tag-list__definition">
  523. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  524. </dd>
  525. </dl>
  526. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  527. <span class="phpdocumentor-signature__response_type">mixed</span>
  528. &mdash;
  529. </article>
  530. <article
  531. class="phpdocumentor-element
  532. -method
  533. -public
  534. "
  535. >
  536. <h4 class="phpdocumentor-element__name" id="method_dump">
  537. dump()
  538. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  539. </h4>
  540. <aside class="phpdocumentor-element-found-in">
  541. <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>
  542. :
  543. <span class="phpdocumentor-element-found-in__line">73</span>
  544. </aside>
  545. <p class="phpdocumentor-summary">generates the output, optionally dumps it to a file, and returns it</p>
  546. <code class="phpdocumentor-code phpdocumentor-signature ">
  547. <span class="phpdocumentor-signature__visibility">public</span>
  548. <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>
  549. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  550. <dl class="phpdocumentor-argument-list">
  551. <dt class="phpdocumentor-argument-list__entry">
  552. <span class="phpdocumentor-signature__argument__name">$file</span>
  553. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  554. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  555. <dd class="phpdocumentor-argument-list__definition">
  556. <section class="phpdocumentor-description"></section>
  557. </dd>
  558. </dl>
  559. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  560. Tags
  561. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  562. </h5>
  563. <dl class="phpdocumentor-tag-list">
  564. <dt class="phpdocumentor-tag-list__entry">
  565. <span class="phpdocumentor-tag__name">inheritDoc</span>
  566. </dt>
  567. <dd class="phpdocumentor-tag-list__definition">
  568. </dd>
  569. </dl>
  570. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  571. <span class="phpdocumentor-signature__response_type">string|<abbr title="\FPDF">FPDF</abbr></span>
  572. &mdash;
  573. </article>
  574. <article
  575. class="phpdocumentor-element
  576. -method
  577. -protected
  578. "
  579. >
  580. <h4 class="phpdocumentor-element__name" id="method_base64encode">
  581. base64encode()
  582. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode" class="headerlink"><i class="fas fa-link"></i></a>
  583. </h4>
  584. <aside class="phpdocumentor-element-found-in">
  585. <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>
  586. :
  587. <span class="phpdocumentor-element-found-in__line">127</span>
  588. </aside>
  589. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  590. <code class="phpdocumentor-code phpdocumentor-signature ">
  591. <span class="phpdocumentor-signature__visibility">protected</span>
  592. <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>
  593. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  594. <dl class="phpdocumentor-argument-list">
  595. <dt class="phpdocumentor-argument-list__entry">
  596. <span class="phpdocumentor-signature__argument__name">$data</span>
  597. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  598. </dt>
  599. <dd class="phpdocumentor-argument-list__definition">
  600. <section class="phpdocumentor-description"></section>
  601. </dd>
  602. <dt class="phpdocumentor-argument-list__entry">
  603. <span class="phpdocumentor-signature__argument__name">$mime</span>
  604. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  605. </dt>
  606. <dd class="phpdocumentor-argument-list__definition">
  607. <section class="phpdocumentor-description"></section>
  608. </dd>
  609. </dl>
  610. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  611. <span class="phpdocumentor-signature__response_type">string</span>
  612. &mdash;
  613. </article>
  614. <article
  615. class="phpdocumentor-element
  616. -method
  617. -protected
  618. "
  619. >
  620. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  621. getDefaultModuleValue()
  622. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  623. </h4>
  624. <aside class="phpdocumentor-element-found-in">
  625. <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>
  626. :
  627. <span class="phpdocumentor-element-found-in__line">64</span>
  628. </aside>
  629. <p class="phpdocumentor-summary">Returns a defualt value for either dark or light modules (return value depends on the output module)</p>
  630. <code class="phpdocumentor-code phpdocumentor-signature ">
  631. <span class="phpdocumentor-signature__visibility">protected</span>
  632. <span class="phpdocumentor-signature__name">getDefaultModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$isDark</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  633. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  634. <dl class="phpdocumentor-argument-list">
  635. <dt class="phpdocumentor-argument-list__entry">
  636. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  637. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  638. </dt>
  639. <dd class="phpdocumentor-argument-list__definition">
  640. <section class="phpdocumentor-description"></section>
  641. </dd>
  642. </dl>
  643. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  644. Tags
  645. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  646. </h5>
  647. <dl class="phpdocumentor-tag-list">
  648. <dt class="phpdocumentor-tag-list__entry">
  649. <span class="phpdocumentor-tag__name">inheritDoc</span>
  650. </dt>
  651. <dd class="phpdocumentor-tag-list__definition">
  652. </dd>
  653. </dl>
  654. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  655. <span class="phpdocumentor-signature__response_type">mixed</span>
  656. &mdash;
  657. </article>
  658. <article
  659. class="phpdocumentor-element
  660. -method
  661. -protected
  662. "
  663. >
  664. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  665. getModuleValue()
  666. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  667. </h4>
  668. <aside class="phpdocumentor-element-found-in">
  669. <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>
  670. :
  671. <span class="phpdocumentor-element-found-in__line">57</span>
  672. </aside>
  673. <p class="phpdocumentor-summary">Returns the final value for the given input (return value depends on the output module)</p>
  674. <code class="phpdocumentor-code phpdocumentor-signature ">
  675. <span class="phpdocumentor-signature__visibility">protected</span>
  676. <span class="phpdocumentor-signature__name">getModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  677. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  678. <dl class="phpdocumentor-argument-list">
  679. <dt class="phpdocumentor-argument-list__entry">
  680. <span class="phpdocumentor-signature__argument__name">$value</span>
  681. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  682. </dt>
  683. <dd class="phpdocumentor-argument-list__definition">
  684. </dd>
  685. </dl>
  686. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  687. Tags
  688. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  689. </h5>
  690. <dl class="phpdocumentor-tag-list">
  691. <dt class="phpdocumentor-tag-list__entry">
  692. <span class="phpdocumentor-tag__name">inheritDoc</span>
  693. </dt>
  694. <dd class="phpdocumentor-tag-list__definition">
  695. </dd>
  696. </dl>
  697. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  698. <span class="phpdocumentor-signature__response_type">mixed</span>
  699. &mdash;
  700. </article>
  701. <article
  702. class="phpdocumentor-element
  703. -method
  704. -protected
  705. "
  706. >
  707. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  708. moduleValueIsValid()
  709. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  710. </h4>
  711. <aside class="phpdocumentor-element-found-in">
  712. <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>
  713. :
  714. <span class="phpdocumentor-element-found-in__line">50</span>
  715. </aside>
  716. <p class="phpdocumentor-summary">Determines whether the given value is valid</p>
  717. <code class="phpdocumentor-code phpdocumentor-signature ">
  718. <span class="phpdocumentor-signature__visibility">protected</span>
  719. <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>
  720. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  721. <dl class="phpdocumentor-argument-list">
  722. <dt class="phpdocumentor-argument-list__entry">
  723. <span class="phpdocumentor-signature__argument__name">$value</span>
  724. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  725. </dt>
  726. <dd class="phpdocumentor-argument-list__definition">
  727. </dd>
  728. </dl>
  729. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  730. Tags
  731. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  732. </h5>
  733. <dl class="phpdocumentor-tag-list">
  734. <dt class="phpdocumentor-tag-list__entry">
  735. <span class="phpdocumentor-tag__name">inheritDoc</span>
  736. </dt>
  737. <dd class="phpdocumentor-tag-list__definition">
  738. </dd>
  739. </dl>
  740. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  741. <span class="phpdocumentor-signature__response_type">bool</span>
  742. &mdash;
  743. </article>
  744. <article
  745. class="phpdocumentor-element
  746. -method
  747. -protected
  748. "
  749. >
  750. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  751. saveToFile()
  752. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  753. </h4>
  754. <aside class="phpdocumentor-element-found-in">
  755. <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>
  756. :
  757. <span class="phpdocumentor-element-found-in__line">139</span>
  758. </aside>
  759. <p class="phpdocumentor-summary">saves the qr data to a file</p>
  760. <code class="phpdocumentor-code phpdocumentor-signature ">
  761. <span class="phpdocumentor-signature__visibility">protected</span>
  762. <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>
  763. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  764. <dl class="phpdocumentor-argument-list">
  765. <dt class="phpdocumentor-argument-list__entry">
  766. <span class="phpdocumentor-signature__argument__name">$data</span>
  767. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  768. </dt>
  769. <dd class="phpdocumentor-argument-list__definition">
  770. <section class="phpdocumentor-description"></section>
  771. </dd>
  772. <dt class="phpdocumentor-argument-list__entry">
  773. <span class="phpdocumentor-signature__argument__name">$file</span>
  774. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  775. </dt>
  776. <dd class="phpdocumentor-argument-list__definition">
  777. <section class="phpdocumentor-description"></section>
  778. </dd>
  779. </dl>
  780. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  781. Tags
  782. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  783. </h5>
  784. <dl class="phpdocumentor-tag-list">
  785. <dt class="phpdocumentor-tag-list__entry">
  786. <span class="phpdocumentor-tag__name">see</span>
  787. </dt>
  788. <dd class="phpdocumentor-tag-list__definition">
  789. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  790. </dd>
  791. <dt class="phpdocumentor-tag-list__entry">
  792. <span class="phpdocumentor-tag__name">see</span>
  793. </dt>
  794. <dd class="phpdocumentor-tag-list__definition">
  795. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::cachefile">QROptions::cachefile</abbr></span>
  796. </dd>
  797. <dt class="phpdocumentor-tag-list__entry">
  798. <span class="phpdocumentor-tag__name">throws</span>
  799. </dt>
  800. <dd class="phpdocumentor-tag-list__definition">
  801. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  802. </dd>
  803. </dl>
  804. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  805. <span class="phpdocumentor-signature__response_type">bool</span>
  806. &mdash;
  807. </article>
  808. <article
  809. class="phpdocumentor-element
  810. -method
  811. -protected
  812. "
  813. >
  814. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  815. setModuleValues()
  816. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  817. </h4>
  818. <aside class="phpdocumentor-element-found-in">
  819. <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>
  820. :
  821. <span class="phpdocumentor-element-found-in__line">89</span>
  822. </aside>
  823. <p class="phpdocumentor-summary">Sets the initial module values</p>
  824. <code class="phpdocumentor-code phpdocumentor-signature ">
  825. <span class="phpdocumentor-signature__visibility">protected</span>
  826. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  827. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  828. <span class="phpdocumentor-signature__response_type">void</span>
  829. &mdash;
  830. </article>
  831. </section>
  832. <script type="text/javascript">
  833. function loadExternalCodeSnippets(line) {
  834. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  835. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  836. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  837. var language = 'php';
  838. var code = document.createElement('code');
  839. code.className = 'language-' + language;
  840. pre.textContent = '';
  841. pre.setAttribute('data-line', line)
  842. code.textContent = 'Loading…';
  843. pre.appendChild(code);
  844. var xhr = new XMLHttpRequest();
  845. xhr.open('GET', src, true);
  846. xhr.onreadystatechange = function () {
  847. if (xhr.readyState == 4) {
  848. if (xhr.status < 400 && xhr.responseText) {
  849. code.textContent = xhr.responseText;
  850. Prism.highlightElement(code);
  851. }
  852. else if (xhr.status >= 400) {
  853. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  854. }
  855. else {
  856. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  857. }
  858. }
  859. };
  860. xhr.send(null);
  861. });
  862. }
  863. var modals = document.querySelectorAll("[data-modal]");
  864. modals.forEach(function (trigger) {
  865. trigger.addEventListener("click", function (event) {
  866. //event.preventDefault();
  867. const modal = document.getElementById(trigger.dataset.modal);
  868. modal.classList.add("phpdocumentor-modal__open");
  869. loadExternalCodeSnippets(trigger.dataset.line)
  870. const exits = modal.querySelectorAll("[data-exit-button]");
  871. exits.forEach(function (exit) {
  872. exit.addEventListener("click", function (event) {
  873. event.preventDefault();
  874. modal.classList.remove("phpdocumentor-modal__open");
  875. });
  876. });
  877. });
  878. });
  879. </script>
  880. </article>
  881. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  882. <section class="phpdocumentor-search-results__dialog">
  883. <header class="phpdocumentor-search-results__header">
  884. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  885. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  886. </header>
  887. <section class="phpdocumentor-search-results__body">
  888. <ul class="phpdocumentor-search-results__entries"></ul>
  889. </section>
  890. </section>
  891. </section>
  892. </div>
  893. </div>
  894. <a href="classes/chillerlan-QRCode-Output-QRFpdf.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  895. </main>
  896. <script>
  897. cssVars({});
  898. </script>
  899. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  900. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  901. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  902. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  903. </body>
  904. </html>