chillerlan-QRCode-Output-QRMarkupXML.html 116 KB

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