chillerlan-QRCode-Output-QRString.html 77 KB

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