chillerlan-QRCode-Output-QREps.html 80 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619
  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=Open+Sans:wght@100;200;300;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/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. </ul>
  59. </nav>
  60. </header>
  61. <main class="phpdocumentor">
  62. <div class="phpdocumentor-section">
  63. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  64. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  65. Menu
  66. </label>
  67. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  68. <section class="phpdocumentor-sidebar__category">
  69. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  70. <h4 class="phpdocumentor-sidebar__root-namespace">
  71. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  72. </h4>
  73. <ul class="phpdocumentor-list">
  74. <li>
  75. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  76. </li>
  77. <li>
  78. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  79. </li>
  80. </ul>
  81. </section>
  82. <section class="phpdocumentor-sidebar__category">
  83. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  84. <h4 class="phpdocumentor-sidebar__root-namespace">
  85. <a href="packages/Application.html" class="">Application</a>
  86. </h4>
  87. </section>
  88. <section class="phpdocumentor-sidebar__category">
  89. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  92. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  93. </section>
  94. <section class="phpdocumentor-sidebar__category">
  95. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  96. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  97. </section>
  98. </aside>
  99. <div class="phpdocumentor-column -nine phpdocumentor-content">
  100. <section>
  101. <ul class="phpdocumentor-breadcrumbs">
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  103. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  104. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  105. </ul>
  106. <article class="phpdocumentor-element -class">
  107. <h2 class="phpdocumentor-content__title">
  108. QREps
  109. <span class="phpdocumentor-element__extends">
  110. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  111. </span>
  112. <div class="phpdocumentor-element__package">
  113. in package
  114. <ul class="phpdocumentor-breadcrumbs">
  115. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  116. </ul>
  117. </div>
  118. </h2>
  119. <div class="phpdocumentor-label-line">
  120. </div>
  121. <aside class="phpdocumentor-element-found-in">
  122. <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>
  123. :
  124. <span class="phpdocumentor-element-found-in__line">23</span>
  125. </aside>
  126. <p class="phpdocumentor-summary">Encapsulated Postscript (EPS) output</p>
  127. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  128. Tags
  129. <a href="classes/chillerlan-QRCode-Output-QREps.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  130. </h5>
  131. <dl class="phpdocumentor-tag-list">
  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/t0k4rt/phpqrcode/blob/bb29e6eb77e0a2a85bb0eb62725e0adc11ff5a90/qrvect.php#L52-L137">https://github.com/t0k4rt/phpqrcode/blob/bb29e6eb77e0a2a85bb0eb62725e0adc11ff5a90/qrvect.php#L52-L137</a></span>
  137. </dd>
  138. <dt class="phpdocumentor-tag-list__entry">
  139. <span class="phpdocumentor-tag__name">see</span>
  140. </dt>
  141. <dd class="phpdocumentor-tag-list__definition">
  142. <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">https://web.archive.org/web/20170818010030/http://wwwimages.adobe.com/content/dam/Adobe/en/devnet/postscript/pdfs/5002.EPSF_Spec.pdf</a></span>
  143. </dd>
  144. <dt class="phpdocumentor-tag-list__entry">
  145. <span class="phpdocumentor-tag__name">see</span>
  146. </dt>
  147. <dd class="phpdocumentor-tag-list__definition">
  148. <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">https://web.archive.org/web/20210419003859/https://www.adobe.com/content/dam/acom/en/devnet/actionscript/articles/PLRM.pdf</a></span>
  149. </dd>
  150. <dt class="phpdocumentor-tag-list__entry">
  151. <span class="phpdocumentor-tag__name">see</span>
  152. </dt>
  153. <dd class="phpdocumentor-tag-list__definition">
  154. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/148">https://github.com/chillerlan/php-qrcode/discussions/148</a></span>
  155. </dd>
  156. </dl>
  157. <h3 id="toc">
  158. Table of Contents
  159. <a href="classes/chillerlan-QRCode-Output-QREps.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  160. </h3>
  161. <h4 id="toc-properties">
  162. Properties
  163. <a href="classes/chillerlan-QRCode-Output-QREps.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  164. </h4>
  165. <dl class="phpdocumentor-table-of-contents">
  166. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  167. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  168. <span>
  169. &nbsp;: int </span>
  170. </dt>
  171. <dd>the side length of the QR image (modules * scale)</dd>
  172. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  173. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  174. <span>
  175. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  176. </dt>
  177. <dd>the (filled) data matrix object</dd>
  178. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  179. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  180. <span>
  181. &nbsp;: int </span>
  182. </dt>
  183. <dd>the current size of the QR matrix</dd>
  184. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  185. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  186. <span>
  187. &nbsp;: array&lt;string|int, mixed&gt; </span>
  188. </dt>
  189. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  190. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  191. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  192. <span>
  193. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  194. </dt>
  195. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  196. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  197. <span>
  198. &nbsp;: int </span>
  199. </dt>
  200. <dd>the current scaling for a QR pixel</dd>
  201. </dl>
  202. <h4 id="toc-methods">
  203. Methods
  204. <a href="classes/chillerlan-QRCode-Output-QREps.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  205. </h4>
  206. <dl class="phpdocumentor-table-of-contents">
  207. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  208. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  209. <span>
  210. &nbsp;: mixed </span>
  211. </dt>
  212. <dd>QROutputAbstract constructor.</dd>
  213. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  214. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_dump">dump()</a>
  215. <span>
  216. &nbsp;: string </span>
  217. </dt>
  218. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  219. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  220. <span>
  221. &nbsp;: bool </span>
  222. </dt>
  223. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  224. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  225. <span>
  226. &nbsp;: array&lt;string|int, mixed&gt; </span>
  227. </dt>
  228. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  229. returns an array with the transformed modules</dd>
  230. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  231. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_formatColor">formatColor()</a>
  232. <span>
  233. &nbsp;: string </span>
  234. </dt>
  235. <dd>Set the color format string</dd>
  236. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  237. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  238. <span>
  239. &nbsp;: mixed|null </span>
  240. </dt>
  241. <dd>Returns a default value for either dark or light modules</dd>
  242. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  243. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  244. <span>
  245. &nbsp;: mixed|null </span>
  246. </dt>
  247. <dd>Returns the prepared value for the given $M_TYPE</dd>
  248. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  249. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  250. <span>
  251. &nbsp;: mixed|null </span>
  252. </dt>
  253. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  254. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  255. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a>
  256. <span>
  257. &nbsp;: array&lt;string|int, mixed&gt; </span>
  258. </dt>
  259. <dd>Returns a 2 element array with the current output width and height</dd>
  260. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  261. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_module">module()</a>
  262. <span>
  263. &nbsp;: string </span>
  264. </dt>
  265. <dd>Returns a path segment for a single module</dd>
  266. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  267. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_prepareModuleValue">prepareModuleValue()</a>
  268. <span>
  269. &nbsp;: mixed|null </span>
  270. </dt>
  271. <dd>Prepares the value for the given input ()</dd>
  272. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  273. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  274. <span>
  275. &nbsp;: void </span>
  276. </dt>
  277. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  278. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  279. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  280. <span>
  281. &nbsp;: void </span>
  282. </dt>
  283. <dd>Sets/updates the matrix dimensions</dd>
  284. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  285. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  286. <span>
  287. &nbsp;: void </span>
  288. </dt>
  289. <dd>Sets the initial module values</dd>
  290. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  291. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  292. <span>
  293. &nbsp;: string </span>
  294. </dt>
  295. <dd>Returns a base64 data URI for the given string and mime type</dd>
  296. </dl>
  297. <section class="phpdocumentor-properties">
  298. <h3 class="phpdocumentor-elements__header" id="properties">
  299. Properties
  300. <a href="classes/chillerlan-QRCode-Output-QREps.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  301. </h3>
  302. <article
  303. class="
  304. phpdocumentor-element
  305. -property
  306. -protected
  307. "
  308. >
  309. <h4 class="phpdocumentor-element__name" id="property_length">
  310. $length
  311. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  312. <span class="phpdocumentor-element__modifiers">
  313. </span>
  314. </h4>
  315. <aside class="phpdocumentor-element-found-in">
  316. <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>
  317. :
  318. <span class="phpdocumentor-element-found-in__line">40</span>
  319. </aside>
  320. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  321. <code class="phpdocumentor-code phpdocumentor-signature ">
  322. <span class="phpdocumentor-signature__visibility">protected</span>
  323. <span class="phpdocumentor-signature__type">int</span>
  324. <span class="phpdocumentor-signature__name">$length</span>
  325. </code>
  326. </article>
  327. <article
  328. class="
  329. phpdocumentor-element
  330. -property
  331. -protected
  332. "
  333. >
  334. <h4 class="phpdocumentor-element__name" id="property_matrix">
  335. $matrix
  336. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  337. <span class="phpdocumentor-element__modifiers">
  338. </span>
  339. </h4>
  340. <aside class="phpdocumentor-element-found-in">
  341. <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>
  342. :
  343. <span class="phpdocumentor-element-found-in__line">50</span>
  344. </aside>
  345. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  346. <code class="phpdocumentor-code phpdocumentor-signature ">
  347. <span class="phpdocumentor-signature__visibility">protected</span>
  348. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  349. <span class="phpdocumentor-signature__name">$matrix</span>
  350. </code>
  351. </article>
  352. <article
  353. class="
  354. phpdocumentor-element
  355. -property
  356. -protected
  357. "
  358. >
  359. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  360. $moduleCount
  361. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  362. <span class="phpdocumentor-element__modifiers">
  363. </span>
  364. </h4>
  365. <aside class="phpdocumentor-element-found-in">
  366. <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>
  367. :
  368. <span class="phpdocumentor-element-found-in__line">28</span>
  369. </aside>
  370. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  371. <code class="phpdocumentor-code phpdocumentor-signature ">
  372. <span class="phpdocumentor-signature__visibility">protected</span>
  373. <span class="phpdocumentor-signature__type">int</span>
  374. <span class="phpdocumentor-signature__name">$moduleCount</span>
  375. </code>
  376. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  377. Tags
  378. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  379. </h5>
  380. <dl class="phpdocumentor-tag-list">
  381. <dt class="phpdocumentor-tag-list__entry">
  382. <span class="phpdocumentor-tag__name">see</span>
  383. </dt>
  384. <dd class="phpdocumentor-tag-list__definition">
  385. <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>
  386. </dd>
  387. </dl>
  388. </article>
  389. <article
  390. class="
  391. phpdocumentor-element
  392. -property
  393. -protected
  394. "
  395. >
  396. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  397. $moduleValues
  398. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  399. <span class="phpdocumentor-element__modifiers">
  400. </span>
  401. </h4>
  402. <aside class="phpdocumentor-element-found-in">
  403. <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>
  404. :
  405. <span class="phpdocumentor-element-found-in__line">45</span>
  406. </aside>
  407. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  408. <code class="phpdocumentor-code phpdocumentor-signature ">
  409. <span class="phpdocumentor-signature__visibility">protected</span>
  410. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  411. <span class="phpdocumentor-signature__name">$moduleValues</span>
  412. </code>
  413. </article>
  414. <article
  415. class="
  416. phpdocumentor-element
  417. -property
  418. -protected
  419. "
  420. >
  421. <h4 class="phpdocumentor-element__name" id="property_options">
  422. $options
  423. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  424. <span class="phpdocumentor-element__modifiers">
  425. </span>
  426. </h4>
  427. <aside class="phpdocumentor-element-found-in">
  428. <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>
  429. :
  430. <span class="phpdocumentor-element-found-in__line">55</span>
  431. </aside>
  432. <code class="phpdocumentor-code phpdocumentor-signature ">
  433. <span class="phpdocumentor-signature__visibility">protected</span>
  434. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  435. <span class="phpdocumentor-signature__name">$options</span>
  436. </code>
  437. </article>
  438. <article
  439. class="
  440. phpdocumentor-element
  441. -property
  442. -protected
  443. "
  444. >
  445. <h4 class="phpdocumentor-element__name" id="property_scale">
  446. $scale
  447. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  448. <span class="phpdocumentor-element__modifiers">
  449. </span>
  450. </h4>
  451. <aside class="phpdocumentor-element-found-in">
  452. <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>
  453. :
  454. <span class="phpdocumentor-element-found-in__line">35</span>
  455. </aside>
  456. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  457. <code class="phpdocumentor-code phpdocumentor-signature ">
  458. <span class="phpdocumentor-signature__visibility">protected</span>
  459. <span class="phpdocumentor-signature__type">int</span>
  460. <span class="phpdocumentor-signature__name">$scale</span>
  461. </code>
  462. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  463. Tags
  464. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  465. </h5>
  466. <dl class="phpdocumentor-tag-list">
  467. <dt class="phpdocumentor-tag-list__entry">
  468. <span class="phpdocumentor-tag__name">see</span>
  469. </dt>
  470. <dd class="phpdocumentor-tag-list__definition">
  471. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  472. </dd>
  473. </dl>
  474. </article>
  475. </section>
  476. <section class="phpdocumentor-methods">
  477. <h3 class="phpdocumentor-elements__header" id="methods">
  478. Methods
  479. <a href="classes/chillerlan-QRCode-Output-QREps.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  480. </h3>
  481. <article
  482. class="phpdocumentor-element
  483. -method
  484. -public
  485. "
  486. >
  487. <h4 class="phpdocumentor-element__name" id="method___construct">
  488. __construct()
  489. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  490. </h4>
  491. <aside class="phpdocumentor-element-found-in">
  492. <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>
  493. :
  494. <span class="phpdocumentor-element-found-in__line">60</span>
  495. </aside>
  496. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  497. <code class="phpdocumentor-code phpdocumentor-signature ">
  498. <span class="phpdocumentor-signature__visibility">public</span>
  499. <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>
  500. <div class="phpdocumentor-label-line">
  501. </div>
  502. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  503. <dl class="phpdocumentor-argument-list">
  504. <dt class="phpdocumentor-argument-list__entry">
  505. <span class="phpdocumentor-signature__argument__name">$options</span>
  506. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  507. </dt>
  508. <dd class="phpdocumentor-argument-list__definition">
  509. </dd>
  510. <dt class="phpdocumentor-argument-list__entry">
  511. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  512. : <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>
  513. </dt>
  514. <dd class="phpdocumentor-argument-list__definition">
  515. </dd>
  516. </dl>
  517. </article>
  518. <article
  519. class="phpdocumentor-element
  520. -method
  521. -public
  522. "
  523. >
  524. <h4 class="phpdocumentor-element__name" id="method_dump">
  525. dump()
  526. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  527. </h4>
  528. <aside class="phpdocumentor-element-found-in">
  529. <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>
  530. :
  531. <span class="phpdocumentor-element-found-in__line">104</span>
  532. </aside>
  533. <code class="phpdocumentor-code phpdocumentor-signature ">
  534. <span class="phpdocumentor-signature__visibility">public</span>
  535. <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>
  536. <div class="phpdocumentor-label-line">
  537. </div>
  538. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  539. <dl class="phpdocumentor-argument-list">
  540. <dt class="phpdocumentor-argument-list__entry">
  541. <span class="phpdocumentor-signature__argument__name">$file</span>
  542. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  543. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  544. <dd class="phpdocumentor-argument-list__definition">
  545. </dd>
  546. </dl>
  547. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  548. Tags
  549. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  550. </h5>
  551. <dl class="phpdocumentor-tag-list">
  552. <dt class="phpdocumentor-tag-list__entry">
  553. <span class="phpdocumentor-tag__name">inheritDoc</span>
  554. </dt>
  555. <dd class="phpdocumentor-tag-list__definition">
  556. </dd>
  557. </dl>
  558. <section>
  559. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  560. <span class="phpdocumentor-signature__response_type">string</span>
  561. </section>
  562. </article>
  563. <article
  564. class="phpdocumentor-element
  565. -method
  566. -public
  567. -static "
  568. >
  569. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  570. moduleValueIsValid()
  571. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  572. </h4>
  573. <aside class="phpdocumentor-element-found-in">
  574. <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>
  575. :
  576. <span class="phpdocumentor-element-found-in__line">28</span>
  577. </aside>
  578. <code class="phpdocumentor-code phpdocumentor-signature ">
  579. <span class="phpdocumentor-signature__visibility">public</span>
  580. <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>
  581. <div class="phpdocumentor-label-line">
  582. </div>
  583. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  584. <dl class="phpdocumentor-argument-list">
  585. <dt class="phpdocumentor-argument-list__entry">
  586. <span class="phpdocumentor-signature__argument__name">$value</span>
  587. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  588. </dt>
  589. <dd class="phpdocumentor-argument-list__definition">
  590. </dd>
  591. </dl>
  592. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  593. Tags
  594. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_moduleValueIsValid#tags" class="headerlink"><i class="fas fa-link"></i></a>
  595. </h5>
  596. <dl class="phpdocumentor-tag-list">
  597. <dt class="phpdocumentor-tag-list__entry">
  598. <span class="phpdocumentor-tag__name">inheritDoc</span>
  599. </dt>
  600. <dd class="phpdocumentor-tag-list__definition">
  601. </dd>
  602. </dl>
  603. <section>
  604. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  605. <span class="phpdocumentor-signature__response_type">bool</span>
  606. </section>
  607. </article>
  608. <article
  609. class="phpdocumentor-element
  610. -method
  611. -protected
  612. "
  613. >
  614. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  615. collectModules()
  616. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  617. </h4>
  618. <aside class="phpdocumentor-element-found-in">
  619. <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>
  620. :
  621. <span class="phpdocumentor-element-found-in__line">193</span>
  622. </aside>
  623. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  624. returns an array with the transformed modules</p>
  625. <code class="phpdocumentor-code phpdocumentor-signature ">
  626. <span class="phpdocumentor-signature__visibility">protected</span>
  627. <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>
  628. <div class="phpdocumentor-label-line">
  629. </div>
  630. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  631. <p>$x - current column
  632. $y - current row
  633. $M_TYPE - field value
  634. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  635. </section>
  636. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  637. <dl class="phpdocumentor-argument-list">
  638. <dt class="phpdocumentor-argument-list__entry">
  639. <span class="phpdocumentor-signature__argument__name">$transform</span>
  640. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  641. </dt>
  642. <dd class="phpdocumentor-argument-list__definition">
  643. </dd>
  644. </dl>
  645. <section>
  646. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  647. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  648. </section>
  649. </article>
  650. <article
  651. class="phpdocumentor-element
  652. -method
  653. -protected
  654. "
  655. >
  656. <h4 class="phpdocumentor-element__name" id="method_formatColor">
  657. formatColor()
  658. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_formatColor" class="headerlink"><i class="fas fa-link"></i></a>
  659. </h4>
  660. <aside class="phpdocumentor-element-found-in">
  661. <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>
  662. :
  663. <span class="phpdocumentor-element-found-in__line">85</span>
  664. </aside>
  665. <p class="phpdocumentor-summary">Set the color format string</p>
  666. <code class="phpdocumentor-code phpdocumentor-signature ">
  667. <span class="phpdocumentor-signature__visibility">protected</span>
  668. <span class="phpdocumentor-signature__name">formatColor</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">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  669. <div class="phpdocumentor-label-line">
  670. </div>
  671. <section class="phpdocumentor-description"><p>4 values in the color array will be interpreted as CMYK, 3 as RGB</p>
  672. </section>
  673. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  674. <dl class="phpdocumentor-argument-list">
  675. <dt class="phpdocumentor-argument-list__entry">
  676. <span class="phpdocumentor-signature__argument__name">$values</span>
  677. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  678. </dt>
  679. <dd class="phpdocumentor-argument-list__definition">
  680. </dd>
  681. </dl>
  682. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  683. Tags
  684. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_formatColor#tags" class="headerlink"><i class="fas fa-link"></i></a>
  685. </h5>
  686. <dl class="phpdocumentor-tag-list">
  687. <dt class="phpdocumentor-tag-list__entry">
  688. <span class="phpdocumentor-tag__name">throws</span>
  689. </dt>
  690. <dd class="phpdocumentor-tag-list__definition">
  691. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  692. </dd>
  693. </dl>
  694. <section>
  695. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  696. <span class="phpdocumentor-signature__response_type">string</span>
  697. </section>
  698. </article>
  699. <article
  700. class="phpdocumentor-element
  701. -method
  702. -protected
  703. "
  704. >
  705. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  706. getDefaultModuleValue()
  707. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  708. </h4>
  709. <aside class="phpdocumentor-element-found-in">
  710. <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>
  711. :
  712. <span class="phpdocumentor-element-found-in__line">74</span>
  713. </aside>
  714. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
  715. <code class="phpdocumentor-code phpdocumentor-signature ">
  716. <span class="phpdocumentor-signature__visibility">protected</span>
  717. <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>
  718. <div class="phpdocumentor-label-line">
  719. </div>
  720. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  721. <dl class="phpdocumentor-argument-list">
  722. <dt class="phpdocumentor-argument-list__entry">
  723. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  724. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  725. </dt>
  726. <dd class="phpdocumentor-argument-list__definition">
  727. </dd>
  728. </dl>
  729. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  730. Tags
  731. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getDefaultModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  732. </h5>
  733. <dl class="phpdocumentor-tag-list">
  734. <dt class="phpdocumentor-tag-list__entry">
  735. <span class="phpdocumentor-tag__name">inheritDoc</span>
  736. </dt>
  737. <dd class="phpdocumentor-tag-list__definition">
  738. </dd>
  739. </dl>
  740. <section>
  741. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  742. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  743. &mdash;
  744. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  745. </section>
  746. </section>
  747. </article>
  748. <article
  749. class="phpdocumentor-element
  750. -method
  751. -protected
  752. "
  753. >
  754. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  755. getModuleValue()
  756. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  757. </h4>
  758. <aside class="phpdocumentor-element-found-in">
  759. <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>
  760. :
  761. <span class="phpdocumentor-element-found-in__line">117</span>
  762. </aside>
  763. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  764. <code class="phpdocumentor-code phpdocumentor-signature ">
  765. <span class="phpdocumentor-signature__visibility">protected</span>
  766. <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>
  767. <div class="phpdocumentor-label-line">
  768. </div>
  769. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  770. <dl class="phpdocumentor-argument-list">
  771. <dt class="phpdocumentor-argument-list__entry">
  772. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  773. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  774. </dt>
  775. <dd class="phpdocumentor-argument-list__definition">
  776. </dd>
  777. </dl>
  778. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  779. Tags
  780. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  781. </h5>
  782. <dl class="phpdocumentor-tag-list">
  783. <dt class="phpdocumentor-tag-list__entry">
  784. <span class="phpdocumentor-tag__name">throws</span>
  785. </dt>
  786. <dd class="phpdocumentor-tag-list__definition">
  787. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  788. </dd>
  789. </dl>
  790. <section>
  791. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  792. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  793. &mdash;
  794. <section class="phpdocumentor-description"><p>return value depends on the output class, null if $moduleValues[$M_TYPE] doesn't exist</p>
  795. </section>
  796. </section>
  797. </article>
  798. <article
  799. class="phpdocumentor-element
  800. -method
  801. -protected
  802. "
  803. >
  804. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  805. getModuleValueAt()
  806. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  807. </h4>
  808. <aside class="phpdocumentor-element-found-in">
  809. <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>
  810. :
  811. <span class="phpdocumentor-element-found-in__line">132</span>
  812. </aside>
  813. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  814. <code class="phpdocumentor-code phpdocumentor-signature ">
  815. <span class="phpdocumentor-signature__visibility">protected</span>
  816. <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>
  817. <div class="phpdocumentor-label-line">
  818. </div>
  819. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  820. <dl class="phpdocumentor-argument-list">
  821. <dt class="phpdocumentor-argument-list__entry">
  822. <span class="phpdocumentor-signature__argument__name">$x</span>
  823. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  824. </dt>
  825. <dd class="phpdocumentor-argument-list__definition">
  826. </dd>
  827. <dt class="phpdocumentor-argument-list__entry">
  828. <span class="phpdocumentor-signature__argument__name">$y</span>
  829. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  830. </dt>
  831. <dd class="phpdocumentor-argument-list__definition">
  832. </dd>
  833. </dl>
  834. <section>
  835. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  836. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  837. </section>
  838. </article>
  839. <article
  840. class="phpdocumentor-element
  841. -method
  842. -protected
  843. "
  844. >
  845. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  846. getOutputDimensions()
  847. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  848. </h4>
  849. <aside class="phpdocumentor-element-found-in">
  850. <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>
  851. :
  852. <span class="phpdocumentor-element-found-in__line">88</span>
  853. </aside>
  854. <p class="phpdocumentor-summary">Returns a 2 element array with the current output width and height</p>
  855. <code class="phpdocumentor-code phpdocumentor-signature ">
  856. <span class="phpdocumentor-signature__visibility">protected</span>
  857. <span class="phpdocumentor-signature__name">getOutputDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  858. <div class="phpdocumentor-label-line">
  859. </div>
  860. <section class="phpdocumentor-description"><p>The type and units of the values depend on the output class. The default value is the current module count * scale.</p>
  861. </section>
  862. <section>
  863. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  864. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  865. </section>
  866. </article>
  867. <article
  868. class="phpdocumentor-element
  869. -method
  870. -protected
  871. "
  872. >
  873. <h4 class="phpdocumentor-element__name" id="method_module">
  874. module()
  875. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  876. </h4>
  877. <aside class="phpdocumentor-element-found-in">
  878. <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>
  879. :
  880. <span class="phpdocumentor-element-found-in__line">156</span>
  881. </aside>
  882. <p class="phpdocumentor-summary">Returns a path segment for a single module</p>
  883. <code class="phpdocumentor-code phpdocumentor-signature ">
  884. <span class="phpdocumentor-signature__visibility">protected</span>
  885. <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 class="phpdocumentor-signature__argument"><span>, </span><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">string</span></code>
  886. <div class="phpdocumentor-label-line">
  887. </div>
  888. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  889. <dl class="phpdocumentor-argument-list">
  890. <dt class="phpdocumentor-argument-list__entry">
  891. <span class="phpdocumentor-signature__argument__name">$x</span>
  892. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  893. </dt>
  894. <dd class="phpdocumentor-argument-list__definition">
  895. </dd>
  896. <dt class="phpdocumentor-argument-list__entry">
  897. <span class="phpdocumentor-signature__argument__name">$y</span>
  898. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  899. </dt>
  900. <dd class="phpdocumentor-argument-list__definition">
  901. </dd>
  902. <dt class="phpdocumentor-argument-list__entry">
  903. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  904. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  905. </dt>
  906. <dd class="phpdocumentor-argument-list__definition">
  907. </dd>
  908. </dl>
  909. <section>
  910. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  911. <span class="phpdocumentor-signature__response_type">string</span>
  912. </section>
  913. </article>
  914. <article
  915. class="phpdocumentor-element
  916. -method
  917. -protected
  918. "
  919. >
  920. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  921. prepareModuleValue()
  922. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  923. </h4>
  924. <aside class="phpdocumentor-element-found-in">
  925. <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>
  926. :
  927. <span class="phpdocumentor-element-found-in__line">55</span>
  928. </aside>
  929. <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
  930. <code class="phpdocumentor-code phpdocumentor-signature ">
  931. <span class="phpdocumentor-signature__visibility">protected</span>
  932. <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>
  933. <div class="phpdocumentor-label-line">
  934. </div>
  935. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  936. <dl class="phpdocumentor-argument-list">
  937. <dt class="phpdocumentor-argument-list__entry">
  938. <span class="phpdocumentor-signature__argument__name">$value</span>
  939. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  940. </dt>
  941. <dd class="phpdocumentor-argument-list__definition">
  942. </dd>
  943. </dl>
  944. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  945. Tags
  946. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_prepareModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  947. </h5>
  948. <dl class="phpdocumentor-tag-list">
  949. <dt class="phpdocumentor-tag-list__entry">
  950. <span class="phpdocumentor-tag__name">inheritDoc</span>
  951. </dt>
  952. <dd class="phpdocumentor-tag-list__definition">
  953. </dd>
  954. </dl>
  955. <section>
  956. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  957. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  958. &mdash;
  959. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  960. </section>
  961. </section>
  962. </article>
  963. <article
  964. class="phpdocumentor-element
  965. -method
  966. -protected
  967. "
  968. >
  969. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  970. saveToFile()
  971. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  972. </h4>
  973. <aside class="phpdocumentor-element-found-in">
  974. <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>
  975. :
  976. <span class="phpdocumentor-element-found-in__line">167</span>
  977. </aside>
  978. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  979. <code class="phpdocumentor-code phpdocumentor-signature ">
  980. <span class="phpdocumentor-signature__visibility">protected</span>
  981. <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>
  982. <div class="phpdocumentor-label-line">
  983. </div>
  984. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  985. <dl class="phpdocumentor-argument-list">
  986. <dt class="phpdocumentor-argument-list__entry">
  987. <span class="phpdocumentor-signature__argument__name">$data</span>
  988. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  989. </dt>
  990. <dd class="phpdocumentor-argument-list__definition">
  991. </dd>
  992. <dt class="phpdocumentor-argument-list__entry">
  993. <span class="phpdocumentor-signature__argument__name">$file</span>
  994. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  995. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  996. <dd class="phpdocumentor-argument-list__definition">
  997. </dd>
  998. </dl>
  999. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1000. Tags
  1001. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1002. </h5>
  1003. <dl class="phpdocumentor-tag-list">
  1004. <dt class="phpdocumentor-tag-list__entry">
  1005. <span class="phpdocumentor-tag__name">see</span>
  1006. </dt>
  1007. <dd class="phpdocumentor-tag-list__definition">
  1008. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1009. </dd>
  1010. <dt class="phpdocumentor-tag-list__entry">
  1011. <span class="phpdocumentor-tag__name">see</span>
  1012. </dt>
  1013. <dd class="phpdocumentor-tag-list__definition">
  1014. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1015. </dd>
  1016. <dt class="phpdocumentor-tag-list__entry">
  1017. <span class="phpdocumentor-tag__name">throws</span>
  1018. </dt>
  1019. <dd class="phpdocumentor-tag-list__definition">
  1020. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1021. </dd>
  1022. </dl>
  1023. </article>
  1024. <article
  1025. class="phpdocumentor-element
  1026. -method
  1027. -protected
  1028. "
  1029. >
  1030. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1031. setMatrixDimensions()
  1032. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1033. </h4>
  1034. <aside class="phpdocumentor-element-found-in">
  1035. <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>
  1036. :
  1037. <span class="phpdocumentor-element-found-in__line">77</span>
  1038. </aside>
  1039. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1040. <code class="phpdocumentor-code phpdocumentor-signature ">
  1041. <span class="phpdocumentor-signature__visibility">protected</span>
  1042. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1043. <div class="phpdocumentor-label-line">
  1044. </div>
  1045. <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>
  1046. </section>
  1047. </article>
  1048. <article
  1049. class="phpdocumentor-element
  1050. -method
  1051. -protected
  1052. "
  1053. >
  1054. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1055. setModuleValues()
  1056. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1057. </h4>
  1058. <aside class="phpdocumentor-element-found-in">
  1059. <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>
  1060. :
  1061. <span class="phpdocumentor-element-found-in__line">95</span>
  1062. </aside>
  1063. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1064. <code class="phpdocumentor-code phpdocumentor-signature ">
  1065. <span class="phpdocumentor-signature__visibility">protected</span>
  1066. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1067. <div class="phpdocumentor-label-line">
  1068. </div>
  1069. </article>
  1070. <article
  1071. class="phpdocumentor-element
  1072. -method
  1073. -protected
  1074. "
  1075. >
  1076. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1077. toBase64DataURI()
  1078. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1079. </h4>
  1080. <aside class="phpdocumentor-element-found-in">
  1081. <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>
  1082. :
  1083. <span class="phpdocumentor-element-found-in__line">155</span>
  1084. </aside>
  1085. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1086. <code class="phpdocumentor-code phpdocumentor-signature ">
  1087. <span class="phpdocumentor-signature__visibility">protected</span>
  1088. <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>
  1089. <div class="phpdocumentor-label-line">
  1090. </div>
  1091. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1092. <dl class="phpdocumentor-argument-list">
  1093. <dt class="phpdocumentor-argument-list__entry">
  1094. <span class="phpdocumentor-signature__argument__name">$data</span>
  1095. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1096. </dt>
  1097. <dd class="phpdocumentor-argument-list__definition">
  1098. </dd>
  1099. <dt class="phpdocumentor-argument-list__entry">
  1100. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1101. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1102. </dt>
  1103. <dd class="phpdocumentor-argument-list__definition">
  1104. </dd>
  1105. </dl>
  1106. <section>
  1107. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1108. <span class="phpdocumentor-signature__response_type">string</span>
  1109. </section>
  1110. </article>
  1111. </section>
  1112. <div class="phpdocumentor-modal" id="source-view">
  1113. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1114. <div class="phpdocumentor-modal-container">
  1115. <div class="phpdocumentor-modal-content">
  1116. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Output/QREps.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  1117. </div>
  1118. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1119. </div>
  1120. </div>
  1121. <script type="text/javascript">
  1122. (function () {
  1123. function loadExternalCodeSnippet(el, url, line) {
  1124. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1125. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1126. const language = 'php';
  1127. const code = document.createElement('code');
  1128. code.className = 'language-' + language;
  1129. pre.textContent = '';
  1130. pre.setAttribute('data-line', line)
  1131. code.textContent = 'Loading…';
  1132. pre.appendChild(code);
  1133. var xhr = new XMLHttpRequest();
  1134. xhr.open('GET', src, true);
  1135. xhr.onreadystatechange = function () {
  1136. if (xhr.readyState !== 4) {
  1137. return;
  1138. }
  1139. if (xhr.status < 400 && xhr.responseText) {
  1140. code.textContent = xhr.responseText;
  1141. Prism.highlightElement(code);
  1142. return;
  1143. }
  1144. if (xhr.status === 404) {
  1145. code.textContent = '✖ Error: File could not be found';
  1146. return;
  1147. }
  1148. if (xhr.status >= 400) {
  1149. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1150. return;
  1151. }
  1152. code.textContent = '✖ Error: An unknown error occurred';
  1153. };
  1154. xhr.send(null);
  1155. });
  1156. }
  1157. const modalButtons = document.querySelectorAll("[data-modal]");
  1158. const openedAsLocalFile = window.location.protocol === 'file:';
  1159. if (modalButtons.length > 0 && openedAsLocalFile) {
  1160. console.warn(
  1161. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1162. 'browsers block XHR requests when a page is opened this way'
  1163. );
  1164. }
  1165. modalButtons.forEach(function (trigger) {
  1166. if (openedAsLocalFile) {
  1167. trigger.setAttribute("hidden", "hidden");
  1168. }
  1169. trigger.addEventListener("click", function (event) {
  1170. event.preventDefault();
  1171. const modal = document.getElementById(trigger.dataset.modal);
  1172. if (!modal) {
  1173. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1174. return;
  1175. }
  1176. modal.classList.add("phpdocumentor-modal__open");
  1177. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1178. const exits = modal.querySelectorAll("[data-exit-button]");
  1179. exits.forEach(function (exit) {
  1180. exit.addEventListener("click", function (event) {
  1181. event.preventDefault();
  1182. modal.classList.remove("phpdocumentor-modal__open");
  1183. });
  1184. });
  1185. });
  1186. });
  1187. })();
  1188. </script>
  1189. </article>
  1190. </section>
  1191. <section class="phpdocumentor-on-this-page__sidebar">
  1192. <section class="phpdocumentor-on-this-page__content">
  1193. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1194. <ul class="phpdocumentor-list -clean">
  1195. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1196. <li>
  1197. <ul class="phpdocumentor-list -clean">
  1198. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#toc-properties">Properties</a></li>
  1199. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#toc-methods">Methods</a></li>
  1200. </ul>
  1201. </li>
  1202. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1203. <li>
  1204. <ul class="phpdocumentor-list -clean">
  1205. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1206. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1207. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1208. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1209. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1210. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1211. </ul>
  1212. </li>
  1213. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1214. <li>
  1215. <ul class="phpdocumentor-list -clean">
  1216. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a></li>
  1217. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#method_dump">dump()</a></li>
  1218. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  1219. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1220. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#method_formatColor">formatColor()</a></li>
  1221. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1222. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1223. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1224. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1225. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#method_module">module()</a></li>
  1226. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1227. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1228. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1229. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1230. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1231. </ul>
  1232. </li>
  1233. </ul>
  1234. </section>
  1235. </section>
  1236. </div>
  1237. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1238. <section class="phpdocumentor-search-results__dialog">
  1239. <header class="phpdocumentor-search-results__header">
  1240. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1241. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1242. </header>
  1243. <section class="phpdocumentor-search-results__body">
  1244. <ul class="phpdocumentor-search-results__entries"></ul>
  1245. </section>
  1246. </section>
  1247. </section>
  1248. </div>
  1249. <a href="classes/chillerlan-QRCode-Output-QREps.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1250. </main>
  1251. <script>
  1252. cssVars({});
  1253. </script>
  1254. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1255. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1256. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1257. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1258. </body>
  1259. </html>