chillerlan-QRCode-Output-QREps.html 105 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204
  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. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. <h4 class="phpdocumentor-sidebar__root-namespace">
  89. <a href="namespaces/output.html" class="">Output</a>
  90. </h4>
  91. </section>
  92. <section class="phpdocumentor-sidebar__category -packages">
  93. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  94. <h4 class="phpdocumentor-sidebar__root-namespace">
  95. <a href="packages/Application.html" class="">Application</a>
  96. </h4>
  97. </section>
  98. <section class="phpdocumentor-sidebar__category -reports">
  99. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  100. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  101. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  102. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  103. </section>
  104. <section class="phpdocumentor-sidebar__category -indices">
  105. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  106. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  107. </section>
  108. </aside>
  109. <div class="phpdocumentor-column -nine phpdocumentor-content">
  110. <section>
  111. <ul class="phpdocumentor-breadcrumbs">
  112. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  113. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  114. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  115. </ul>
  116. <article class="phpdocumentor-element -class">
  117. <h2 class="phpdocumentor-content__title">
  118. QREps
  119. <span class="phpdocumentor-element__extends">
  120. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  121. </span>
  122. <div class="phpdocumentor-element__package">
  123. in package
  124. <ul class="phpdocumentor-breadcrumbs">
  125. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  126. </ul>
  127. </div>
  128. </h2>
  129. <div class="phpdocumentor-label-line">
  130. </div>
  131. <aside class="phpdocumentor-element-found-in">
  132. <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>
  133. :
  134. <span class="phpdocumentor-element-found-in__line">23</span>
  135. </aside>
  136. <p class="phpdocumentor-summary">Encapsulated Postscript (EPS) output</p>
  137. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  138. Tags
  139. <a href="classes/chillerlan-QRCode-Output-QREps.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  140. </h5>
  141. <dl class="phpdocumentor-tag-list">
  142. <dt class="phpdocumentor-tag-list__entry">
  143. <span class="phpdocumentor-tag__name">see</span>
  144. </dt>
  145. <dd class="phpdocumentor-tag-list__definition">
  146. <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>
  147. </dd>
  148. <dt class="phpdocumentor-tag-list__entry">
  149. <span class="phpdocumentor-tag__name">see</span>
  150. </dt>
  151. <dd class="phpdocumentor-tag-list__definition">
  152. <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>
  153. </dd>
  154. <dt class="phpdocumentor-tag-list__entry">
  155. <span class="phpdocumentor-tag__name">see</span>
  156. </dt>
  157. <dd class="phpdocumentor-tag-list__definition">
  158. <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>
  159. </dd>
  160. <dt class="phpdocumentor-tag-list__entry">
  161. <span class="phpdocumentor-tag__name">see</span>
  162. </dt>
  163. <dd class="phpdocumentor-tag-list__definition">
  164. <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>
  165. </dd>
  166. </dl>
  167. <h3 id="toc">
  168. Table of Contents
  169. <a href="classes/chillerlan-QRCode-Output-QREps.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  170. </h3>
  171. <h4 id="toc-constants">
  172. Constants
  173. <a href="classes/chillerlan-QRCode-Output-QREps.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  174. </h4>
  175. <dl class="phpdocumentor-table-of-contents">
  176. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  177. <a href="classes/chillerlan-QRCode-Output-QREps.html#constant_MIME_TYPE">MIME_TYPE</a>
  178. <span>
  179. &nbsp;= &#039;application/postscript&#039; </span>
  180. </dt>
  181. </dl>
  182. <h4 id="toc-properties">
  183. Properties
  184. <a href="classes/chillerlan-QRCode-Output-QREps.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  185. </h4>
  186. <dl class="phpdocumentor-table-of-contents">
  187. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  188. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter</a>
  189. <span>
  190. &nbsp;: float </span>
  191. </dt>
  192. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  193. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius</a>
  194. <span>
  195. &nbsp;: float </span>
  196. </dt>
  197. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  198. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths</a>
  199. <span>
  200. &nbsp;: bool </span>
  201. </dt>
  202. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  203. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules</a>
  204. <span>
  205. &nbsp;: bool </span>
  206. </dt>
  207. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  208. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules</a>
  209. <span>
  210. &nbsp;: bool </span>
  211. </dt>
  212. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  213. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol</a>
  214. <span>
  215. &nbsp;: string </span>
  216. </dt>
  217. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  218. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect</a>
  219. <span>
  220. &nbsp;: array&lt;string|int, mixed&gt; </span>
  221. </dt>
  222. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  223. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare</a>
  224. <span>
  225. &nbsp;: array&lt;string|int, mixed&gt; </span>
  226. </dt>
  227. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  228. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  229. <span>
  230. &nbsp;: int </span>
  231. </dt>
  232. <dd>the side length of the QR image (modules * scale)</dd>
  233. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  234. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  235. <span>
  236. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  237. </dt>
  238. <dd>the (filled) data matrix object</dd>
  239. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  240. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  241. <span>
  242. &nbsp;: int </span>
  243. </dt>
  244. <dd>the current size of the QR matrix</dd>
  245. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  246. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  247. <span>
  248. &nbsp;: array&lt;string|int, mixed&gt; </span>
  249. </dt>
  250. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  251. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  252. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  253. <span>
  254. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  255. </dt>
  256. <dd>the options instance</dd>
  257. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  258. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  259. <span>
  260. &nbsp;: int </span>
  261. </dt>
  262. </dl>
  263. <h4 id="toc-methods">
  264. Methods
  265. <a href="classes/chillerlan-QRCode-Output-QREps.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  266. </h4>
  267. <dl class="phpdocumentor-table-of-contents">
  268. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  269. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  270. <span>
  271. &nbsp;: mixed </span>
  272. </dt>
  273. <dd>QROutputAbstract constructor.</dd>
  274. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  275. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_dump">dump()</a>
  276. <span>
  277. &nbsp;: string </span>
  278. </dt>
  279. <dd>Generates the output, optionally dumps it to a file, and returns it</dd>
  280. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  281. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  282. <span>
  283. &nbsp;: bool </span>
  284. </dt>
  285. <dd>Determines whether the given value is valid</dd>
  286. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  287. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  288. <span>
  289. &nbsp;: array&lt;string|int, mixed&gt; </span>
  290. </dt>
  291. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  292. returns an array with the transformed modules</dd>
  293. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  294. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a>
  295. <span>
  296. &nbsp;: void </span>
  297. </dt>
  298. <dd>Creates copies of several QROptions values to avoid calling the magic getters
  299. in long loops for a significant performance increase.</dd>
  300. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  301. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_formatColor">formatColor()</a>
  302. <span>
  303. &nbsp;: string </span>
  304. </dt>
  305. <dd>Set the color format string</dd>
  306. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  307. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  308. <span>
  309. &nbsp;: string </span>
  310. </dt>
  311. <dd>Returns a default value for either dark or light modules (return value depends on the output class)</dd>
  312. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  313. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  314. <span>
  315. &nbsp;: mixed </span>
  316. </dt>
  317. <dd>Returns the prepared value for the given $M_TYPE</dd>
  318. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  319. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  320. <span>
  321. &nbsp;: mixed </span>
  322. </dt>
  323. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  324. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  325. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a>
  326. <span>
  327. &nbsp;: array&lt;string|int, mixed&gt; </span>
  328. </dt>
  329. <dd>Returns a 2 element array with the current output width and height</dd>
  330. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  331. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_module">module()</a>
  332. <span>
  333. &nbsp;: string </span>
  334. </dt>
  335. <dd>Returns a path segment for a single module</dd>
  336. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  337. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_prepareModuleValue">prepareModuleValue()</a>
  338. <span>
  339. &nbsp;: string </span>
  340. </dt>
  341. <dd>Prepares the value for the given input (return value depends on the output class)</dd>
  342. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  343. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  344. <span>
  345. &nbsp;: void </span>
  346. </dt>
  347. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  348. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  349. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  350. <span>
  351. &nbsp;: void </span>
  352. </dt>
  353. <dd>Sets/updates the matrix dimensions</dd>
  354. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  355. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  356. <span>
  357. &nbsp;: void </span>
  358. </dt>
  359. <dd>Sets the initial module values</dd>
  360. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  361. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  362. <span>
  363. &nbsp;: string </span>
  364. </dt>
  365. <dd>Returns a base64 data URI for the given string and mime type</dd>
  366. </dl>
  367. <section class="phpdocumentor-constants">
  368. <h3 class="phpdocumentor-elements__header" id="constants">
  369. Constants
  370. <a href="classes/chillerlan-QRCode-Output-QREps.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  371. </h3>
  372. <article class="phpdocumentor-element -constant -public ">
  373. <h4 class="phpdocumentor-element__name" id="constant_MIME_TYPE">
  374. MIME_TYPE
  375. <a href="classes/chillerlan-QRCode-Output-QREps.html#constant_MIME_TYPE" class="headerlink"><i class="fas fa-link"></i></a>
  376. </h4>
  377. <aside class="phpdocumentor-element-found-in">
  378. <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>
  379. :
  380. <span class="phpdocumentor-element-found-in__line">25</span>
  381. </aside>
  382. <code class="phpdocumentor-signature phpdocumentor-code ">
  383. <span class="phpdocumentor-signature__visibility">public</span>
  384. <span class="phpdocumentor-signature__final">final</span> <span class="phpdocumentor-signature__type">mixed</span>
  385. <span class="phpdocumentor-signature__name">MIME_TYPE</span>
  386. = <span class="phpdocumentor-signature__default-value">&#039;application/postscript&#039;</span>
  387. </code>
  388. </article>
  389. </section>
  390. <section class="phpdocumentor-properties">
  391. <h3 class="phpdocumentor-elements__header" id="properties">
  392. Properties
  393. <a href="classes/chillerlan-QRCode-Output-QREps.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  394. </h3>
  395. <article
  396. class="
  397. phpdocumentor-element
  398. -property
  399. -protected
  400. "
  401. >
  402. <h4 class="phpdocumentor-element__name" id="property_circleDiameter">
  403. $circleDiameter
  404. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter" class="headerlink"><i class="fas fa-link"></i></a>
  405. <span class="phpdocumentor-element__modifiers">
  406. </span>
  407. </h4>
  408. <aside class="phpdocumentor-element-found-in">
  409. <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>
  410. :
  411. <span class="phpdocumentor-element-found-in__line">67</span>
  412. </aside>
  413. <code class="phpdocumentor-code phpdocumentor-signature ">
  414. <span class="phpdocumentor-signature__visibility">protected</span>
  415. <span class="phpdocumentor-signature__type">float</span>
  416. <span class="phpdocumentor-signature__name">$circleDiameter</span>
  417. </code>
  418. </article>
  419. <article
  420. class="
  421. phpdocumentor-element
  422. -property
  423. -protected
  424. "
  425. >
  426. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  427. $circleRadius
  428. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  429. <span class="phpdocumentor-element__modifiers">
  430. </span>
  431. </h4>
  432. <aside class="phpdocumentor-element-found-in">
  433. <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>
  434. :
  435. <span class="phpdocumentor-element-found-in__line">66</span>
  436. </aside>
  437. <code class="phpdocumentor-code phpdocumentor-signature ">
  438. <span class="phpdocumentor-signature__visibility">protected</span>
  439. <span class="phpdocumentor-signature__type">float</span>
  440. <span class="phpdocumentor-signature__name">$circleRadius</span>
  441. </code>
  442. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  443. Tags
  444. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius#tags" class="headerlink"><i class="fas fa-link"></i></a>
  445. </h5>
  446. <dl class="phpdocumentor-tag-list">
  447. <dt class="phpdocumentor-tag-list__entry">
  448. <span class="phpdocumentor-tag__name">see</span>
  449. </dt>
  450. <dd class="phpdocumentor-tag-list__definition">
  451. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$circleRadius">QROptions::$circleRadius</abbr></span>
  452. </dd>
  453. </dl>
  454. </article>
  455. <article
  456. class="
  457. phpdocumentor-element
  458. -property
  459. -protected
  460. "
  461. >
  462. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  463. $connectPaths
  464. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  465. <span class="phpdocumentor-element__modifiers">
  466. </span>
  467. </h4>
  468. <aside class="phpdocumentor-element-found-in">
  469. <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>
  470. :
  471. <span class="phpdocumentor-element-found-in__line">54</span>
  472. </aside>
  473. <code class="phpdocumentor-code phpdocumentor-signature ">
  474. <span class="phpdocumentor-signature__visibility">protected</span>
  475. <span class="phpdocumentor-signature__type">bool</span>
  476. <span class="phpdocumentor-signature__name">$connectPaths</span>
  477. </code>
  478. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  479. Tags
  480. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  481. </h5>
  482. <dl class="phpdocumentor-tag-list">
  483. <dt class="phpdocumentor-tag-list__entry">
  484. <span class="phpdocumentor-tag__name">see</span>
  485. </dt>
  486. <dd class="phpdocumentor-tag-list__definition">
  487. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$connectPaths">QROptions::$connectPaths</abbr></span>
  488. </dd>
  489. </dl>
  490. </article>
  491. <article
  492. class="
  493. phpdocumentor-element
  494. -property
  495. -protected
  496. "
  497. >
  498. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  499. $drawCircularModules
  500. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  501. <span class="phpdocumentor-element__modifiers">
  502. </span>
  503. </h4>
  504. <aside class="phpdocumentor-element-found-in">
  505. <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>
  506. :
  507. <span class="phpdocumentor-element-found-in__line">62</span>
  508. </aside>
  509. <code class="phpdocumentor-code phpdocumentor-signature ">
  510. <span class="phpdocumentor-signature__visibility">protected</span>
  511. <span class="phpdocumentor-signature__type">bool</span>
  512. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  513. </code>
  514. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  515. Tags
  516. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  517. </h5>
  518. <dl class="phpdocumentor-tag-list">
  519. <dt class="phpdocumentor-tag-list__entry">
  520. <span class="phpdocumentor-tag__name">see</span>
  521. </dt>
  522. <dd class="phpdocumentor-tag-list__definition">
  523. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawCircularModules">QROptions::$drawCircularModules</abbr></span>
  524. </dd>
  525. </dl>
  526. </article>
  527. <article
  528. class="
  529. phpdocumentor-element
  530. -property
  531. -protected
  532. "
  533. >
  534. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  535. $drawLightModules
  536. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  537. <span class="phpdocumentor-element__modifiers">
  538. </span>
  539. </h4>
  540. <aside class="phpdocumentor-element-found-in">
  541. <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>
  542. :
  543. <span class="phpdocumentor-element-found-in__line">60</span>
  544. </aside>
  545. <code class="phpdocumentor-code phpdocumentor-signature ">
  546. <span class="phpdocumentor-signature__visibility">protected</span>
  547. <span class="phpdocumentor-signature__type">bool</span>
  548. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  549. </code>
  550. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  551. Tags
  552. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  553. </h5>
  554. <dl class="phpdocumentor-tag-list">
  555. <dt class="phpdocumentor-tag-list__entry">
  556. <span class="phpdocumentor-tag__name">see</span>
  557. </dt>
  558. <dd class="phpdocumentor-tag-list__definition">
  559. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawLightModules">QROptions::$drawLightModules</abbr></span>
  560. </dd>
  561. </dl>
  562. </article>
  563. <article
  564. class="
  565. phpdocumentor-element
  566. -property
  567. -protected
  568. "
  569. >
  570. <h4 class="phpdocumentor-element__name" id="property_eol">
  571. $eol
  572. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  573. <span class="phpdocumentor-element__modifiers">
  574. </span>
  575. </h4>
  576. <aside class="phpdocumentor-element-found-in">
  577. <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>
  578. :
  579. <span class="phpdocumentor-element-found-in__line">58</span>
  580. </aside>
  581. <code class="phpdocumentor-code phpdocumentor-signature ">
  582. <span class="phpdocumentor-signature__visibility">protected</span>
  583. <span class="phpdocumentor-signature__type">string</span>
  584. <span class="phpdocumentor-signature__name">$eol</span>
  585. </code>
  586. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  587. Tags
  588. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol#tags" class="headerlink"><i class="fas fa-link"></i></a>
  589. </h5>
  590. <dl class="phpdocumentor-tag-list">
  591. <dt class="phpdocumentor-tag-list__entry">
  592. <span class="phpdocumentor-tag__name">see</span>
  593. </dt>
  594. <dd class="phpdocumentor-tag-list__definition">
  595. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$eol">QROptions::$eol</abbr></span>
  596. </dd>
  597. </dl>
  598. </article>
  599. <article
  600. class="
  601. phpdocumentor-element
  602. -property
  603. -protected
  604. "
  605. >
  606. <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
  607. $excludeFromConnect
  608. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  609. <span class="phpdocumentor-element__modifiers">
  610. </span>
  611. </h4>
  612. <aside class="phpdocumentor-element-found-in">
  613. <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>
  614. :
  615. <span class="phpdocumentor-element-found-in__line">56</span>
  616. </aside>
  617. <code class="phpdocumentor-code phpdocumentor-signature ">
  618. <span class="phpdocumentor-signature__visibility">protected</span>
  619. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  620. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  621. </code>
  622. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  623. Tags
  624. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect#tags" class="headerlink"><i class="fas fa-link"></i></a>
  625. </h5>
  626. <dl class="phpdocumentor-tag-list">
  627. <dt class="phpdocumentor-tag-list__entry">
  628. <span class="phpdocumentor-tag__name">see</span>
  629. </dt>
  630. <dd class="phpdocumentor-tag-list__definition">
  631. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$excludeFromConnect">QROptions::$excludeFromConnect</abbr></span>
  632. </dd>
  633. </dl>
  634. </article>
  635. <article
  636. class="
  637. phpdocumentor-element
  638. -property
  639. -protected
  640. "
  641. >
  642. <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
  643. $keepAsSquare
  644. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  645. <span class="phpdocumentor-element__modifiers">
  646. </span>
  647. </h4>
  648. <aside class="phpdocumentor-element-found-in">
  649. <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>
  650. :
  651. <span class="phpdocumentor-element-found-in__line">64</span>
  652. </aside>
  653. <code class="phpdocumentor-code phpdocumentor-signature ">
  654. <span class="phpdocumentor-signature__visibility">protected</span>
  655. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  656. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  657. </code>
  658. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  659. Tags
  660. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare#tags" class="headerlink"><i class="fas fa-link"></i></a>
  661. </h5>
  662. <dl class="phpdocumentor-tag-list">
  663. <dt class="phpdocumentor-tag-list__entry">
  664. <span class="phpdocumentor-tag__name">see</span>
  665. </dt>
  666. <dd class="phpdocumentor-tag-list__definition">
  667. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$keepAsSquare">QROptions::$keepAsSquare</abbr></span>
  668. </dd>
  669. </dl>
  670. </article>
  671. <article
  672. class="
  673. phpdocumentor-element
  674. -property
  675. -protected
  676. "
  677. >
  678. <h4 class="phpdocumentor-element__name" id="property_length">
  679. $length
  680. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  681. <span class="phpdocumentor-element__modifiers">
  682. </span>
  683. </h4>
  684. <aside class="phpdocumentor-element-found-in">
  685. <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>
  686. :
  687. <span class="phpdocumentor-element-found-in__line">34</span>
  688. </aside>
  689. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  690. <code class="phpdocumentor-code phpdocumentor-signature ">
  691. <span class="phpdocumentor-signature__visibility">protected</span>
  692. <span class="phpdocumentor-signature__type">int</span>
  693. <span class="phpdocumentor-signature__name">$length</span>
  694. </code>
  695. </article>
  696. <article
  697. class="
  698. phpdocumentor-element
  699. -property
  700. -protected
  701. "
  702. >
  703. <h4 class="phpdocumentor-element__name" id="property_matrix">
  704. $matrix
  705. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  706. <span class="phpdocumentor-element__modifiers">
  707. </span>
  708. </h4>
  709. <aside class="phpdocumentor-element-found-in">
  710. <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>
  711. :
  712. <span class="phpdocumentor-element-found-in__line">44</span>
  713. </aside>
  714. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  715. <code class="phpdocumentor-code phpdocumentor-signature ">
  716. <span class="phpdocumentor-signature__visibility">protected</span>
  717. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  718. <span class="phpdocumentor-signature__name">$matrix</span>
  719. </code>
  720. </article>
  721. <article
  722. class="
  723. phpdocumentor-element
  724. -property
  725. -protected
  726. "
  727. >
  728. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  729. $moduleCount
  730. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  731. <span class="phpdocumentor-element__modifiers">
  732. </span>
  733. </h4>
  734. <aside class="phpdocumentor-element-found-in">
  735. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  736. :
  737. <span class="phpdocumentor-element-found-in__line">29</span>
  738. </aside>
  739. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  740. <code class="phpdocumentor-code phpdocumentor-signature ">
  741. <span class="phpdocumentor-signature__visibility">protected</span>
  742. <span class="phpdocumentor-signature__type">int</span>
  743. <span class="phpdocumentor-signature__name">$moduleCount</span>
  744. </code>
  745. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  746. Tags
  747. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  748. </h5>
  749. <dl class="phpdocumentor-tag-list">
  750. <dt class="phpdocumentor-tag-list__entry">
  751. <span class="phpdocumentor-tag__name">see</span>
  752. </dt>
  753. <dd class="phpdocumentor-tag-list__definition">
  754. <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>
  755. </dd>
  756. </dl>
  757. </article>
  758. <article
  759. class="
  760. phpdocumentor-element
  761. -property
  762. -protected
  763. "
  764. >
  765. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  766. $moduleValues
  767. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  768. <span class="phpdocumentor-element__modifiers">
  769. </span>
  770. </h4>
  771. <aside class="phpdocumentor-element-found-in">
  772. <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>
  773. :
  774. <span class="phpdocumentor-element-found-in__line">39</span>
  775. </aside>
  776. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  777. <code class="phpdocumentor-code phpdocumentor-signature ">
  778. <span class="phpdocumentor-signature__visibility">protected</span>
  779. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  780. <span class="phpdocumentor-signature__name">$moduleValues</span>
  781. </code>
  782. </article>
  783. <article
  784. class="
  785. phpdocumentor-element
  786. -property
  787. -protected
  788. "
  789. >
  790. <h4 class="phpdocumentor-element__name" id="property_options">
  791. $options
  792. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  793. <span class="phpdocumentor-element__modifiers">
  794. </span>
  795. </h4>
  796. <aside class="phpdocumentor-element-found-in">
  797. <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>
  798. :
  799. <span class="phpdocumentor-element-found-in__line">49</span>
  800. </aside>
  801. <p class="phpdocumentor-summary">the options instance</p>
  802. <code class="phpdocumentor-code phpdocumentor-signature ">
  803. <span class="phpdocumentor-signature__visibility">protected</span>
  804. <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>
  805. <span class="phpdocumentor-signature__name">$options</span>
  806. </code>
  807. </article>
  808. <article
  809. class="
  810. phpdocumentor-element
  811. -property
  812. -protected
  813. "
  814. >
  815. <h4 class="phpdocumentor-element__name" id="property_scale">
  816. $scale
  817. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  818. <span class="phpdocumentor-element__modifiers">
  819. </span>
  820. </h4>
  821. <aside class="phpdocumentor-element-found-in">
  822. <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>
  823. :
  824. <span class="phpdocumentor-element-found-in__line">52</span>
  825. </aside>
  826. <code class="phpdocumentor-code phpdocumentor-signature ">
  827. <span class="phpdocumentor-signature__visibility">protected</span>
  828. <span class="phpdocumentor-signature__type">int</span>
  829. <span class="phpdocumentor-signature__name">$scale</span>
  830. </code>
  831. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  832. Tags
  833. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  834. </h5>
  835. <dl class="phpdocumentor-tag-list">
  836. <dt class="phpdocumentor-tag-list__entry">
  837. <span class="phpdocumentor-tag__name">see</span>
  838. </dt>
  839. <dd class="phpdocumentor-tag-list__definition">
  840. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  841. </dd>
  842. </dl>
  843. </article>
  844. </section>
  845. <section class="phpdocumentor-methods">
  846. <h3 class="phpdocumentor-elements__header" id="methods">
  847. Methods
  848. <a href="classes/chillerlan-QRCode-Output-QREps.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  849. </h3>
  850. <article
  851. class="phpdocumentor-element
  852. -method
  853. -public
  854. "
  855. >
  856. <h4 class="phpdocumentor-element__name" id="method___construct">
  857. __construct()
  858. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  859. </h4>
  860. <aside class="phpdocumentor-element-found-in">
  861. <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>
  862. :
  863. <span class="phpdocumentor-element-found-in__line">72</span>
  864. </aside>
  865. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  866. <code class="phpdocumentor-code phpdocumentor-signature ">
  867. <span class="phpdocumentor-signature__visibility">public</span>
  868. <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>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a>&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>
  869. <div class="phpdocumentor-label-line">
  870. </div>
  871. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  872. <dl class="phpdocumentor-argument-list">
  873. <dt class="phpdocumentor-argument-list__entry">
  874. <span class="phpdocumentor-signature__argument__name">$options</span>
  875. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  876. </dt>
  877. <dd class="phpdocumentor-argument-list__definition">
  878. </dd>
  879. <dt class="phpdocumentor-argument-list__entry">
  880. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  881. : <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>
  882. </dt>
  883. <dd class="phpdocumentor-argument-list__definition">
  884. </dd>
  885. </dl>
  886. </article>
  887. <article
  888. class="phpdocumentor-element
  889. -method
  890. -public
  891. "
  892. >
  893. <h4 class="phpdocumentor-element__name" id="method_dump">
  894. dump()
  895. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  896. </h4>
  897. <aside class="phpdocumentor-element-found-in">
  898. <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>
  899. :
  900. <span class="phpdocumentor-element-found-in__line">104</span>
  901. </aside>
  902. <p class="phpdocumentor-summary">Generates the output, optionally dumps it to a file, and returns it</p>
  903. <code class="phpdocumentor-code phpdocumentor-signature ">
  904. <span class="phpdocumentor-signature__visibility">public</span>
  905. <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>
  906. <div class="phpdocumentor-label-line">
  907. </div>
  908. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  909. <dl class="phpdocumentor-argument-list">
  910. <dt class="phpdocumentor-argument-list__entry">
  911. <span class="phpdocumentor-signature__argument__name">$file</span>
  912. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  913. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  914. <dd class="phpdocumentor-argument-list__definition">
  915. </dd>
  916. </dl>
  917. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  918. Tags
  919. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  920. </h5>
  921. <dl class="phpdocumentor-tag-list">
  922. <dt class="phpdocumentor-tag-list__entry">
  923. <span class="phpdocumentor-tag__name">inheritDoc</span>
  924. </dt>
  925. <dd class="phpdocumentor-tag-list__definition">
  926. </dd>
  927. </dl>
  928. <section>
  929. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  930. <span class="phpdocumentor-signature__response_type">string</span>
  931. </section>
  932. </article>
  933. <article
  934. class="phpdocumentor-element
  935. -method
  936. -public
  937. -static "
  938. >
  939. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  940. moduleValueIsValid()
  941. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_moduleValueIsValid" 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/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  945. :
  946. <span class="phpdocumentor-element-found-in__line">30</span>
  947. </aside>
  948. <p class="phpdocumentor-summary">Determines whether the given value is valid</p>
  949. <code class="phpdocumentor-code phpdocumentor-signature ">
  950. <span class="phpdocumentor-signature__visibility">public</span>
  951. <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>
  952. <div class="phpdocumentor-label-line">
  953. </div>
  954. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  955. <dl class="phpdocumentor-argument-list">
  956. <dt class="phpdocumentor-argument-list__entry">
  957. <span class="phpdocumentor-signature__argument__name">$value</span>
  958. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  959. </dt>
  960. <dd class="phpdocumentor-argument-list__definition">
  961. </dd>
  962. </dl>
  963. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  964. Tags
  965. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_moduleValueIsValid#tags" class="headerlink"><i class="fas fa-link"></i></a>
  966. </h5>
  967. <dl class="phpdocumentor-tag-list">
  968. <dt class="phpdocumentor-tag-list__entry">
  969. <span class="phpdocumentor-tag__name">inheritDoc</span>
  970. </dt>
  971. <dd class="phpdocumentor-tag-list__definition">
  972. </dd>
  973. </dl>
  974. <section>
  975. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  976. <span class="phpdocumentor-signature__response_type">bool</span>
  977. </section>
  978. </article>
  979. <article
  980. class="phpdocumentor-element
  981. -method
  982. -protected
  983. "
  984. >
  985. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  986. collectModules()
  987. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  988. </h4>
  989. <aside class="phpdocumentor-element-found-in">
  990. <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>
  991. :
  992. <span class="phpdocumentor-element-found-in__line">221</span>
  993. </aside>
  994. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  995. returns an array with the transformed modules</p>
  996. <code class="phpdocumentor-code phpdocumentor-signature ">
  997. <span class="phpdocumentor-signature__visibility">protected</span>
  998. <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>
  999. <div class="phpdocumentor-label-line">
  1000. </div>
  1001. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  1002. <p>$x - current column
  1003. $y - current row
  1004. $M_TYPE - field value
  1005. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  1006. </section>
  1007. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1008. <dl class="phpdocumentor-argument-list">
  1009. <dt class="phpdocumentor-argument-list__entry">
  1010. <span class="phpdocumentor-signature__argument__name">$transform</span>
  1011. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  1012. </dt>
  1013. <dd class="phpdocumentor-argument-list__definition">
  1014. </dd>
  1015. </dl>
  1016. <section>
  1017. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1018. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1019. </section>
  1020. </article>
  1021. <article
  1022. class="phpdocumentor-element
  1023. -method
  1024. -protected
  1025. "
  1026. >
  1027. <h4 class="phpdocumentor-element__name" id="method_copyVars">
  1028. copyVars()
  1029. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars" class="headerlink"><i class="fas fa-link"></i></a>
  1030. </h4>
  1031. <aside class="phpdocumentor-element-found-in">
  1032. <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>
  1033. :
  1034. <span class="phpdocumentor-element-found-in__line">91</span>
  1035. </aside>
  1036. <p class="phpdocumentor-summary">Creates copies of several QROptions values to avoid calling the magic getters
  1037. in long loops for a significant performance increase.</p>
  1038. <code class="phpdocumentor-code phpdocumentor-signature ">
  1039. <span class="phpdocumentor-signature__visibility">protected</span>
  1040. <span class="phpdocumentor-signature__name">copyVars</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1041. <div class="phpdocumentor-label-line">
  1042. </div>
  1043. <section class="phpdocumentor-description"><p>These variables are usually used in the &quot;module&quot; methods and are called up to 31329 times (at version 40).</p>
  1044. </section>
  1045. </article>
  1046. <article
  1047. class="phpdocumentor-element
  1048. -method
  1049. -protected
  1050. "
  1051. >
  1052. <h4 class="phpdocumentor-element__name" id="method_formatColor">
  1053. formatColor()
  1054. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_formatColor" class="headerlink"><i class="fas fa-link"></i></a>
  1055. </h4>
  1056. <aside class="phpdocumentor-element-found-in">
  1057. <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>
  1058. :
  1059. <span class="phpdocumentor-element-found-in__line">85</span>
  1060. </aside>
  1061. <p class="phpdocumentor-summary">Set the color format string</p>
  1062. <code class="phpdocumentor-code phpdocumentor-signature ">
  1063. <span class="phpdocumentor-signature__visibility">protected</span>
  1064. <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>
  1065. <div class="phpdocumentor-label-line">
  1066. </div>
  1067. <section class="phpdocumentor-description"><p>4 values in the color array will be interpreted as CMYK, 3 as RGB</p>
  1068. </section>
  1069. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1070. <dl class="phpdocumentor-argument-list">
  1071. <dt class="phpdocumentor-argument-list__entry">
  1072. <span class="phpdocumentor-signature__argument__name">$values</span>
  1073. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  1074. </dt>
  1075. <dd class="phpdocumentor-argument-list__definition">
  1076. </dd>
  1077. </dl>
  1078. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1079. Tags
  1080. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_formatColor#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1081. </h5>
  1082. <dl class="phpdocumentor-tag-list">
  1083. <dt class="phpdocumentor-tag-list__entry">
  1084. <span class="phpdocumentor-tag__name">throws</span>
  1085. </dt>
  1086. <dd class="phpdocumentor-tag-list__definition">
  1087. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1088. </dd>
  1089. </dl>
  1090. <section>
  1091. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1092. <span class="phpdocumentor-signature__response_type">string</span>
  1093. </section>
  1094. </article>
  1095. <article
  1096. class="phpdocumentor-element
  1097. -method
  1098. -protected
  1099. "
  1100. >
  1101. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  1102. getDefaultModuleValue()
  1103. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1104. </h4>
  1105. <aside class="phpdocumentor-element-found-in">
  1106. <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>
  1107. :
  1108. <span class="phpdocumentor-element-found-in__line">74</span>
  1109. </aside>
  1110. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output class)</p>
  1111. <code class="phpdocumentor-code phpdocumentor-signature ">
  1112. <span class="phpdocumentor-signature__visibility">protected</span>
  1113. <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">string</span></code>
  1114. <div class="phpdocumentor-label-line">
  1115. </div>
  1116. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1117. <dl class="phpdocumentor-argument-list">
  1118. <dt class="phpdocumentor-argument-list__entry">
  1119. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  1120. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1121. </dt>
  1122. <dd class="phpdocumentor-argument-list__definition">
  1123. </dd>
  1124. </dl>
  1125. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1126. Tags
  1127. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getDefaultModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1128. </h5>
  1129. <dl class="phpdocumentor-tag-list">
  1130. <dt class="phpdocumentor-tag-list__entry">
  1131. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1132. </dt>
  1133. <dd class="phpdocumentor-tag-list__definition">
  1134. </dd>
  1135. </dl>
  1136. <section>
  1137. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1138. <span class="phpdocumentor-signature__response_type">string</span>
  1139. </section>
  1140. </article>
  1141. <article
  1142. class="phpdocumentor-element
  1143. -method
  1144. -protected
  1145. "
  1146. >
  1147. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  1148. getModuleValue()
  1149. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1150. </h4>
  1151. <aside class="phpdocumentor-element-found-in">
  1152. <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>
  1153. :
  1154. <span class="phpdocumentor-element-found-in__line">164</span>
  1155. </aside>
  1156. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  1157. <code class="phpdocumentor-code phpdocumentor-signature ">
  1158. <span class="phpdocumentor-signature__visibility">protected</span>
  1159. <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</span></code>
  1160. <div class="phpdocumentor-label-line">
  1161. </div>
  1162. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1163. <dl class="phpdocumentor-argument-list">
  1164. <dt class="phpdocumentor-argument-list__entry">
  1165. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1166. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1167. </dt>
  1168. <dd class="phpdocumentor-argument-list__definition">
  1169. </dd>
  1170. </dl>
  1171. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1172. Tags
  1173. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1174. </h5>
  1175. <dl class="phpdocumentor-tag-list">
  1176. <dt class="phpdocumentor-tag-list__entry">
  1177. <span class="phpdocumentor-tag__name">throws</span>
  1178. </dt>
  1179. <dd class="phpdocumentor-tag-list__definition">
  1180. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1181. <section class="phpdocumentor-description"><p>if $moduleValues[$M_TYPE] doesn't exist</p>
  1182. </section>
  1183. </dd>
  1184. </dl>
  1185. </article>
  1186. <article
  1187. class="phpdocumentor-element
  1188. -method
  1189. -protected
  1190. "
  1191. >
  1192. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  1193. getModuleValueAt()
  1194. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  1195. </h4>
  1196. <aside class="phpdocumentor-element-found-in">
  1197. <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>
  1198. :
  1199. <span class="phpdocumentor-element-found-in__line">176</span>
  1200. </aside>
  1201. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  1202. <code class="phpdocumentor-code phpdocumentor-signature ">
  1203. <span class="phpdocumentor-signature__visibility">protected</span>
  1204. <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</span></code>
  1205. <div class="phpdocumentor-label-line">
  1206. </div>
  1207. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1208. <dl class="phpdocumentor-argument-list">
  1209. <dt class="phpdocumentor-argument-list__entry">
  1210. <span class="phpdocumentor-signature__argument__name">$x</span>
  1211. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1212. </dt>
  1213. <dd class="phpdocumentor-argument-list__definition">
  1214. </dd>
  1215. <dt class="phpdocumentor-argument-list__entry">
  1216. <span class="phpdocumentor-signature__argument__name">$y</span>
  1217. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1218. </dt>
  1219. <dd class="phpdocumentor-argument-list__definition">
  1220. </dd>
  1221. </dl>
  1222. </article>
  1223. <article
  1224. class="phpdocumentor-element
  1225. -method
  1226. -protected
  1227. "
  1228. >
  1229. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  1230. getOutputDimensions()
  1231. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1232. </h4>
  1233. <aside class="phpdocumentor-element-found-in">
  1234. <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>
  1235. :
  1236. <span class="phpdocumentor-element-found-in__line">126</span>
  1237. </aside>
  1238. <p class="phpdocumentor-summary">Returns a 2 element array with the current output width and height</p>
  1239. <code class="phpdocumentor-code phpdocumentor-signature ">
  1240. <span class="phpdocumentor-signature__visibility">protected</span>
  1241. <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>
  1242. <div class="phpdocumentor-label-line">
  1243. </div>
  1244. <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>
  1245. </section>
  1246. <section>
  1247. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1248. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1249. </section>
  1250. </article>
  1251. <article
  1252. class="phpdocumentor-element
  1253. -method
  1254. -protected
  1255. "
  1256. >
  1257. <h4 class="phpdocumentor-element__name" id="method_module">
  1258. module()
  1259. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  1260. </h4>
  1261. <aside class="phpdocumentor-element-found-in">
  1262. <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>
  1263. :
  1264. <span class="phpdocumentor-element-found-in__line">156</span>
  1265. </aside>
  1266. <p class="phpdocumentor-summary">Returns a path segment for a single module</p>
  1267. <code class="phpdocumentor-code phpdocumentor-signature ">
  1268. <span class="phpdocumentor-signature__visibility">protected</span>
  1269. <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>
  1270. <div class="phpdocumentor-label-line">
  1271. </div>
  1272. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1273. <dl class="phpdocumentor-argument-list">
  1274. <dt class="phpdocumentor-argument-list__entry">
  1275. <span class="phpdocumentor-signature__argument__name">$x</span>
  1276. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1277. </dt>
  1278. <dd class="phpdocumentor-argument-list__definition">
  1279. </dd>
  1280. <dt class="phpdocumentor-argument-list__entry">
  1281. <span class="phpdocumentor-signature__argument__name">$y</span>
  1282. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1283. </dt>
  1284. <dd class="phpdocumentor-argument-list__definition">
  1285. </dd>
  1286. <dt class="phpdocumentor-argument-list__entry">
  1287. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1288. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1289. </dt>
  1290. <dd class="phpdocumentor-argument-list__definition">
  1291. </dd>
  1292. </dl>
  1293. <section>
  1294. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1295. <span class="phpdocumentor-signature__response_type">string</span>
  1296. </section>
  1297. </article>
  1298. <article
  1299. class="phpdocumentor-element
  1300. -method
  1301. -protected
  1302. "
  1303. >
  1304. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  1305. prepareModuleValue()
  1306. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1307. </h4>
  1308. <aside class="phpdocumentor-element-found-in">
  1309. <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>
  1310. :
  1311. <span class="phpdocumentor-element-found-in__line">55</span>
  1312. </aside>
  1313. <p class="phpdocumentor-summary">Prepares the value for the given input (return value depends on the output class)</p>
  1314. <code class="phpdocumentor-code phpdocumentor-signature ">
  1315. <span class="phpdocumentor-signature__visibility">protected</span>
  1316. <span class="phpdocumentor-signature__name">prepareModuleValue</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">string</span></code>
  1317. <div class="phpdocumentor-label-line">
  1318. </div>
  1319. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1320. <dl class="phpdocumentor-argument-list">
  1321. <dt class="phpdocumentor-argument-list__entry">
  1322. <span class="phpdocumentor-signature__argument__name">$value</span>
  1323. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1324. </dt>
  1325. <dd class="phpdocumentor-argument-list__definition">
  1326. </dd>
  1327. </dl>
  1328. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1329. Tags
  1330. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_prepareModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1331. </h5>
  1332. <dl class="phpdocumentor-tag-list">
  1333. <dt class="phpdocumentor-tag-list__entry">
  1334. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1335. </dt>
  1336. <dd class="phpdocumentor-tag-list__definition">
  1337. </dd>
  1338. </dl>
  1339. <section>
  1340. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1341. <span class="phpdocumentor-signature__response_type">string</span>
  1342. </section>
  1343. </article>
  1344. <article
  1345. class="phpdocumentor-element
  1346. -method
  1347. -protected
  1348. "
  1349. >
  1350. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1351. saveToFile()
  1352. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1353. </h4>
  1354. <aside class="phpdocumentor-element-found-in">
  1355. <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>
  1356. :
  1357. <span class="phpdocumentor-element-found-in__line">195</span>
  1358. </aside>
  1359. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1360. <code class="phpdocumentor-code phpdocumentor-signature ">
  1361. <span class="phpdocumentor-signature__visibility">protected</span>
  1362. <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>
  1363. <div class="phpdocumentor-label-line">
  1364. </div>
  1365. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1366. <dl class="phpdocumentor-argument-list">
  1367. <dt class="phpdocumentor-argument-list__entry">
  1368. <span class="phpdocumentor-signature__argument__name">$data</span>
  1369. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1370. </dt>
  1371. <dd class="phpdocumentor-argument-list__definition">
  1372. </dd>
  1373. <dt class="phpdocumentor-argument-list__entry">
  1374. <span class="phpdocumentor-signature__argument__name">$file</span>
  1375. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1376. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1377. <dd class="phpdocumentor-argument-list__definition">
  1378. </dd>
  1379. </dl>
  1380. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1381. Tags
  1382. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1383. </h5>
  1384. <dl class="phpdocumentor-tag-list">
  1385. <dt class="phpdocumentor-tag-list__entry">
  1386. <span class="phpdocumentor-tag__name">see</span>
  1387. </dt>
  1388. <dd class="phpdocumentor-tag-list__definition">
  1389. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1390. </dd>
  1391. <dt class="phpdocumentor-tag-list__entry">
  1392. <span class="phpdocumentor-tag__name">see</span>
  1393. </dt>
  1394. <dd class="phpdocumentor-tag-list__definition">
  1395. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1396. </dd>
  1397. <dt class="phpdocumentor-tag-list__entry">
  1398. <span class="phpdocumentor-tag__name">throws</span>
  1399. </dt>
  1400. <dd class="phpdocumentor-tag-list__definition">
  1401. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1402. </dd>
  1403. </dl>
  1404. </article>
  1405. <article
  1406. class="phpdocumentor-element
  1407. -method
  1408. -protected
  1409. "
  1410. >
  1411. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1412. setMatrixDimensions()
  1413. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1414. </h4>
  1415. <aside class="phpdocumentor-element-found-in">
  1416. <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>
  1417. :
  1418. <span class="phpdocumentor-element-found-in__line">115</span>
  1419. </aside>
  1420. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1421. <code class="phpdocumentor-code phpdocumentor-signature ">
  1422. <span class="phpdocumentor-signature__visibility">protected</span>
  1423. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1424. <div class="phpdocumentor-label-line">
  1425. </div>
  1426. <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>
  1427. </section>
  1428. </article>
  1429. <article
  1430. class="phpdocumentor-element
  1431. -method
  1432. -protected
  1433. "
  1434. >
  1435. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1436. setModuleValues()
  1437. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1438. </h4>
  1439. <aside class="phpdocumentor-element-found-in">
  1440. <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>
  1441. :
  1442. <span class="phpdocumentor-element-found-in__line">133</span>
  1443. </aside>
  1444. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1445. <code class="phpdocumentor-code phpdocumentor-signature ">
  1446. <span class="phpdocumentor-signature__visibility">protected</span>
  1447. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1448. <div class="phpdocumentor-label-line">
  1449. </div>
  1450. </article>
  1451. <article
  1452. class="phpdocumentor-element
  1453. -method
  1454. -protected
  1455. "
  1456. >
  1457. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1458. toBase64DataURI()
  1459. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1460. </h4>
  1461. <aside class="phpdocumentor-element-found-in">
  1462. <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>
  1463. :
  1464. <span class="phpdocumentor-element-found-in__line">183</span>
  1465. </aside>
  1466. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1467. <code class="phpdocumentor-code phpdocumentor-signature ">
  1468. <span class="phpdocumentor-signature__visibility">protected</span>
  1469. <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>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</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>
  1470. <div class="phpdocumentor-label-line">
  1471. </div>
  1472. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1473. <dl class="phpdocumentor-argument-list">
  1474. <dt class="phpdocumentor-argument-list__entry">
  1475. <span class="phpdocumentor-signature__argument__name">$data</span>
  1476. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1477. </dt>
  1478. <dd class="phpdocumentor-argument-list__definition">
  1479. </dd>
  1480. <dt class="phpdocumentor-argument-list__entry">
  1481. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1482. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1483. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1484. <dd class="phpdocumentor-argument-list__definition">
  1485. </dd>
  1486. </dl>
  1487. <section>
  1488. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1489. <span class="phpdocumentor-signature__response_type">string</span>
  1490. </section>
  1491. </article>
  1492. </section>
  1493. <div class="phpdocumentor-modal" id="source-view">
  1494. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1495. <div class="phpdocumentor-modal-container">
  1496. <div class="phpdocumentor-modal-content">
  1497. <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>
  1498. </div>
  1499. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1500. </div>
  1501. </div>
  1502. <script type="text/javascript">
  1503. (function () {
  1504. function loadExternalCodeSnippet(el, url, line) {
  1505. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1506. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1507. const language = 'php';
  1508. const code = document.createElement('code');
  1509. code.className = 'language-' + language;
  1510. pre.textContent = '';
  1511. pre.setAttribute('data-line', line)
  1512. code.textContent = 'Loading…';
  1513. pre.appendChild(code);
  1514. var xhr = new XMLHttpRequest();
  1515. xhr.open('GET', src, true);
  1516. xhr.onreadystatechange = function () {
  1517. if (xhr.readyState !== 4) {
  1518. return;
  1519. }
  1520. if (xhr.status < 400 && xhr.responseText) {
  1521. code.textContent = xhr.responseText;
  1522. Prism.highlightElement(code);
  1523. return;
  1524. }
  1525. if (xhr.status === 404) {
  1526. code.textContent = '✖ Error: File could not be found';
  1527. return;
  1528. }
  1529. if (xhr.status >= 400) {
  1530. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1531. return;
  1532. }
  1533. code.textContent = '✖ Error: An unknown error occurred';
  1534. };
  1535. xhr.send(null);
  1536. });
  1537. }
  1538. const modalButtons = document.querySelectorAll("[data-modal]");
  1539. const openedAsLocalFile = window.location.protocol === 'file:';
  1540. if (modalButtons.length > 0 && openedAsLocalFile) {
  1541. console.warn(
  1542. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1543. 'browsers block XHR requests when a page is opened this way'
  1544. );
  1545. }
  1546. modalButtons.forEach(function (trigger) {
  1547. if (openedAsLocalFile) {
  1548. trigger.setAttribute("hidden", "hidden");
  1549. }
  1550. trigger.addEventListener("click", function (event) {
  1551. event.preventDefault();
  1552. const modal = document.getElementById(trigger.dataset.modal);
  1553. if (!modal) {
  1554. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1555. return;
  1556. }
  1557. modal.classList.add("phpdocumentor-modal__open");
  1558. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1559. const exits = modal.querySelectorAll("[data-exit-button]");
  1560. exits.forEach(function (exit) {
  1561. exit.addEventListener("click", function (event) {
  1562. event.preventDefault();
  1563. modal.classList.remove("phpdocumentor-modal__open");
  1564. });
  1565. });
  1566. });
  1567. });
  1568. })();
  1569. </script>
  1570. </article>
  1571. </section>
  1572. <section class="phpdocumentor-on-this-page__sidebar">
  1573. <section class="phpdocumentor-on-this-page__content">
  1574. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1575. <ul class="phpdocumentor-list -clean">
  1576. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1577. <li>
  1578. <ul class="phpdocumentor-list -clean">
  1579. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#toc-constants">Constants</a></li>
  1580. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#toc-properties">Properties</a></li>
  1581. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#toc-methods">Methods</a></li>
  1582. </ul>
  1583. </li>
  1584. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  1585. <li>
  1586. <ul class="phpdocumentor-list -clean">
  1587. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#constant_MIME_TYPE">MIME_TYPE</a></li>
  1588. </ul>
  1589. </li>
  1590. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1591. <li>
  1592. <ul class="phpdocumentor-list -clean">
  1593. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1594. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1595. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1596. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1597. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1598. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1599. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1600. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1601. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1602. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1603. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1604. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1605. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1606. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QREps.html"></li>
  1607. </ul>
  1608. </li>
  1609. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1610. <li>
  1611. <ul class="phpdocumentor-list -clean">
  1612. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a></li>
  1613. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#method_dump">dump()</a></li>
  1614. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  1615. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1616. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a></li>
  1617. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#method_formatColor">formatColor()</a></li>
  1618. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1619. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1620. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1621. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1622. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#method_module">module()</a></li>
  1623. <li><a href="classes/chillerlan-QRCode-Output-QREps.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1624. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1625. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1626. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1627. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1628. </ul>
  1629. </li>
  1630. </ul>
  1631. </section>
  1632. </section>
  1633. </div>
  1634. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1635. <section class="phpdocumentor-search-results__dialog">
  1636. <header class="phpdocumentor-search-results__header">
  1637. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1638. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1639. </header>
  1640. <section class="phpdocumentor-search-results__body">
  1641. <ul class="phpdocumentor-search-results__entries"></ul>
  1642. </section>
  1643. </section>
  1644. </section>
  1645. </div>
  1646. <a href="classes/chillerlan-QRCode-Output-QREps.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1647. </main>
  1648. <script>
  1649. cssVars({});
  1650. </script>
  1651. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1652. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1653. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1654. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1655. </body>
  1656. </html>