chillerlan-QRCode-Output-QRMarkupXML.html 113 KB

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