chillerlan-QRCode-Output-QREps.html 55 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154
  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. QREps
  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/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">22</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">Encapsulated Postscript (EPS) output</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/t0k4rt/phpqrcode/blob/bb29e6eb77e0a2a85bb0eb62725e0adc11ff5a90/qrvect.php#L52-L137"><abbr title="https://github.com/t0k4rt/phpqrcode/blob/bb29e6eb77e0a2a85bb0eb62725e0adc11ff5a90/qrvect.php#L52-L137">https://github.com/t0k4rt/phpqrcode/blob/bb29e6eb77e0a2a85bb0eb62725e0adc11ff5a90/qrvect.php#L52-L137</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="https://web.archive.org/web/20170818010030/http://wwwimages.adobe.com/content/dam/Adobe/en/devnet/postscript/pdfs/5002.EPSF_Spec.pdf"><abbr title="https://web.archive.org/web/20170818010030/http://wwwimages.adobe.com/content/dam/Adobe/en/devnet/postscript/pdfs/5002.EPSF_Spec.pdf">https://web.archive.org/web/20170818010030/http://wwwimages.adobe.com/content/dam/Adobe/en/devnet/postscript/pdfs/5002.EPSF_Spec.pdf</abbr></a></span>
  125. </dd>
  126. <dt class="phpdocumentor-tag-list__entry">
  127. <span class="phpdocumentor-tag__name">see</span>
  128. </dt>
  129. <dd class="phpdocumentor-tag-list__definition">
  130. <span class="phpdocumentor-tag-link"><a href="https://web.archive.org/web/20210419003859/https://www.adobe.com/content/dam/acom/en/devnet/actionscript/articles/PLRM.pdf"><abbr title="https://web.archive.org/web/20210419003859/https://www.adobe.com/content/dam/acom/en/devnet/actionscript/articles/PLRM.pdf">https://web.archive.org/web/20210419003859/https://www.adobe.com/content/dam/acom/en/devnet/actionscript/articles/PLRM.pdf</abbr></a></span>
  131. </dd>
  132. </dl>
  133. <h3 id="toc">
  134. Table of Contents
  135. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  136. </h3>
  137. <dl class="phpdocumentor-table-of-contents">
  138. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  139. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  140. <span>
  141. &nbsp;: int </span>
  142. </dt>
  143. <dd>the side length of the QR image (modules * scale)</dd>
  144. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  145. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  146. <span>
  147. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  148. </dt>
  149. <dd>the (filled) data matrix object</dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  151. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  152. <span>
  153. &nbsp;: int </span>
  154. </dt>
  155. <dd>the current size of the QR matrix</dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  157. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  158. <span>
  159. &nbsp;: array&lt;string|int, mixed&gt; </span>
  160. </dt>
  161. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  163. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  164. <span>
  165. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  166. </dt>
  167. <dd></dd>
  168. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  170. <span>
  171. &nbsp;: int </span>
  172. </dt>
  173. <dd>the current scaling for a QR pixel</dd>
  174. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  175. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  176. <span>
  177. &nbsp;: mixed </span>
  178. </dt>
  179. <dd>QROutputAbstract constructor.</dd>
  180. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  181. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_dump">dump()</a>
  182. <span>
  183. &nbsp;: string </span>
  184. </dt>
  185. <dd></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 function 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-QREps.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  195. <span>
  196. &nbsp;: mixed </span>
  197. </dt>
  198. <dd>Returns a default 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-QREps.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-QREps.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. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  230. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  231. <span>
  232. &nbsp;: string </span>
  233. </dt>
  234. <dd>Returns a base64 data URI for the given string and mime type</dd>
  235. </dl>
  236. <section class="phpdocumentor-properties">
  237. <h3 class="phpdocumentor-elements__header" id="properties">
  238. Properties
  239. <a href="classes/chillerlan-QRCode-Output-QREps.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  240. </h3>
  241. <article
  242. class="
  243. phpdocumentor-element
  244. -property
  245. -protected
  246. "
  247. >
  248. <h4 class="phpdocumentor-element__name" id="property_length">
  249. $length
  250. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  251. <span class="phpdocumentor-element__modifiers">
  252. </span>
  253. </h4>
  254. <aside class="phpdocumentor-element-found-in">
  255. <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>
  256. :
  257. <span class="phpdocumentor-element-found-in__line">40</span>
  258. </aside>
  259. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  260. <code class="phpdocumentor-code phpdocumentor-signature ">
  261. <span class="phpdocumentor-signature__visibility">protected</span>
  262. <span class="phpdocumentor-signature__type">int</span>
  263. <span class="phpdocumentor-signature__name">$length</span>
  264. </code>
  265. <section class="phpdocumentor-description"></section>
  266. </article>
  267. <article
  268. class="
  269. phpdocumentor-element
  270. -property
  271. -protected
  272. "
  273. >
  274. <h4 class="phpdocumentor-element__name" id="property_matrix">
  275. $matrix
  276. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  277. <span class="phpdocumentor-element__modifiers">
  278. </span>
  279. </h4>
  280. <aside class="phpdocumentor-element-found-in">
  281. <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>
  282. :
  283. <span class="phpdocumentor-element-found-in__line">50</span>
  284. </aside>
  285. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  286. <code class="phpdocumentor-code phpdocumentor-signature ">
  287. <span class="phpdocumentor-signature__visibility">protected</span>
  288. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  289. <span class="phpdocumentor-signature__name">$matrix</span>
  290. </code>
  291. <section class="phpdocumentor-description"></section>
  292. </article>
  293. <article
  294. class="
  295. phpdocumentor-element
  296. -property
  297. -protected
  298. "
  299. >
  300. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  301. $moduleCount
  302. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  303. <span class="phpdocumentor-element__modifiers">
  304. </span>
  305. </h4>
  306. <aside class="phpdocumentor-element-found-in">
  307. <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>
  308. :
  309. <span class="phpdocumentor-element-found-in__line">28</span>
  310. </aside>
  311. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  312. <code class="phpdocumentor-code phpdocumentor-signature ">
  313. <span class="phpdocumentor-signature__visibility">protected</span>
  314. <span class="phpdocumentor-signature__type">int</span>
  315. <span class="phpdocumentor-signature__name">$moduleCount</span>
  316. </code>
  317. <section class="phpdocumentor-description"></section>
  318. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  319. Tags
  320. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  321. </h5>
  322. <dl class="phpdocumentor-tag-list">
  323. <dt class="phpdocumentor-tag-list__entry">
  324. <span class="phpdocumentor-tag__name">see</span>
  325. </dt>
  326. <dd class="phpdocumentor-tag-list__definition">
  327. <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>
  328. </dd>
  329. </dl>
  330. </article>
  331. <article
  332. class="
  333. phpdocumentor-element
  334. -property
  335. -protected
  336. "
  337. >
  338. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  339. $moduleValues
  340. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  341. <span class="phpdocumentor-element__modifiers">
  342. </span>
  343. </h4>
  344. <aside class="phpdocumentor-element-found-in">
  345. <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>
  346. :
  347. <span class="phpdocumentor-element-found-in__line">45</span>
  348. </aside>
  349. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  350. <code class="phpdocumentor-code phpdocumentor-signature ">
  351. <span class="phpdocumentor-signature__visibility">protected</span>
  352. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  353. <span class="phpdocumentor-signature__name">$moduleValues</span>
  354. </code>
  355. <section class="phpdocumentor-description"></section>
  356. </article>
  357. <article
  358. class="
  359. phpdocumentor-element
  360. -property
  361. -protected
  362. "
  363. >
  364. <h4 class="phpdocumentor-element__name" id="property_options">
  365. $options
  366. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  367. <span class="phpdocumentor-element__modifiers">
  368. </span>
  369. </h4>
  370. <aside class="phpdocumentor-element-found-in">
  371. <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>
  372. :
  373. <span class="phpdocumentor-element-found-in__line">55</span>
  374. </aside>
  375. <code class="phpdocumentor-code phpdocumentor-signature ">
  376. <span class="phpdocumentor-signature__visibility">protected</span>
  377. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  378. <span class="phpdocumentor-signature__name">$options</span>
  379. </code>
  380. </article>
  381. <article
  382. class="
  383. phpdocumentor-element
  384. -property
  385. -protected
  386. "
  387. >
  388. <h4 class="phpdocumentor-element__name" id="property_scale">
  389. $scale
  390. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  391. <span class="phpdocumentor-element__modifiers">
  392. </span>
  393. </h4>
  394. <aside class="phpdocumentor-element-found-in">
  395. <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>
  396. :
  397. <span class="phpdocumentor-element-found-in__line">35</span>
  398. </aside>
  399. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  400. <code class="phpdocumentor-code phpdocumentor-signature ">
  401. <span class="phpdocumentor-signature__visibility">protected</span>
  402. <span class="phpdocumentor-signature__type">int</span>
  403. <span class="phpdocumentor-signature__name">$scale</span>
  404. </code>
  405. <section class="phpdocumentor-description"></section>
  406. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  407. Tags
  408. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  409. </h5>
  410. <dl class="phpdocumentor-tag-list">
  411. <dt class="phpdocumentor-tag-list__entry">
  412. <span class="phpdocumentor-tag__name">see</span>
  413. </dt>
  414. <dd class="phpdocumentor-tag-list__definition">
  415. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  416. </dd>
  417. </dl>
  418. </article>
  419. </section>
  420. <section class="phpdocumentor-methods">
  421. <h3 class="phpdocumentor-elements__header" id="methods">
  422. Methods
  423. <a href="classes/chillerlan-QRCode-Output-QREps.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  424. </h3>
  425. <article
  426. class="phpdocumentor-element
  427. -method
  428. -public
  429. "
  430. >
  431. <h4 class="phpdocumentor-element__name" id="method___construct">
  432. __construct()
  433. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  434. </h4>
  435. <aside class="phpdocumentor-element-found-in">
  436. <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>
  437. :
  438. <span class="phpdocumentor-element-found-in__line">60</span>
  439. </aside>
  440. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  441. <code class="phpdocumentor-code phpdocumentor-signature ">
  442. <span class="phpdocumentor-signature__visibility">public</span>
  443. <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>
  444. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  445. <dl class="phpdocumentor-argument-list">
  446. <dt class="phpdocumentor-argument-list__entry">
  447. <span class="phpdocumentor-signature__argument__name">$options</span>
  448. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  449. </dt>
  450. <dd class="phpdocumentor-argument-list__definition">
  451. <section class="phpdocumentor-description"></section>
  452. </dd>
  453. <dt class="phpdocumentor-argument-list__entry">
  454. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  455. : <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>
  456. </dt>
  457. <dd class="phpdocumentor-argument-list__definition">
  458. <section class="phpdocumentor-description"></section>
  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-QREps.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/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  477. :
  478. <span class="phpdocumentor-element-found-in__line">52</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</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</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_collectModules">
  515. collectModules()
  516. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" 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">154</span>
  522. </aside>
  523. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  524. returns an array with the transformed modules</p>
  525. <code class="phpdocumentor-code phpdocumentor-signature ">
  526. <span class="phpdocumentor-signature__visibility">protected</span>
  527. <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>
  528. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  529. <p>$x - current column
  530. $y - current row
  531. $M_TYPE - field value
  532. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  533. </section>
  534. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  535. <dl class="phpdocumentor-argument-list">
  536. <dt class="phpdocumentor-argument-list__entry">
  537. <span class="phpdocumentor-signature__argument__name">$transform</span>
  538. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></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">array&lt;string|int, mixed&gt;</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_getDefaultModuleValue">
  555. getDefaultModuleValue()
  556. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getDefaultModuleValue" 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/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  560. :
  561. <span class="phpdocumentor-element-found-in__line">45</span>
  562. </aside>
  563. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output module)</p>
  564. <code class="phpdocumentor-code phpdocumentor-signature ">
  565. <span class="phpdocumentor-signature__visibility">protected</span>
  566. <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>
  567. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  568. <dl class="phpdocumentor-argument-list">
  569. <dt class="phpdocumentor-argument-list__entry">
  570. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  571. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  572. </dt>
  573. <dd class="phpdocumentor-argument-list__definition">
  574. <section class="phpdocumentor-description"></section>
  575. </dd>
  576. </dl>
  577. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  578. Tags
  579. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  580. </h5>
  581. <dl class="phpdocumentor-tag-list">
  582. <dt class="phpdocumentor-tag-list__entry">
  583. <span class="phpdocumentor-tag__name">inheritDoc</span>
  584. </dt>
  585. <dd class="phpdocumentor-tag-list__definition">
  586. </dd>
  587. </dl>
  588. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  589. <span class="phpdocumentor-signature__response_type">mixed</span>
  590. &mdash;
  591. </article>
  592. <article
  593. class="phpdocumentor-element
  594. -method
  595. -protected
  596. "
  597. >
  598. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  599. getModuleValue()
  600. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  601. </h4>
  602. <aside class="phpdocumentor-element-found-in">
  603. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  604. :
  605. <span class="phpdocumentor-element-found-in__line">34</span>
  606. </aside>
  607. <p class="phpdocumentor-summary">Returns the final value for the given input (return value depends on the output module)</p>
  608. <code class="phpdocumentor-code phpdocumentor-signature ">
  609. <span class="phpdocumentor-signature__visibility">protected</span>
  610. <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>
  611. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  612. <dl class="phpdocumentor-argument-list">
  613. <dt class="phpdocumentor-argument-list__entry">
  614. <span class="phpdocumentor-signature__argument__name">$value</span>
  615. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  616. </dt>
  617. <dd class="phpdocumentor-argument-list__definition">
  618. </dd>
  619. </dl>
  620. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  621. Tags
  622. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  623. </h5>
  624. <dl class="phpdocumentor-tag-list">
  625. <dt class="phpdocumentor-tag-list__entry">
  626. <span class="phpdocumentor-tag__name">inheritDoc</span>
  627. </dt>
  628. <dd class="phpdocumentor-tag-list__definition">
  629. </dd>
  630. </dl>
  631. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  632. <span class="phpdocumentor-signature__response_type">mixed</span>
  633. &mdash;
  634. </article>
  635. <article
  636. class="phpdocumentor-element
  637. -method
  638. -protected
  639. "
  640. >
  641. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  642. moduleValueIsValid()
  643. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  644. </h4>
  645. <aside class="phpdocumentor-element-found-in">
  646. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  647. :
  648. <span class="phpdocumentor-element-found-in__line">27</span>
  649. </aside>
  650. <p class="phpdocumentor-summary">Determines whether the given value is valid</p>
  651. <code class="phpdocumentor-code phpdocumentor-signature ">
  652. <span class="phpdocumentor-signature__visibility">protected</span>
  653. <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>
  654. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  655. <dl class="phpdocumentor-argument-list">
  656. <dt class="phpdocumentor-argument-list__entry">
  657. <span class="phpdocumentor-signature__argument__name">$value</span>
  658. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  659. </dt>
  660. <dd class="phpdocumentor-argument-list__definition">
  661. </dd>
  662. </dl>
  663. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  664. Tags
  665. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  666. </h5>
  667. <dl class="phpdocumentor-tag-list">
  668. <dt class="phpdocumentor-tag-list__entry">
  669. <span class="phpdocumentor-tag__name">inheritDoc</span>
  670. </dt>
  671. <dd class="phpdocumentor-tag-list__definition">
  672. </dd>
  673. </dl>
  674. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  675. <span class="phpdocumentor-signature__response_type">bool</span>
  676. &mdash;
  677. </article>
  678. <article
  679. class="phpdocumentor-element
  680. -method
  681. -protected
  682. "
  683. >
  684. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  685. saveToFile()
  686. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  687. </h4>
  688. <aside class="phpdocumentor-element-found-in">
  689. <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>
  690. :
  691. <span class="phpdocumentor-element-found-in__line">132</span>
  692. </aside>
  693. <p class="phpdocumentor-summary">saves the qr data to a file</p>
  694. <code class="phpdocumentor-code phpdocumentor-signature ">
  695. <span class="phpdocumentor-signature__visibility">protected</span>
  696. <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>
  697. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  698. <dl class="phpdocumentor-argument-list">
  699. <dt class="phpdocumentor-argument-list__entry">
  700. <span class="phpdocumentor-signature__argument__name">$data</span>
  701. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  702. </dt>
  703. <dd class="phpdocumentor-argument-list__definition">
  704. <section class="phpdocumentor-description"></section>
  705. </dd>
  706. <dt class="phpdocumentor-argument-list__entry">
  707. <span class="phpdocumentor-signature__argument__name">$file</span>
  708. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  709. </dt>
  710. <dd class="phpdocumentor-argument-list__definition">
  711. <section class="phpdocumentor-description"></section>
  712. </dd>
  713. </dl>
  714. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  715. Tags
  716. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  717. </h5>
  718. <dl class="phpdocumentor-tag-list">
  719. <dt class="phpdocumentor-tag-list__entry">
  720. <span class="phpdocumentor-tag__name">see</span>
  721. </dt>
  722. <dd class="phpdocumentor-tag-list__definition">
  723. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  724. </dd>
  725. <dt class="phpdocumentor-tag-list__entry">
  726. <span class="phpdocumentor-tag__name">see</span>
  727. </dt>
  728. <dd class="phpdocumentor-tag-list__definition">
  729. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::cachefile">QROptions::cachefile</abbr></span>
  730. </dd>
  731. <dt class="phpdocumentor-tag-list__entry">
  732. <span class="phpdocumentor-tag__name">throws</span>
  733. </dt>
  734. <dd class="phpdocumentor-tag-list__definition">
  735. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  736. </dd>
  737. </dl>
  738. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  739. <span class="phpdocumentor-signature__response_type">void</span>
  740. &mdash;
  741. </article>
  742. <article
  743. class="phpdocumentor-element
  744. -method
  745. -protected
  746. "
  747. >
  748. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  749. setMatrixDimensions()
  750. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  751. </h4>
  752. <aside class="phpdocumentor-element-found-in">
  753. <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>
  754. :
  755. <span class="phpdocumentor-element-found-in__line">73</span>
  756. </aside>
  757. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  758. <code class="phpdocumentor-code phpdocumentor-signature ">
  759. <span class="phpdocumentor-signature__visibility">protected</span>
  760. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  761. <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>
  762. </section>
  763. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  764. <span class="phpdocumentor-signature__response_type">void</span>
  765. &mdash;
  766. </article>
  767. <article
  768. class="phpdocumentor-element
  769. -method
  770. -protected
  771. "
  772. >
  773. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  774. setModuleValues()
  775. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  776. </h4>
  777. <aside class="phpdocumentor-element-found-in">
  778. <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>
  779. :
  780. <span class="phpdocumentor-element-found-in__line">82</span>
  781. </aside>
  782. <p class="phpdocumentor-summary">Sets the initial module values</p>
  783. <code class="phpdocumentor-code phpdocumentor-signature ">
  784. <span class="phpdocumentor-signature__visibility">protected</span>
  785. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  786. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  787. <span class="phpdocumentor-signature__response_type">void</span>
  788. &mdash;
  789. </article>
  790. <article
  791. class="phpdocumentor-element
  792. -method
  793. -protected
  794. "
  795. >
  796. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  797. toBase64DataURI()
  798. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  799. </h4>
  800. <aside class="phpdocumentor-element-found-in">
  801. <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>
  802. :
  803. <span class="phpdocumentor-element-found-in__line">120</span>
  804. </aside>
  805. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  806. <code class="phpdocumentor-code phpdocumentor-signature ">
  807. <span class="phpdocumentor-signature__visibility">protected</span>
  808. <span class="phpdocumentor-signature__name">toBase64DataURI</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  809. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  810. <dl class="phpdocumentor-argument-list">
  811. <dt class="phpdocumentor-argument-list__entry">
  812. <span class="phpdocumentor-signature__argument__name">$data</span>
  813. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  814. </dt>
  815. <dd class="phpdocumentor-argument-list__definition">
  816. <section class="phpdocumentor-description"></section>
  817. </dd>
  818. <dt class="phpdocumentor-argument-list__entry">
  819. <span class="phpdocumentor-signature__argument__name">$mime</span>
  820. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  821. </dt>
  822. <dd class="phpdocumentor-argument-list__definition">
  823. <section class="phpdocumentor-description"></section>
  824. </dd>
  825. </dl>
  826. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  827. <span class="phpdocumentor-signature__response_type">string</span>
  828. &mdash;
  829. </article>
  830. </section>
  831. <script type="text/javascript">
  832. function loadExternalCodeSnippets(line) {
  833. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  834. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  835. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  836. var language = 'php';
  837. var code = document.createElement('code');
  838. code.className = 'language-' + language;
  839. pre.textContent = '';
  840. pre.setAttribute('data-line', line)
  841. code.textContent = 'Loading…';
  842. pre.appendChild(code);
  843. var xhr = new XMLHttpRequest();
  844. xhr.open('GET', src, true);
  845. xhr.onreadystatechange = function () {
  846. if (xhr.readyState == 4) {
  847. if (xhr.status < 400 && xhr.responseText) {
  848. code.textContent = xhr.responseText;
  849. Prism.highlightElement(code);
  850. }
  851. else if (xhr.status >= 400) {
  852. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  853. }
  854. else {
  855. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  856. }
  857. }
  858. };
  859. xhr.send(null);
  860. });
  861. }
  862. var modals = document.querySelectorAll("[data-modal]");
  863. modals.forEach(function (trigger) {
  864. trigger.addEventListener("click", function (event) {
  865. //event.preventDefault();
  866. const modal = document.getElementById(trigger.dataset.modal);
  867. modal.classList.add("phpdocumentor-modal__open");
  868. loadExternalCodeSnippets(trigger.dataset.line)
  869. const exits = modal.querySelectorAll("[data-exit-button]");
  870. exits.forEach(function (exit) {
  871. exit.addEventListener("click", function (event) {
  872. event.preventDefault();
  873. modal.classList.remove("phpdocumentor-modal__open");
  874. });
  875. });
  876. });
  877. });
  878. </script>
  879. </article>
  880. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  881. <section class="phpdocumentor-search-results__dialog">
  882. <header class="phpdocumentor-search-results__header">
  883. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  884. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  885. </header>
  886. <section class="phpdocumentor-search-results__body">
  887. <ul class="phpdocumentor-search-results__entries"></ul>
  888. </section>
  889. </section>
  890. </section>
  891. </div>
  892. </div>
  893. <a href="classes/chillerlan-QRCode-Output-QREps.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  894. </main>
  895. <script>
  896. cssVars({});
  897. </script>
  898. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  899. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  900. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  901. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  902. </body>
  903. </html>