chillerlan-QRCode-Output-QRFpdf.html 55 KB

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