chillerlan-QRCode-Output-QREps.html 65 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337
  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">23</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. <dt class="phpdocumentor-tag-list__entry">
  133. <span class="phpdocumentor-tag__name">see</span>
  134. </dt>
  135. <dd class="phpdocumentor-tag-list__definition">
  136. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/148"><abbr title="https://github.com/chillerlan/php-qrcode/discussions/148">https://github.com/chillerlan/php-qrcode/discussions/148</abbr></a></span>
  137. </dd>
  138. </dl>
  139. <h3 id="toc">
  140. Table of Contents
  141. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  142. </h3>
  143. <dl class="phpdocumentor-table-of-contents">
  144. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  145. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  146. <span>
  147. &nbsp;: int </span>
  148. </dt>
  149. <dd>the side length of the QR image (modules * scale)</dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  151. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  152. <span>
  153. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  154. </dt>
  155. <dd>the (filled) data matrix object</dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  157. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  158. <span>
  159. &nbsp;: int </span>
  160. </dt>
  161. <dd>the current size of the QR matrix</dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  163. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  164. <span>
  165. &nbsp;: array&lt;string|int, mixed&gt; </span>
  166. </dt>
  167. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  168. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  170. <span>
  171. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  172. </dt>
  173. <dd></dd>
  174. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  175. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  176. <span>
  177. &nbsp;: int </span>
  178. </dt>
  179. <dd>the current scaling for a QR pixel</dd>
  180. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  181. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  182. <span>
  183. &nbsp;: mixed </span>
  184. </dt>
  185. <dd>QROutputAbstract constructor.</dd>
  186. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  187. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_dump">dump()</a>
  188. <span>
  189. &nbsp;: string </span>
  190. </dt>
  191. <dd></dd>
  192. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  193. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  194. <span>
  195. &nbsp;: bool </span>
  196. </dt>
  197. <dd></dd>
  198. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  199. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  200. <span>
  201. &nbsp;: array&lt;string|int, mixed&gt; </span>
  202. </dt>
  203. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  204. returns an array with the transformed modules</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  206. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  207. <span>
  208. &nbsp;: mixed|null </span>
  209. </dt>
  210. <dd>Returns a default value for either dark or light modules</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  212. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  213. <span>
  214. &nbsp;: mixed|null </span>
  215. </dt>
  216. <dd>Returns the prepared value for the given $M_TYPE</dd>
  217. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  218. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  219. <span>
  220. &nbsp;: mixed|null </span>
  221. </dt>
  222. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  223. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  224. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_module">module()</a>
  225. <span>
  226. &nbsp;: string </span>
  227. </dt>
  228. <dd>returns a path segment for a single module</dd>
  229. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  230. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_prepareModuleValue">prepareModuleValue()</a>
  231. <span>
  232. &nbsp;: mixed|null </span>
  233. </dt>
  234. <dd>Prepares the value for the given input ()</dd>
  235. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  236. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  237. <span>
  238. &nbsp;: void </span>
  239. </dt>
  240. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  241. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  242. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  243. <span>
  244. &nbsp;: void </span>
  245. </dt>
  246. <dd>Sets/updates the matrix dimensions</dd>
  247. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  248. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  249. <span>
  250. &nbsp;: void </span>
  251. </dt>
  252. <dd>Sets the initial module values</dd>
  253. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  254. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  255. <span>
  256. &nbsp;: string </span>
  257. </dt>
  258. <dd>Returns a base64 data URI for the given string and mime type</dd>
  259. </dl>
  260. <section class="phpdocumentor-properties">
  261. <h3 class="phpdocumentor-elements__header" id="properties">
  262. Properties
  263. <a href="classes/chillerlan-QRCode-Output-QREps.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  264. </h3>
  265. <article
  266. class="
  267. phpdocumentor-element
  268. -property
  269. -protected
  270. "
  271. >
  272. <h4 class="phpdocumentor-element__name" id="property_length">
  273. $length
  274. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  275. <span class="phpdocumentor-element__modifiers">
  276. </span>
  277. </h4>
  278. <aside class="phpdocumentor-element-found-in">
  279. <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>
  280. :
  281. <span class="phpdocumentor-element-found-in__line">40</span>
  282. </aside>
  283. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  284. <code class="phpdocumentor-code phpdocumentor-signature ">
  285. <span class="phpdocumentor-signature__visibility">protected</span>
  286. <span class="phpdocumentor-signature__type">int</span>
  287. <span class="phpdocumentor-signature__name">$length</span>
  288. </code>
  289. <section class="phpdocumentor-description"></section>
  290. </article>
  291. <article
  292. class="
  293. phpdocumentor-element
  294. -property
  295. -protected
  296. "
  297. >
  298. <h4 class="phpdocumentor-element__name" id="property_matrix">
  299. $matrix
  300. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  301. <span class="phpdocumentor-element__modifiers">
  302. </span>
  303. </h4>
  304. <aside class="phpdocumentor-element-found-in">
  305. <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>
  306. :
  307. <span class="phpdocumentor-element-found-in__line">50</span>
  308. </aside>
  309. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  310. <code class="phpdocumentor-code phpdocumentor-signature ">
  311. <span class="phpdocumentor-signature__visibility">protected</span>
  312. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  313. <span class="phpdocumentor-signature__name">$matrix</span>
  314. </code>
  315. <section class="phpdocumentor-description"></section>
  316. </article>
  317. <article
  318. class="
  319. phpdocumentor-element
  320. -property
  321. -protected
  322. "
  323. >
  324. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  325. $moduleCount
  326. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  327. <span class="phpdocumentor-element__modifiers">
  328. </span>
  329. </h4>
  330. <aside class="phpdocumentor-element-found-in">
  331. <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>
  332. :
  333. <span class="phpdocumentor-element-found-in__line">28</span>
  334. </aside>
  335. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  336. <code class="phpdocumentor-code phpdocumentor-signature ">
  337. <span class="phpdocumentor-signature__visibility">protected</span>
  338. <span class="phpdocumentor-signature__type">int</span>
  339. <span class="phpdocumentor-signature__name">$moduleCount</span>
  340. </code>
  341. <section class="phpdocumentor-description"></section>
  342. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  343. Tags
  344. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  345. </h5>
  346. <dl class="phpdocumentor-tag-list">
  347. <dt class="phpdocumentor-tag-list__entry">
  348. <span class="phpdocumentor-tag__name">see</span>
  349. </dt>
  350. <dd class="phpdocumentor-tag-list__definition">
  351. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getSize()">QRMatrix::getSize()</abbr></a></span>
  352. </dd>
  353. </dl>
  354. </article>
  355. <article
  356. class="
  357. phpdocumentor-element
  358. -property
  359. -protected
  360. "
  361. >
  362. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  363. $moduleValues
  364. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  365. <span class="phpdocumentor-element__modifiers">
  366. </span>
  367. </h4>
  368. <aside class="phpdocumentor-element-found-in">
  369. <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>
  370. :
  371. <span class="phpdocumentor-element-found-in__line">45</span>
  372. </aside>
  373. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  374. <code class="phpdocumentor-code phpdocumentor-signature ">
  375. <span class="phpdocumentor-signature__visibility">protected</span>
  376. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  377. <span class="phpdocumentor-signature__name">$moduleValues</span>
  378. </code>
  379. <section class="phpdocumentor-description"></section>
  380. </article>
  381. <article
  382. class="
  383. phpdocumentor-element
  384. -property
  385. -protected
  386. "
  387. >
  388. <h4 class="phpdocumentor-element__name" id="property_options">
  389. $options
  390. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" 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">55</span>
  398. </aside>
  399. <code class="phpdocumentor-code phpdocumentor-signature ">
  400. <span class="phpdocumentor-signature__visibility">protected</span>
  401. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  402. <span class="phpdocumentor-signature__name">$options</span>
  403. </code>
  404. </article>
  405. <article
  406. class="
  407. phpdocumentor-element
  408. -property
  409. -protected
  410. "
  411. >
  412. <h4 class="phpdocumentor-element__name" id="property_scale">
  413. $scale
  414. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  415. <span class="phpdocumentor-element__modifiers">
  416. </span>
  417. </h4>
  418. <aside class="phpdocumentor-element-found-in">
  419. <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>
  420. :
  421. <span class="phpdocumentor-element-found-in__line">35</span>
  422. </aside>
  423. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  424. <code class="phpdocumentor-code phpdocumentor-signature ">
  425. <span class="phpdocumentor-signature__visibility">protected</span>
  426. <span class="phpdocumentor-signature__type">int</span>
  427. <span class="phpdocumentor-signature__name">$scale</span>
  428. </code>
  429. <section class="phpdocumentor-description"></section>
  430. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  431. Tags
  432. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  433. </h5>
  434. <dl class="phpdocumentor-tag-list">
  435. <dt class="phpdocumentor-tag-list__entry">
  436. <span class="phpdocumentor-tag__name">see</span>
  437. </dt>
  438. <dd class="phpdocumentor-tag-list__definition">
  439. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  440. </dd>
  441. </dl>
  442. </article>
  443. </section>
  444. <section class="phpdocumentor-methods">
  445. <h3 class="phpdocumentor-elements__header" id="methods">
  446. Methods
  447. <a href="classes/chillerlan-QRCode-Output-QREps.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  448. </h3>
  449. <article
  450. class="phpdocumentor-element
  451. -method
  452. -public
  453. "
  454. >
  455. <h4 class="phpdocumentor-element__name" id="method___construct">
  456. __construct()
  457. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  458. </h4>
  459. <aside class="phpdocumentor-element-found-in">
  460. <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>
  461. :
  462. <span class="phpdocumentor-element-found-in__line">60</span>
  463. </aside>
  464. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  465. <code class="phpdocumentor-code phpdocumentor-signature ">
  466. <span class="phpdocumentor-signature__visibility">public</span>
  467. <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>
  468. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  469. <dl class="phpdocumentor-argument-list">
  470. <dt class="phpdocumentor-argument-list__entry">
  471. <span class="phpdocumentor-signature__argument__name">$options</span>
  472. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  473. </dt>
  474. <dd class="phpdocumentor-argument-list__definition">
  475. <section class="phpdocumentor-description"></section>
  476. </dd>
  477. <dt class="phpdocumentor-argument-list__entry">
  478. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  479. : <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>
  480. </dt>
  481. <dd class="phpdocumentor-argument-list__definition">
  482. <section class="phpdocumentor-description"></section>
  483. </dd>
  484. </dl>
  485. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  486. <span class="phpdocumentor-signature__response_type">mixed</span>
  487. &mdash;
  488. </article>
  489. <article
  490. class="phpdocumentor-element
  491. -method
  492. -public
  493. "
  494. >
  495. <h4 class="phpdocumentor-element__name" id="method_dump">
  496. dump()
  497. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  498. </h4>
  499. <aside class="phpdocumentor-element-found-in">
  500. <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>
  501. :
  502. <span class="phpdocumentor-element-found-in__line">81</span>
  503. </aside>
  504. <code class="phpdocumentor-code phpdocumentor-signature ">
  505. <span class="phpdocumentor-signature__visibility">public</span>
  506. <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>
  507. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  508. <dl class="phpdocumentor-argument-list">
  509. <dt class="phpdocumentor-argument-list__entry">
  510. <span class="phpdocumentor-signature__argument__name">$file</span>
  511. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  512. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  513. <dd class="phpdocumentor-argument-list__definition">
  514. <section class="phpdocumentor-description"></section>
  515. </dd>
  516. </dl>
  517. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  518. Tags
  519. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  520. </h5>
  521. <dl class="phpdocumentor-tag-list">
  522. <dt class="phpdocumentor-tag-list__entry">
  523. <span class="phpdocumentor-tag__name">inheritDoc</span>
  524. </dt>
  525. <dd class="phpdocumentor-tag-list__definition">
  526. </dd>
  527. </dl>
  528. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  529. <span class="phpdocumentor-signature__response_type">string</span>
  530. &mdash;
  531. </article>
  532. <article
  533. class="phpdocumentor-element
  534. -method
  535. -public
  536. -static "
  537. >
  538. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  539. moduleValueIsValid()
  540. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  541. </h4>
  542. <aside class="phpdocumentor-element-found-in">
  543. <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>
  544. :
  545. <span class="phpdocumentor-element-found-in__line">28</span>
  546. </aside>
  547. <code class="phpdocumentor-code phpdocumentor-signature ">
  548. <span class="phpdocumentor-signature__visibility">public</span>
  549. <span class="phpdocumentor-signature__static">static</span> <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>
  550. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  551. <dl class="phpdocumentor-argument-list">
  552. <dt class="phpdocumentor-argument-list__entry">
  553. <span class="phpdocumentor-signature__argument__name">$value</span>
  554. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  555. </dt>
  556. <dd class="phpdocumentor-argument-list__definition">
  557. <section class="phpdocumentor-description"></section>
  558. </dd>
  559. </dl>
  560. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  561. Tags
  562. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  563. </h5>
  564. <dl class="phpdocumentor-tag-list">
  565. <dt class="phpdocumentor-tag-list__entry">
  566. <span class="phpdocumentor-tag__name">inheritDoc</span>
  567. </dt>
  568. <dd class="phpdocumentor-tag-list__definition">
  569. </dd>
  570. </dl>
  571. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  572. <span class="phpdocumentor-signature__response_type">bool</span>
  573. &mdash;
  574. </article>
  575. <article
  576. class="phpdocumentor-element
  577. -method
  578. -protected
  579. "
  580. >
  581. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  582. collectModules()
  583. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  584. </h4>
  585. <aside class="phpdocumentor-element-found-in">
  586. <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>
  587. :
  588. <span class="phpdocumentor-element-found-in__line">169</span>
  589. </aside>
  590. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  591. returns an array with the transformed modules</p>
  592. <code class="phpdocumentor-code phpdocumentor-signature ">
  593. <span class="phpdocumentor-signature__visibility">protected</span>
  594. <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>
  595. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  596. <p>$x - current column
  597. $y - current row
  598. $M_TYPE - field value
  599. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  600. </section>
  601. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  602. <dl class="phpdocumentor-argument-list">
  603. <dt class="phpdocumentor-argument-list__entry">
  604. <span class="phpdocumentor-signature__argument__name">$transform</span>
  605. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  606. </dt>
  607. <dd class="phpdocumentor-argument-list__definition">
  608. <section class="phpdocumentor-description"></section>
  609. </dd>
  610. </dl>
  611. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  612. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  613. &mdash;
  614. </article>
  615. <article
  616. class="phpdocumentor-element
  617. -method
  618. -protected
  619. "
  620. >
  621. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  622. getDefaultModuleValue()
  623. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  624. </h4>
  625. <aside class="phpdocumentor-element-found-in">
  626. <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>
  627. :
  628. <span class="phpdocumentor-element-found-in__line">74</span>
  629. </aside>
  630. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
  631. <code class="phpdocumentor-code phpdocumentor-signature ">
  632. <span class="phpdocumentor-signature__visibility">protected</span>
  633. <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|null</span></code>
  634. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  635. <dl class="phpdocumentor-argument-list">
  636. <dt class="phpdocumentor-argument-list__entry">
  637. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  638. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  639. </dt>
  640. <dd class="phpdocumentor-argument-list__definition">
  641. <section class="phpdocumentor-description"></section>
  642. </dd>
  643. </dl>
  644. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  645. Tags
  646. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  647. </h5>
  648. <dl class="phpdocumentor-tag-list">
  649. <dt class="phpdocumentor-tag-list__entry">
  650. <span class="phpdocumentor-tag__name">inheritDoc</span>
  651. </dt>
  652. <dd class="phpdocumentor-tag-list__definition">
  653. </dd>
  654. </dl>
  655. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  656. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  657. &mdash;
  658. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  659. </section>
  660. </article>
  661. <article
  662. class="phpdocumentor-element
  663. -method
  664. -protected
  665. "
  666. >
  667. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  668. getModuleValue()
  669. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  670. </h4>
  671. <aside class="phpdocumentor-element-found-in">
  672. <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>
  673. :
  674. <span class="phpdocumentor-element-found-in__line">99</span>
  675. </aside>
  676. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  677. <code class="phpdocumentor-code phpdocumentor-signature ">
  678. <span class="phpdocumentor-signature__visibility">protected</span>
  679. <span class="phpdocumentor-signature__name">getModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  680. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  681. <dl class="phpdocumentor-argument-list">
  682. <dt class="phpdocumentor-argument-list__entry">
  683. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  684. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  685. </dt>
  686. <dd class="phpdocumentor-argument-list__definition">
  687. <section class="phpdocumentor-description"></section>
  688. </dd>
  689. </dl>
  690. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  691. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  692. &mdash;
  693. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  694. </section>
  695. </article>
  696. <article
  697. class="phpdocumentor-element
  698. -method
  699. -protected
  700. "
  701. >
  702. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  703. getModuleValueAt()
  704. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  705. </h4>
  706. <aside class="phpdocumentor-element-found-in">
  707. <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>
  708. :
  709. <span class="phpdocumentor-element-found-in__line">108</span>
  710. </aside>
  711. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  712. <code class="phpdocumentor-code phpdocumentor-signature ">
  713. <span class="phpdocumentor-signature__visibility">protected</span>
  714. <span class="phpdocumentor-signature__name">getModuleValueAt</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  715. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  716. <dl class="phpdocumentor-argument-list">
  717. <dt class="phpdocumentor-argument-list__entry">
  718. <span class="phpdocumentor-signature__argument__name">$x</span>
  719. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  720. </dt>
  721. <dd class="phpdocumentor-argument-list__definition">
  722. <section class="phpdocumentor-description"></section>
  723. </dd>
  724. <dt class="phpdocumentor-argument-list__entry">
  725. <span class="phpdocumentor-signature__argument__name">$y</span>
  726. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  727. </dt>
  728. <dd class="phpdocumentor-argument-list__definition">
  729. <section class="phpdocumentor-description"></section>
  730. </dd>
  731. </dl>
  732. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  733. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  734. &mdash;
  735. </article>
  736. <article
  737. class="phpdocumentor-element
  738. -method
  739. -protected
  740. "
  741. >
  742. <h4 class="phpdocumentor-element__name" id="method_module">
  743. module()
  744. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  745. </h4>
  746. <aside class="phpdocumentor-element-found-in">
  747. <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>
  748. :
  749. <span class="phpdocumentor-element-found-in__line">130</span>
  750. </aside>
  751. <p class="phpdocumentor-summary">returns a path segment for a single module</p>
  752. <code class="phpdocumentor-code phpdocumentor-signature ">
  753. <span class="phpdocumentor-signature__visibility">protected</span>
  754. <span class="phpdocumentor-signature__name">module</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  755. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  756. <dl class="phpdocumentor-argument-list">
  757. <dt class="phpdocumentor-argument-list__entry">
  758. <span class="phpdocumentor-signature__argument__name">$x</span>
  759. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  760. </dt>
  761. <dd class="phpdocumentor-argument-list__definition">
  762. <section class="phpdocumentor-description"></section>
  763. </dd>
  764. <dt class="phpdocumentor-argument-list__entry">
  765. <span class="phpdocumentor-signature__argument__name">$y</span>
  766. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  767. </dt>
  768. <dd class="phpdocumentor-argument-list__definition">
  769. <section class="phpdocumentor-description"></section>
  770. </dd>
  771. </dl>
  772. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  773. <span class="phpdocumentor-signature__response_type">string</span>
  774. &mdash;
  775. </article>
  776. <article
  777. class="phpdocumentor-element
  778. -method
  779. -protected
  780. "
  781. >
  782. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  783. prepareModuleValue()
  784. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  785. </h4>
  786. <aside class="phpdocumentor-element-found-in">
  787. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  788. :
  789. <span class="phpdocumentor-element-found-in__line">55</span>
  790. </aside>
  791. <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
  792. <code class="phpdocumentor-code phpdocumentor-signature ">
  793. <span class="phpdocumentor-signature__visibility">protected</span>
  794. <span class="phpdocumentor-signature__name">prepareModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  795. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  796. <dl class="phpdocumentor-argument-list">
  797. <dt class="phpdocumentor-argument-list__entry">
  798. <span class="phpdocumentor-signature__argument__name">$value</span>
  799. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  800. </dt>
  801. <dd class="phpdocumentor-argument-list__definition">
  802. </dd>
  803. </dl>
  804. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  805. Tags
  806. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  807. </h5>
  808. <dl class="phpdocumentor-tag-list">
  809. <dt class="phpdocumentor-tag-list__entry">
  810. <span class="phpdocumentor-tag__name">inheritDoc</span>
  811. </dt>
  812. <dd class="phpdocumentor-tag-list__definition">
  813. </dd>
  814. </dl>
  815. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  816. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  817. &mdash;
  818. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  819. </section>
  820. </article>
  821. <article
  822. class="phpdocumentor-element
  823. -method
  824. -protected
  825. "
  826. >
  827. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  828. saveToFile()
  829. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  830. </h4>
  831. <aside class="phpdocumentor-element-found-in">
  832. <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>
  833. :
  834. <span class="phpdocumentor-element-found-in__line">143</span>
  835. </aside>
  836. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  837. <code class="phpdocumentor-code phpdocumentor-signature ">
  838. <span class="phpdocumentor-signature__visibility">protected</span>
  839. <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>, </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">void</span></code>
  840. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  841. <dl class="phpdocumentor-argument-list">
  842. <dt class="phpdocumentor-argument-list__entry">
  843. <span class="phpdocumentor-signature__argument__name">$data</span>
  844. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  845. </dt>
  846. <dd class="phpdocumentor-argument-list__definition">
  847. <section class="phpdocumentor-description"></section>
  848. </dd>
  849. <dt class="phpdocumentor-argument-list__entry">
  850. <span class="phpdocumentor-signature__argument__name">$file</span>
  851. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  852. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  853. <dd class="phpdocumentor-argument-list__definition">
  854. <section class="phpdocumentor-description"></section>
  855. </dd>
  856. </dl>
  857. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  858. Tags
  859. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  860. </h5>
  861. <dl class="phpdocumentor-tag-list">
  862. <dt class="phpdocumentor-tag-list__entry">
  863. <span class="phpdocumentor-tag__name">see</span>
  864. </dt>
  865. <dd class="phpdocumentor-tag-list__definition">
  866. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  867. </dd>
  868. <dt class="phpdocumentor-tag-list__entry">
  869. <span class="phpdocumentor-tag__name">see</span>
  870. </dt>
  871. <dd class="phpdocumentor-tag-list__definition">
  872. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  873. </dd>
  874. <dt class="phpdocumentor-tag-list__entry">
  875. <span class="phpdocumentor-tag__name">throws</span>
  876. </dt>
  877. <dd class="phpdocumentor-tag-list__definition">
  878. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  879. </dd>
  880. </dl>
  881. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  882. <span class="phpdocumentor-signature__response_type">void</span>
  883. &mdash;
  884. </article>
  885. <article
  886. class="phpdocumentor-element
  887. -method
  888. -protected
  889. "
  890. >
  891. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  892. setMatrixDimensions()
  893. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  894. </h4>
  895. <aside class="phpdocumentor-element-found-in">
  896. <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>
  897. :
  898. <span class="phpdocumentor-element-found-in__line">73</span>
  899. </aside>
  900. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  901. <code class="phpdocumentor-code phpdocumentor-signature ">
  902. <span class="phpdocumentor-signature__visibility">protected</span>
  903. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  904. <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>
  905. </section>
  906. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  907. <span class="phpdocumentor-signature__response_type">void</span>
  908. &mdash;
  909. </article>
  910. <article
  911. class="phpdocumentor-element
  912. -method
  913. -protected
  914. "
  915. >
  916. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  917. setModuleValues()
  918. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  919. </h4>
  920. <aside class="phpdocumentor-element-found-in">
  921. <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>
  922. :
  923. <span class="phpdocumentor-element-found-in__line">82</span>
  924. </aside>
  925. <p class="phpdocumentor-summary">Sets the initial module values</p>
  926. <code class="phpdocumentor-code phpdocumentor-signature ">
  927. <span class="phpdocumentor-signature__visibility">protected</span>
  928. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  929. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  930. <span class="phpdocumentor-signature__response_type">void</span>
  931. &mdash;
  932. </article>
  933. <article
  934. class="phpdocumentor-element
  935. -method
  936. -protected
  937. "
  938. >
  939. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  940. toBase64DataURI()
  941. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  942. </h4>
  943. <aside class="phpdocumentor-element-found-in">
  944. <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>
  945. :
  946. <span class="phpdocumentor-element-found-in__line">131</span>
  947. </aside>
  948. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  949. <code class="phpdocumentor-code phpdocumentor-signature ">
  950. <span class="phpdocumentor-signature__visibility">protected</span>
  951. <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>
  952. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  953. <dl class="phpdocumentor-argument-list">
  954. <dt class="phpdocumentor-argument-list__entry">
  955. <span class="phpdocumentor-signature__argument__name">$data</span>
  956. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  957. </dt>
  958. <dd class="phpdocumentor-argument-list__definition">
  959. <section class="phpdocumentor-description"></section>
  960. </dd>
  961. <dt class="phpdocumentor-argument-list__entry">
  962. <span class="phpdocumentor-signature__argument__name">$mime</span>
  963. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  964. </dt>
  965. <dd class="phpdocumentor-argument-list__definition">
  966. <section class="phpdocumentor-description"></section>
  967. </dd>
  968. </dl>
  969. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  970. <span class="phpdocumentor-signature__response_type">string</span>
  971. &mdash;
  972. </article>
  973. </section>
  974. <script type="text/javascript">
  975. function loadExternalCodeSnippets(line) {
  976. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  977. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  978. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  979. var language = 'php';
  980. var code = document.createElement('code');
  981. code.className = 'language-' + language;
  982. pre.textContent = '';
  983. pre.setAttribute('data-line', line)
  984. code.textContent = 'Loading…';
  985. pre.appendChild(code);
  986. var xhr = new XMLHttpRequest();
  987. xhr.open('GET', src, true);
  988. xhr.onreadystatechange = function () {
  989. if (xhr.readyState == 4) {
  990. if (xhr.status < 400 && xhr.responseText) {
  991. code.textContent = xhr.responseText;
  992. Prism.highlightElement(code);
  993. }
  994. else if (xhr.status >= 400) {
  995. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  996. }
  997. else {
  998. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  999. }
  1000. }
  1001. };
  1002. xhr.send(null);
  1003. });
  1004. }
  1005. var modals = document.querySelectorAll("[data-modal]");
  1006. modals.forEach(function (trigger) {
  1007. trigger.addEventListener("click", function (event) {
  1008. //event.preventDefault();
  1009. const modal = document.getElementById(trigger.dataset.modal);
  1010. modal.classList.add("phpdocumentor-modal__open");
  1011. loadExternalCodeSnippets(trigger.dataset.line)
  1012. const exits = modal.querySelectorAll("[data-exit-button]");
  1013. exits.forEach(function (exit) {
  1014. exit.addEventListener("click", function (event) {
  1015. event.preventDefault();
  1016. modal.classList.remove("phpdocumentor-modal__open");
  1017. });
  1018. });
  1019. });
  1020. });
  1021. </script>
  1022. </article>
  1023. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1024. <section class="phpdocumentor-search-results__dialog">
  1025. <header class="phpdocumentor-search-results__header">
  1026. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1027. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1028. </header>
  1029. <section class="phpdocumentor-search-results__body">
  1030. <ul class="phpdocumentor-search-results__entries"></ul>
  1031. </section>
  1032. </section>
  1033. </section>
  1034. </div>
  1035. </div>
  1036. <a href="classes/chillerlan-QRCode-Output-QREps.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1037. </main>
  1038. <script>
  1039. cssVars({});
  1040. </script>
  1041. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1042. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1043. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1044. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1045. </body>
  1046. </html>