chillerlan-QRCode-Output-QRMarkup.html 77 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572
  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. </section>
  82. <section class="phpdocumentor-sidebar__category">
  83. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  84. <h4 class="phpdocumentor-sidebar__root-namespace">
  85. <a href="packages/Application.html" class="">Application</a>
  86. </h4>
  87. </section>
  88. <section class="phpdocumentor-sidebar__category">
  89. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  92. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  93. </section>
  94. <section class="phpdocumentor-sidebar__category">
  95. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  96. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  97. </section>
  98. </aside>
  99. <div class="phpdocumentor-column -nine phpdocumentor-content">
  100. <section>
  101. <ul class="phpdocumentor-breadcrumbs">
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  103. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  104. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  105. </ul>
  106. <article class="phpdocumentor-element -class">
  107. <h2 class="phpdocumentor-content__title">
  108. QRMarkup
  109. <span class="phpdocumentor-element__extends">
  110. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  111. </span>
  112. <div class="phpdocumentor-element__package">
  113. in package
  114. <ul class="phpdocumentor-breadcrumbs">
  115. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  116. </ul>
  117. </div>
  118. </h2>
  119. <div class="phpdocumentor-label-line">
  120. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Abstract</span><span>Yes</span></div>
  121. </div>
  122. <aside class="phpdocumentor-element-found-in">
  123. <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>
  124. :
  125. <span class="phpdocumentor-element-found-in__line">18</span>
  126. </aside>
  127. <p class="phpdocumentor-summary">Abstract for markup types: HTML, SVG, ... XML anyone?</p>
  128. <h3 id="toc">
  129. Table of Contents
  130. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  131. </h3>
  132. <h4 id="toc-properties">
  133. Properties
  134. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  135. </h4>
  136. <dl class="phpdocumentor-table-of-contents">
  137. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  138. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  139. <span>
  140. &nbsp;: int </span>
  141. </dt>
  142. <dd>the side length of the QR image (modules * scale)</dd>
  143. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  144. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  145. <span>
  146. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  147. </dt>
  148. <dd>the (filled) data matrix object</dd>
  149. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  150. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  151. <span>
  152. &nbsp;: int </span>
  153. </dt>
  154. <dd>the current size of the QR matrix</dd>
  155. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  156. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  157. <span>
  158. &nbsp;: array&lt;string|int, mixed&gt; </span>
  159. </dt>
  160. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  161. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  162. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  163. <span>
  164. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  165. </dt>
  166. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  167. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  168. <span>
  169. &nbsp;: int </span>
  170. </dt>
  171. <dd>the current scaling for a QR pixel</dd>
  172. </dl>
  173. <h4 id="toc-methods">
  174. Methods
  175. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  176. </h4>
  177. <dl class="phpdocumentor-table-of-contents">
  178. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  179. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  180. <span>
  181. &nbsp;: mixed </span>
  182. </dt>
  183. <dd>QROutputAbstract constructor.</dd>
  184. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  185. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump">dump()</a>
  186. <span>
  187. &nbsp;: string </span>
  188. </dt>
  189. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  190. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  191. <span>
  192. &nbsp;: bool </span>
  193. </dt>
  194. <dd>note: we&#039;re not necessarily validating the several values, just checking the general syntax
  195. note: css4 colors are not included</dd>
  196. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  197. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  198. <span>
  199. &nbsp;: array&lt;string|int, mixed&gt; </span>
  200. </dt>
  201. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  202. returns an array with the transformed modules</dd>
  203. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  204. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_createMarkup">createMarkup()</a>
  205. <span>
  206. &nbsp;: string </span>
  207. </dt>
  208. <dd>returns the fully parsed and rendered markup string for the given input</dd>
  209. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  210. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_getCssClass">getCssClass()</a>
  211. <span>
  212. &nbsp;: string </span>
  213. </dt>
  214. <dd>returns a string with all css classes for the current element</dd>
  215. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  216. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  217. <span>
  218. &nbsp;: mixed|null </span>
  219. </dt>
  220. <dd>Returns a default value for either dark or light modules</dd>
  221. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  222. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  223. <span>
  224. &nbsp;: mixed|null </span>
  225. </dt>
  226. <dd>Returns the prepared value for the given $M_TYPE</dd>
  227. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  228. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  229. <span>
  230. &nbsp;: mixed|null </span>
  231. </dt>
  232. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  233. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  234. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a>
  235. <span>
  236. &nbsp;: array&lt;string|int, mixed&gt; </span>
  237. </dt>
  238. <dd>Returns a 2 element array with the current output width and height</dd>
  239. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  240. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_prepareModuleValue">prepareModuleValue()</a>
  241. <span>
  242. &nbsp;: mixed|null </span>
  243. </dt>
  244. <dd>Prepares the value for the given input ()</dd>
  245. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  246. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  247. <span>
  248. &nbsp;: void </span>
  249. </dt>
  250. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  251. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  252. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  253. <span>
  254. &nbsp;: void </span>
  255. </dt>
  256. <dd>Sets/updates the matrix dimensions</dd>
  257. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  258. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  259. <span>
  260. &nbsp;: void </span>
  261. </dt>
  262. <dd>Sets the initial module values</dd>
  263. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  264. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  265. <span>
  266. &nbsp;: string </span>
  267. </dt>
  268. <dd>Returns a base64 data URI for the given string and mime type</dd>
  269. </dl>
  270. <section class="phpdocumentor-properties">
  271. <h3 class="phpdocumentor-elements__header" id="properties">
  272. Properties
  273. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  274. </h3>
  275. <article
  276. class="
  277. phpdocumentor-element
  278. -property
  279. -protected
  280. "
  281. >
  282. <h4 class="phpdocumentor-element__name" id="property_length">
  283. $length
  284. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  285. <span class="phpdocumentor-element__modifiers">
  286. </span>
  287. </h4>
  288. <aside class="phpdocumentor-element-found-in">
  289. <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>
  290. :
  291. <span class="phpdocumentor-element-found-in__line">40</span>
  292. </aside>
  293. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  294. <code class="phpdocumentor-code phpdocumentor-signature ">
  295. <span class="phpdocumentor-signature__visibility">protected</span>
  296. <span class="phpdocumentor-signature__type">int</span>
  297. <span class="phpdocumentor-signature__name">$length</span>
  298. </code>
  299. </article>
  300. <article
  301. class="
  302. phpdocumentor-element
  303. -property
  304. -protected
  305. "
  306. >
  307. <h4 class="phpdocumentor-element__name" id="property_matrix">
  308. $matrix
  309. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  310. <span class="phpdocumentor-element__modifiers">
  311. </span>
  312. </h4>
  313. <aside class="phpdocumentor-element-found-in">
  314. <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>
  315. :
  316. <span class="phpdocumentor-element-found-in__line">50</span>
  317. </aside>
  318. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  319. <code class="phpdocumentor-code phpdocumentor-signature ">
  320. <span class="phpdocumentor-signature__visibility">protected</span>
  321. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  322. <span class="phpdocumentor-signature__name">$matrix</span>
  323. </code>
  324. </article>
  325. <article
  326. class="
  327. phpdocumentor-element
  328. -property
  329. -protected
  330. "
  331. >
  332. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  333. $moduleCount
  334. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  335. <span class="phpdocumentor-element__modifiers">
  336. </span>
  337. </h4>
  338. <aside class="phpdocumentor-element-found-in">
  339. <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>
  340. :
  341. <span class="phpdocumentor-element-found-in__line">28</span>
  342. </aside>
  343. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  344. <code class="phpdocumentor-code phpdocumentor-signature ">
  345. <span class="phpdocumentor-signature__visibility">protected</span>
  346. <span class="phpdocumentor-signature__type">int</span>
  347. <span class="phpdocumentor-signature__name">$moduleCount</span>
  348. </code>
  349. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  350. Tags
  351. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  352. </h5>
  353. <dl class="phpdocumentor-tag-list">
  354. <dt class="phpdocumentor-tag-list__entry">
  355. <span class="phpdocumentor-tag__name">see</span>
  356. </dt>
  357. <dd class="phpdocumentor-tag-list__definition">
  358. <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>
  359. </dd>
  360. </dl>
  361. </article>
  362. <article
  363. class="
  364. phpdocumentor-element
  365. -property
  366. -protected
  367. "
  368. >
  369. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  370. $moduleValues
  371. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  372. <span class="phpdocumentor-element__modifiers">
  373. </span>
  374. </h4>
  375. <aside class="phpdocumentor-element-found-in">
  376. <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>
  377. :
  378. <span class="phpdocumentor-element-found-in__line">45</span>
  379. </aside>
  380. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  381. <code class="phpdocumentor-code phpdocumentor-signature ">
  382. <span class="phpdocumentor-signature__visibility">protected</span>
  383. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  384. <span class="phpdocumentor-signature__name">$moduleValues</span>
  385. </code>
  386. </article>
  387. <article
  388. class="
  389. phpdocumentor-element
  390. -property
  391. -protected
  392. "
  393. >
  394. <h4 class="phpdocumentor-element__name" id="property_options">
  395. $options
  396. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  397. <span class="phpdocumentor-element__modifiers">
  398. </span>
  399. </h4>
  400. <aside class="phpdocumentor-element-found-in">
  401. <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>
  402. :
  403. <span class="phpdocumentor-element-found-in__line">55</span>
  404. </aside>
  405. <code class="phpdocumentor-code phpdocumentor-signature ">
  406. <span class="phpdocumentor-signature__visibility">protected</span>
  407. <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>
  408. <span class="phpdocumentor-signature__name">$options</span>
  409. </code>
  410. </article>
  411. <article
  412. class="
  413. phpdocumentor-element
  414. -property
  415. -protected
  416. "
  417. >
  418. <h4 class="phpdocumentor-element__name" id="property_scale">
  419. $scale
  420. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  421. <span class="phpdocumentor-element__modifiers">
  422. </span>
  423. </h4>
  424. <aside class="phpdocumentor-element-found-in">
  425. <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>
  426. :
  427. <span class="phpdocumentor-element-found-in__line">35</span>
  428. </aside>
  429. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  430. <code class="phpdocumentor-code phpdocumentor-signature ">
  431. <span class="phpdocumentor-signature__visibility">protected</span>
  432. <span class="phpdocumentor-signature__type">int</span>
  433. <span class="phpdocumentor-signature__name">$scale</span>
  434. </code>
  435. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  436. Tags
  437. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  438. </h5>
  439. <dl class="phpdocumentor-tag-list">
  440. <dt class="phpdocumentor-tag-list__entry">
  441. <span class="phpdocumentor-tag__name">see</span>
  442. </dt>
  443. <dd class="phpdocumentor-tag-list__definition">
  444. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  445. </dd>
  446. </dl>
  447. </article>
  448. </section>
  449. <section class="phpdocumentor-methods">
  450. <h3 class="phpdocumentor-elements__header" id="methods">
  451. Methods
  452. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  453. </h3>
  454. <article
  455. class="phpdocumentor-element
  456. -method
  457. -public
  458. "
  459. >
  460. <h4 class="phpdocumentor-element__name" id="method___construct">
  461. __construct()
  462. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  463. </h4>
  464. <aside class="phpdocumentor-element-found-in">
  465. <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>
  466. :
  467. <span class="phpdocumentor-element-found-in__line">60</span>
  468. </aside>
  469. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  470. <code class="phpdocumentor-code phpdocumentor-signature ">
  471. <span class="phpdocumentor-signature__visibility">public</span>
  472. <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>&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>
  473. <div class="phpdocumentor-label-line">
  474. </div>
  475. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  476. <dl class="phpdocumentor-argument-list">
  477. <dt class="phpdocumentor-argument-list__entry">
  478. <span class="phpdocumentor-signature__argument__name">$options</span>
  479. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  480. </dt>
  481. <dd class="phpdocumentor-argument-list__definition">
  482. </dd>
  483. <dt class="phpdocumentor-argument-list__entry">
  484. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  485. : <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>
  486. </dt>
  487. <dd class="phpdocumentor-argument-list__definition">
  488. </dd>
  489. </dl>
  490. </article>
  491. <article
  492. class="phpdocumentor-element
  493. -method
  494. -public
  495. "
  496. >
  497. <h4 class="phpdocumentor-element__name" id="method_dump">
  498. dump()
  499. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  500. </h4>
  501. <aside class="phpdocumentor-element-found-in">
  502. <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>
  503. :
  504. <span class="phpdocumentor-element-found-in__line">74</span>
  505. </aside>
  506. <code class="phpdocumentor-code phpdocumentor-signature ">
  507. <span class="phpdocumentor-signature__visibility">public</span>
  508. <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>
  509. <div class="phpdocumentor-label-line">
  510. </div>
  511. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  512. <dl class="phpdocumentor-argument-list">
  513. <dt class="phpdocumentor-argument-list__entry">
  514. <span class="phpdocumentor-signature__argument__name">$file</span>
  515. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  516. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  517. <dd class="phpdocumentor-argument-list__definition">
  518. </dd>
  519. </dl>
  520. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  521. Tags
  522. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  523. </h5>
  524. <dl class="phpdocumentor-tag-list">
  525. <dt class="phpdocumentor-tag-list__entry">
  526. <span class="phpdocumentor-tag__name">inheritDoc</span>
  527. </dt>
  528. <dd class="phpdocumentor-tag-list__definition">
  529. </dd>
  530. </dl>
  531. <section>
  532. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  533. <span class="phpdocumentor-signature__response_type">string</span>
  534. </section>
  535. </article>
  536. <article
  537. class="phpdocumentor-element
  538. -method
  539. -public
  540. -static "
  541. >
  542. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  543. moduleValueIsValid()
  544. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  545. </h4>
  546. <aside class="phpdocumentor-element-found-in">
  547. <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>
  548. :
  549. <span class="phpdocumentor-element-found-in__line">29</span>
  550. </aside>
  551. <p class="phpdocumentor-summary">note: we&#039;re not necessarily validating the several values, just checking the general syntax
  552. note: css4 colors are not included</p>
  553. <code class="phpdocumentor-code phpdocumentor-signature ">
  554. <span class="phpdocumentor-signature__visibility">public</span>
  555. <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>
  556. <div class="phpdocumentor-label-line">
  557. </div>
  558. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  559. <dl class="phpdocumentor-argument-list">
  560. <dt class="phpdocumentor-argument-list__entry">
  561. <span class="phpdocumentor-signature__argument__name">$value</span>
  562. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  563. </dt>
  564. <dd class="phpdocumentor-argument-list__definition">
  565. </dd>
  566. </dl>
  567. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  568. Tags
  569. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_moduleValueIsValid#tags" class="headerlink"><i class="fas fa-link"></i></a>
  570. </h5>
  571. <dl class="phpdocumentor-tag-list">
  572. <dt class="phpdocumentor-tag-list__entry">
  573. <span class="phpdocumentor-tag__name">todo:</span>
  574. </dt>
  575. <dd class="phpdocumentor-tag-list__definition">
  576. <section class="phpdocumentor-description"><p>XSS proof</p>
  577. </section>
  578. </dd>
  579. <dt class="phpdocumentor-tag-list__entry">
  580. <span class="phpdocumentor-tag__name">see</span>
  581. </dt>
  582. <dd class="phpdocumentor-tag-list__definition">
  583. <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>
  584. </dd>
  585. <dt class="phpdocumentor-tag-list__entry">
  586. <span class="phpdocumentor-tag__name">inheritDoc</span>
  587. </dt>
  588. <dd class="phpdocumentor-tag-list__definition">
  589. </dd>
  590. </dl>
  591. <section>
  592. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  593. <span class="phpdocumentor-signature__response_type">bool</span>
  594. </section>
  595. </article>
  596. <article
  597. class="phpdocumentor-element
  598. -method
  599. -protected
  600. "
  601. >
  602. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  603. collectModules()
  604. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  605. </h4>
  606. <aside class="phpdocumentor-element-found-in">
  607. <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>
  608. :
  609. <span class="phpdocumentor-element-found-in__line">189</span>
  610. </aside>
  611. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  612. returns an array with the transformed modules</p>
  613. <code class="phpdocumentor-code phpdocumentor-signature ">
  614. <span class="phpdocumentor-signature__visibility">protected</span>
  615. <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>
  616. <div class="phpdocumentor-label-line">
  617. </div>
  618. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  619. <p>$x - current column
  620. $y - current row
  621. $M_TYPE - field value
  622. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  623. </section>
  624. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  625. <dl class="phpdocumentor-argument-list">
  626. <dt class="phpdocumentor-argument-list__entry">
  627. <span class="phpdocumentor-signature__argument__name">$transform</span>
  628. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  629. </dt>
  630. <dd class="phpdocumentor-argument-list__definition">
  631. </dd>
  632. </dl>
  633. <section>
  634. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  635. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  636. </section>
  637. </article>
  638. <article
  639. class="phpdocumentor-element
  640. -method
  641. -protected
  642. -abstract "
  643. >
  644. <h4 class="phpdocumentor-element__name" id="method_createMarkup">
  645. createMarkup()
  646. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_createMarkup" class="headerlink"><i class="fas fa-link"></i></a>
  647. </h4>
  648. <aside class="phpdocumentor-element-found-in">
  649. <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>
  650. :
  651. <span class="phpdocumentor-element-found-in__line">92</span>
  652. </aside>
  653. <p class="phpdocumentor-summary">returns the fully parsed and rendered markup string for the given input</p>
  654. <code class="phpdocumentor-code phpdocumentor-signature ">
  655. <span class="phpdocumentor-signature__visibility">protected</span>
  656. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">createMarkup</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$saveToFile</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  657. <div class="phpdocumentor-label-line">
  658. </div>
  659. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  660. <dl class="phpdocumentor-argument-list">
  661. <dt class="phpdocumentor-argument-list__entry">
  662. <span class="phpdocumentor-signature__argument__name">$saveToFile</span>
  663. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  664. </dt>
  665. <dd class="phpdocumentor-argument-list__definition">
  666. </dd>
  667. </dl>
  668. <section>
  669. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  670. <span class="phpdocumentor-signature__response_type">string</span>
  671. </section>
  672. </article>
  673. <article
  674. class="phpdocumentor-element
  675. -method
  676. -protected
  677. "
  678. >
  679. <h4 class="phpdocumentor-element__name" id="method_getCssClass">
  680. getCssClass()
  681. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_getCssClass" class="headerlink"><i class="fas fa-link"></i></a>
  682. </h4>
  683. <aside class="phpdocumentor-element-found-in">
  684. <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>
  685. :
  686. <span class="phpdocumentor-element-found-in__line">85</span>
  687. </aside>
  688. <p class="phpdocumentor-summary">returns a string with all css classes for the current element</p>
  689. <code class="phpdocumentor-code phpdocumentor-signature ">
  690. <span class="phpdocumentor-signature__visibility">protected</span>
  691. <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>
  692. <div class="phpdocumentor-label-line">
  693. </div>
  694. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  695. <dl class="phpdocumentor-argument-list">
  696. <dt class="phpdocumentor-argument-list__entry">
  697. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  698. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  699. = <span class="phpdocumentor-signature__argument__default-value">0</span> </dt>
  700. <dd class="phpdocumentor-argument-list__definition">
  701. </dd>
  702. </dl>
  703. <section>
  704. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  705. <span class="phpdocumentor-signature__response_type">string</span>
  706. </section>
  707. </article>
  708. <article
  709. class="phpdocumentor-element
  710. -method
  711. -protected
  712. "
  713. >
  714. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  715. getDefaultModuleValue()
  716. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  717. </h4>
  718. <aside class="phpdocumentor-element-found-in">
  719. <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>
  720. :
  721. <span class="phpdocumentor-element-found-in__line">67</span>
  722. </aside>
  723. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
  724. <code class="phpdocumentor-code phpdocumentor-signature ">
  725. <span class="phpdocumentor-signature__visibility">protected</span>
  726. <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|null</span></code>
  727. <div class="phpdocumentor-label-line">
  728. </div>
  729. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  730. <dl class="phpdocumentor-argument-list">
  731. <dt class="phpdocumentor-argument-list__entry">
  732. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  733. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  734. </dt>
  735. <dd class="phpdocumentor-argument-list__definition">
  736. </dd>
  737. </dl>
  738. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  739. Tags
  740. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_getDefaultModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  741. </h5>
  742. <dl class="phpdocumentor-tag-list">
  743. <dt class="phpdocumentor-tag-list__entry">
  744. <span class="phpdocumentor-tag__name">inheritDoc</span>
  745. </dt>
  746. <dd class="phpdocumentor-tag-list__definition">
  747. </dd>
  748. </dl>
  749. <section>
  750. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  751. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  752. &mdash;
  753. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  754. </section>
  755. </section>
  756. </article>
  757. <article
  758. class="phpdocumentor-element
  759. -method
  760. -protected
  761. "
  762. >
  763. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  764. getModuleValue()
  765. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  766. </h4>
  767. <aside class="phpdocumentor-element-found-in">
  768. <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>
  769. :
  770. <span class="phpdocumentor-element-found-in__line">113</span>
  771. </aside>
  772. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  773. <code class="phpdocumentor-code phpdocumentor-signature ">
  774. <span class="phpdocumentor-signature__visibility">protected</span>
  775. <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|null</span></code>
  776. <div class="phpdocumentor-label-line">
  777. </div>
  778. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  779. <dl class="phpdocumentor-argument-list">
  780. <dt class="phpdocumentor-argument-list__entry">
  781. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  782. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  783. </dt>
  784. <dd class="phpdocumentor-argument-list__definition">
  785. </dd>
  786. </dl>
  787. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  788. Tags
  789. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  790. </h5>
  791. <dl class="phpdocumentor-tag-list">
  792. <dt class="phpdocumentor-tag-list__entry">
  793. <span class="phpdocumentor-tag__name">throws</span>
  794. </dt>
  795. <dd class="phpdocumentor-tag-list__definition">
  796. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  797. </dd>
  798. </dl>
  799. <section>
  800. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  801. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  802. &mdash;
  803. <section class="phpdocumentor-description"><p>return value depends on the output class, null if $moduleValues[$M_TYPE] doesn't exist</p>
  804. </section>
  805. </section>
  806. </article>
  807. <article
  808. class="phpdocumentor-element
  809. -method
  810. -protected
  811. "
  812. >
  813. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  814. getModuleValueAt()
  815. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  816. </h4>
  817. <aside class="phpdocumentor-element-found-in">
  818. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  819. :
  820. <span class="phpdocumentor-element-found-in__line">128</span>
  821. </aside>
  822. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  823. <code class="phpdocumentor-code phpdocumentor-signature ">
  824. <span class="phpdocumentor-signature__visibility">protected</span>
  825. <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|null</span></code>
  826. <div class="phpdocumentor-label-line">
  827. </div>
  828. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  829. <dl class="phpdocumentor-argument-list">
  830. <dt class="phpdocumentor-argument-list__entry">
  831. <span class="phpdocumentor-signature__argument__name">$x</span>
  832. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  833. </dt>
  834. <dd class="phpdocumentor-argument-list__definition">
  835. </dd>
  836. <dt class="phpdocumentor-argument-list__entry">
  837. <span class="phpdocumentor-signature__argument__name">$y</span>
  838. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  839. </dt>
  840. <dd class="phpdocumentor-argument-list__definition">
  841. </dd>
  842. </dl>
  843. <section>
  844. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  845. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  846. </section>
  847. </article>
  848. <article
  849. class="phpdocumentor-element
  850. -method
  851. -protected
  852. "
  853. >
  854. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  855. getOutputDimensions()
  856. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  857. </h4>
  858. <aside class="phpdocumentor-element-found-in">
  859. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  860. :
  861. <span class="phpdocumentor-element-found-in__line">88</span>
  862. </aside>
  863. <p class="phpdocumentor-summary">Returns a 2 element array with the current output width and height</p>
  864. <code class="phpdocumentor-code phpdocumentor-signature ">
  865. <span class="phpdocumentor-signature__visibility">protected</span>
  866. <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>
  867. <div class="phpdocumentor-label-line">
  868. </div>
  869. <section class="phpdocumentor-description"><p>The type and units of the values depend on the output class. The default value is the current module count * scale.</p>
  870. </section>
  871. <section>
  872. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  873. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  874. </section>
  875. </article>
  876. <article
  877. class="phpdocumentor-element
  878. -method
  879. -protected
  880. "
  881. >
  882. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  883. prepareModuleValue()
  884. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  885. </h4>
  886. <aside class="phpdocumentor-element-found-in">
  887. <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>
  888. :
  889. <span class="phpdocumentor-element-found-in__line">60</span>
  890. </aside>
  891. <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
  892. <code class="phpdocumentor-code phpdocumentor-signature ">
  893. <span class="phpdocumentor-signature__visibility">protected</span>
  894. <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|null</span></code>
  895. <div class="phpdocumentor-label-line">
  896. </div>
  897. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  898. <dl class="phpdocumentor-argument-list">
  899. <dt class="phpdocumentor-argument-list__entry">
  900. <span class="phpdocumentor-signature__argument__name">$value</span>
  901. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  902. </dt>
  903. <dd class="phpdocumentor-argument-list__definition">
  904. </dd>
  905. </dl>
  906. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  907. Tags
  908. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_prepareModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  909. </h5>
  910. <dl class="phpdocumentor-tag-list">
  911. <dt class="phpdocumentor-tag-list__entry">
  912. <span class="phpdocumentor-tag__name">inheritDoc</span>
  913. </dt>
  914. <dd class="phpdocumentor-tag-list__definition">
  915. </dd>
  916. </dl>
  917. <section>
  918. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  919. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  920. &mdash;
  921. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  922. </section>
  923. </section>
  924. </article>
  925. <article
  926. class="phpdocumentor-element
  927. -method
  928. -protected
  929. "
  930. >
  931. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  932. saveToFile()
  933. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  934. </h4>
  935. <aside class="phpdocumentor-element-found-in">
  936. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  937. :
  938. <span class="phpdocumentor-element-found-in__line">163</span>
  939. </aside>
  940. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  941. <code class="phpdocumentor-code phpdocumentor-signature ">
  942. <span class="phpdocumentor-signature__visibility">protected</span>
  943. <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>
  944. <div class="phpdocumentor-label-line">
  945. </div>
  946. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  947. <dl class="phpdocumentor-argument-list">
  948. <dt class="phpdocumentor-argument-list__entry">
  949. <span class="phpdocumentor-signature__argument__name">$data</span>
  950. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  951. </dt>
  952. <dd class="phpdocumentor-argument-list__definition">
  953. </dd>
  954. <dt class="phpdocumentor-argument-list__entry">
  955. <span class="phpdocumentor-signature__argument__name">$file</span>
  956. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  957. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  958. <dd class="phpdocumentor-argument-list__definition">
  959. </dd>
  960. </dl>
  961. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  962. Tags
  963. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  964. </h5>
  965. <dl class="phpdocumentor-tag-list">
  966. <dt class="phpdocumentor-tag-list__entry">
  967. <span class="phpdocumentor-tag__name">see</span>
  968. </dt>
  969. <dd class="phpdocumentor-tag-list__definition">
  970. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  971. </dd>
  972. <dt class="phpdocumentor-tag-list__entry">
  973. <span class="phpdocumentor-tag__name">see</span>
  974. </dt>
  975. <dd class="phpdocumentor-tag-list__definition">
  976. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  977. </dd>
  978. <dt class="phpdocumentor-tag-list__entry">
  979. <span class="phpdocumentor-tag__name">throws</span>
  980. </dt>
  981. <dd class="phpdocumentor-tag-list__definition">
  982. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  983. </dd>
  984. </dl>
  985. </article>
  986. <article
  987. class="phpdocumentor-element
  988. -method
  989. -protected
  990. "
  991. >
  992. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  993. setMatrixDimensions()
  994. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  995. </h4>
  996. <aside class="phpdocumentor-element-found-in">
  997. <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>
  998. :
  999. <span class="phpdocumentor-element-found-in__line">77</span>
  1000. </aside>
  1001. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1002. <code class="phpdocumentor-code phpdocumentor-signature ">
  1003. <span class="phpdocumentor-signature__visibility">protected</span>
  1004. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1005. <div class="phpdocumentor-label-line">
  1006. </div>
  1007. <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>
  1008. </section>
  1009. </article>
  1010. <article
  1011. class="phpdocumentor-element
  1012. -method
  1013. -protected
  1014. "
  1015. >
  1016. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1017. setModuleValues()
  1018. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1019. </h4>
  1020. <aside class="phpdocumentor-element-found-in">
  1021. <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>
  1022. :
  1023. <span class="phpdocumentor-element-found-in__line">95</span>
  1024. </aside>
  1025. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1026. <code class="phpdocumentor-code phpdocumentor-signature ">
  1027. <span class="phpdocumentor-signature__visibility">protected</span>
  1028. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1029. <div class="phpdocumentor-label-line">
  1030. </div>
  1031. </article>
  1032. <article
  1033. class="phpdocumentor-element
  1034. -method
  1035. -protected
  1036. "
  1037. >
  1038. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1039. toBase64DataURI()
  1040. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1041. </h4>
  1042. <aside class="phpdocumentor-element-found-in">
  1043. <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>
  1044. :
  1045. <span class="phpdocumentor-element-found-in__line">151</span>
  1046. </aside>
  1047. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1048. <code class="phpdocumentor-code phpdocumentor-signature ">
  1049. <span class="phpdocumentor-signature__visibility">protected</span>
  1050. <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 class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1051. <div class="phpdocumentor-label-line">
  1052. </div>
  1053. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1054. <dl class="phpdocumentor-argument-list">
  1055. <dt class="phpdocumentor-argument-list__entry">
  1056. <span class="phpdocumentor-signature__argument__name">$data</span>
  1057. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1058. </dt>
  1059. <dd class="phpdocumentor-argument-list__definition">
  1060. </dd>
  1061. <dt class="phpdocumentor-argument-list__entry">
  1062. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1063. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1064. </dt>
  1065. <dd class="phpdocumentor-argument-list__definition">
  1066. </dd>
  1067. </dl>
  1068. <section>
  1069. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1070. <span class="phpdocumentor-signature__response_type">string</span>
  1071. </section>
  1072. </article>
  1073. </section>
  1074. <div class="phpdocumentor-modal" id="source-view">
  1075. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1076. <div class="phpdocumentor-modal-container">
  1077. <div class="phpdocumentor-modal-content">
  1078. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Output/QRMarkup.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  1079. </div>
  1080. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1081. </div>
  1082. </div>
  1083. <script type="text/javascript">
  1084. (function () {
  1085. function loadExternalCodeSnippet(el, url, line) {
  1086. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1087. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1088. const language = 'php';
  1089. const code = document.createElement('code');
  1090. code.className = 'language-' + language;
  1091. pre.textContent = '';
  1092. pre.setAttribute('data-line', line)
  1093. code.textContent = 'Loading…';
  1094. pre.appendChild(code);
  1095. var xhr = new XMLHttpRequest();
  1096. xhr.open('GET', src, true);
  1097. xhr.onreadystatechange = function () {
  1098. if (xhr.readyState !== 4) {
  1099. return;
  1100. }
  1101. if (xhr.status < 400 && xhr.responseText) {
  1102. code.textContent = xhr.responseText;
  1103. Prism.highlightElement(code);
  1104. return;
  1105. }
  1106. if (xhr.status === 404) {
  1107. code.textContent = '✖ Error: File could not be found';
  1108. return;
  1109. }
  1110. if (xhr.status >= 400) {
  1111. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1112. return;
  1113. }
  1114. code.textContent = '✖ Error: An unknown error occurred';
  1115. };
  1116. xhr.send(null);
  1117. });
  1118. }
  1119. const modalButtons = document.querySelectorAll("[data-modal]");
  1120. const openedAsLocalFile = window.location.protocol === 'file:';
  1121. if (modalButtons.length > 0 && openedAsLocalFile) {
  1122. console.warn(
  1123. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1124. 'browsers block XHR requests when a page is opened this way'
  1125. );
  1126. }
  1127. modalButtons.forEach(function (trigger) {
  1128. if (openedAsLocalFile) {
  1129. trigger.setAttribute("hidden", "hidden");
  1130. }
  1131. trigger.addEventListener("click", function (event) {
  1132. event.preventDefault();
  1133. const modal = document.getElementById(trigger.dataset.modal);
  1134. if (!modal) {
  1135. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1136. return;
  1137. }
  1138. modal.classList.add("phpdocumentor-modal__open");
  1139. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1140. const exits = modal.querySelectorAll("[data-exit-button]");
  1141. exits.forEach(function (exit) {
  1142. exit.addEventListener("click", function (event) {
  1143. event.preventDefault();
  1144. modal.classList.remove("phpdocumentor-modal__open");
  1145. });
  1146. });
  1147. });
  1148. });
  1149. })();
  1150. </script>
  1151. </article>
  1152. </section>
  1153. <section class="phpdocumentor-on-this-page__sidebar">
  1154. <section class="phpdocumentor-on-this-page__content">
  1155. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1156. <ul class="phpdocumentor-list -clean">
  1157. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1158. <li>
  1159. <ul class="phpdocumentor-list -clean">
  1160. <li><a href="classes/chillerlan-QRCode-Output-QRMarkup.html#toc-properties">Properties</a></li>
  1161. <li><a href="classes/chillerlan-QRCode-Output-QRMarkup.html#toc-methods">Methods</a></li>
  1162. </ul>
  1163. </li>
  1164. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1165. <li>
  1166. <ul class="phpdocumentor-list -clean">
  1167. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QRMarkup.html"></li>
  1168. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QRMarkup.html"></li>
  1169. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QRMarkup.html"></li>
  1170. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QRMarkup.html"></li>
  1171. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QRMarkup.html"></li>
  1172. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QRMarkup.html"></li>
  1173. </ul>
  1174. </li>
  1175. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1176. <li>
  1177. <ul class="phpdocumentor-list -clean">
  1178. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a></li>
  1179. <li><a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump">dump()</a></li>
  1180. <li><a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  1181. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1182. <li><a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_createMarkup">createMarkup()</a></li>
  1183. <li><a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_getCssClass">getCssClass()</a></li>
  1184. <li><a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1185. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1186. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1187. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1188. <li><a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1189. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1190. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1191. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1192. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1193. </ul>
  1194. </li>
  1195. </ul>
  1196. </section>
  1197. </section>
  1198. </div>
  1199. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1200. <section class="phpdocumentor-search-results__dialog">
  1201. <header class="phpdocumentor-search-results__header">
  1202. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1203. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1204. </header>
  1205. <section class="phpdocumentor-search-results__body">
  1206. <ul class="phpdocumentor-search-results__entries"></ul>
  1207. </section>
  1208. </section>
  1209. </section>
  1210. </div>
  1211. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1212. </main>
  1213. <script>
  1214. cssVars({});
  1215. </script>
  1216. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1217. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1218. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1219. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1220. </body>
  1221. </html>