chillerlan-QRCode-Output-QRMarkupHTML.html 104 KB

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