chillerlan-QRCode-Output-QRFpdf.html 53 KB

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