chillerlan-QRCode-Output-QREps.html 104 KB

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