chillerlan-QRCode-Output-QREps.html 104 KB

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