chillerlan-QRCode-Output-QRMarkup.html 102 KB

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