chillerlan-QRCode-Output-QRMarkupHTML.html 104 KB

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