chillerlan-QRCode-Output-QRMarkupXML.html 124 KB

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