chillerlan-QRCode-Output-QRString.html 62 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320
  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=Source+Sans+Pro:wght@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/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. QRString
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  95. </span>
  96. <div class="phpdocumentor-element__package">
  97. in package
  98. <ul class="phpdocumentor-breadcrumbs">
  99. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  100. </ul>
  101. </div>
  102. </h2>
  103. <aside class="phpdocumentor-element-found-in">
  104. <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>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">21</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">Converts the matrix data into string types</p>
  109. <h3 id="toc">
  110. Table of Contents
  111. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  112. </h3>
  113. <dl class="phpdocumentor-table-of-contents">
  114. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  115. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  116. <span>
  117. &nbsp;: int </span>
  118. </dt>
  119. <dd>the side length of the QR image (modules * scale)</dd>
  120. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  121. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  122. <span>
  123. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  124. </dt>
  125. <dd>the (filled) data matrix object</dd>
  126. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  127. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  128. <span>
  129. &nbsp;: int </span>
  130. </dt>
  131. <dd>the current size of the QR matrix</dd>
  132. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  133. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  134. <span>
  135. &nbsp;: array&lt;string|int, mixed&gt; </span>
  136. </dt>
  137. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  138. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  139. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  140. <span>
  141. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  142. </dt>
  143. <dd></dd>
  144. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  145. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  146. <span>
  147. &nbsp;: int </span>
  148. </dt>
  149. <dd>the current scaling for a QR pixel</dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  151. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  152. <span>
  153. &nbsp;: mixed </span>
  154. </dt>
  155. <dd>QROutputAbstract constructor.</dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  157. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_dump">dump()</a>
  158. <span>
  159. &nbsp;: string </span>
  160. </dt>
  161. <dd></dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  163. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  164. <span>
  165. &nbsp;: bool </span>
  166. </dt>
  167. <dd></dd>
  168. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  170. <span>
  171. &nbsp;: array&lt;string|int, mixed&gt; </span>
  172. </dt>
  173. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  174. returns an array with the transformed modules</dd>
  175. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  176. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  177. <span>
  178. &nbsp;: mixed|null </span>
  179. </dt>
  180. <dd>Returns a default value for either dark or light modules</dd>
  181. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  182. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  183. <span>
  184. &nbsp;: mixed|null </span>
  185. </dt>
  186. <dd>Returns the prepared value for the given $M_TYPE</dd>
  187. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  188. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  189. <span>
  190. &nbsp;: mixed|null </span>
  191. </dt>
  192. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  193. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  194. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_json">json()</a>
  195. <span>
  196. &nbsp;: string </span>
  197. </dt>
  198. <dd>JSON output</dd>
  199. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  200. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_prepareModuleValue">prepareModuleValue()</a>
  201. <span>
  202. &nbsp;: mixed|null </span>
  203. </dt>
  204. <dd>Prepares the value for the given input ()</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  206. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  207. <span>
  208. &nbsp;: void </span>
  209. </dt>
  210. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  212. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  213. <span>
  214. &nbsp;: void </span>
  215. </dt>
  216. <dd>Sets/updates the matrix dimensions</dd>
  217. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  218. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  219. <span>
  220. &nbsp;: void </span>
  221. </dt>
  222. <dd>Sets the initial module values</dd>
  223. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  224. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_text">text()</a>
  225. <span>
  226. &nbsp;: string </span>
  227. </dt>
  228. <dd>string output</dd>
  229. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  230. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  231. <span>
  232. &nbsp;: string </span>
  233. </dt>
  234. <dd>Returns a base64 data URI for the given string and mime type</dd>
  235. </dl>
  236. <section class="phpdocumentor-properties">
  237. <h3 class="phpdocumentor-elements__header" id="properties">
  238. Properties
  239. <a href="classes/chillerlan-QRCode-Output-QRString.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  240. </h3>
  241. <article
  242. class="
  243. phpdocumentor-element
  244. -property
  245. -protected
  246. "
  247. >
  248. <h4 class="phpdocumentor-element__name" id="property_length">
  249. $length
  250. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  251. <span class="phpdocumentor-element__modifiers">
  252. </span>
  253. </h4>
  254. <aside class="phpdocumentor-element-found-in">
  255. <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>
  256. :
  257. <span class="phpdocumentor-element-found-in__line">40</span>
  258. </aside>
  259. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  260. <code class="phpdocumentor-code phpdocumentor-signature ">
  261. <span class="phpdocumentor-signature__visibility">protected</span>
  262. <span class="phpdocumentor-signature__type">int</span>
  263. <span class="phpdocumentor-signature__name">$length</span>
  264. </code>
  265. <section class="phpdocumentor-description"></section>
  266. </article>
  267. <article
  268. class="
  269. phpdocumentor-element
  270. -property
  271. -protected
  272. "
  273. >
  274. <h4 class="phpdocumentor-element__name" id="property_matrix">
  275. $matrix
  276. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  277. <span class="phpdocumentor-element__modifiers">
  278. </span>
  279. </h4>
  280. <aside class="phpdocumentor-element-found-in">
  281. <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>
  282. :
  283. <span class="phpdocumentor-element-found-in__line">50</span>
  284. </aside>
  285. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  286. <code class="phpdocumentor-code phpdocumentor-signature ">
  287. <span class="phpdocumentor-signature__visibility">protected</span>
  288. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  289. <span class="phpdocumentor-signature__name">$matrix</span>
  290. </code>
  291. <section class="phpdocumentor-description"></section>
  292. </article>
  293. <article
  294. class="
  295. phpdocumentor-element
  296. -property
  297. -protected
  298. "
  299. >
  300. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  301. $moduleCount
  302. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  303. <span class="phpdocumentor-element__modifiers">
  304. </span>
  305. </h4>
  306. <aside class="phpdocumentor-element-found-in">
  307. <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>
  308. :
  309. <span class="phpdocumentor-element-found-in__line">28</span>
  310. </aside>
  311. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  312. <code class="phpdocumentor-code phpdocumentor-signature ">
  313. <span class="phpdocumentor-signature__visibility">protected</span>
  314. <span class="phpdocumentor-signature__type">int</span>
  315. <span class="phpdocumentor-signature__name">$moduleCount</span>
  316. </code>
  317. <section class="phpdocumentor-description"></section>
  318. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  319. Tags
  320. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  321. </h5>
  322. <dl class="phpdocumentor-tag-list">
  323. <dt class="phpdocumentor-tag-list__entry">
  324. <span class="phpdocumentor-tag__name">see</span>
  325. </dt>
  326. <dd class="phpdocumentor-tag-list__definition">
  327. <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>
  328. </dd>
  329. </dl>
  330. </article>
  331. <article
  332. class="
  333. phpdocumentor-element
  334. -property
  335. -protected
  336. "
  337. >
  338. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  339. $moduleValues
  340. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  341. <span class="phpdocumentor-element__modifiers">
  342. </span>
  343. </h4>
  344. <aside class="phpdocumentor-element-found-in">
  345. <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>
  346. :
  347. <span class="phpdocumentor-element-found-in__line">45</span>
  348. </aside>
  349. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  350. <code class="phpdocumentor-code phpdocumentor-signature ">
  351. <span class="phpdocumentor-signature__visibility">protected</span>
  352. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  353. <span class="phpdocumentor-signature__name">$moduleValues</span>
  354. </code>
  355. <section class="phpdocumentor-description"></section>
  356. </article>
  357. <article
  358. class="
  359. phpdocumentor-element
  360. -property
  361. -protected
  362. "
  363. >
  364. <h4 class="phpdocumentor-element__name" id="property_options">
  365. $options
  366. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  367. <span class="phpdocumentor-element__modifiers">
  368. </span>
  369. </h4>
  370. <aside class="phpdocumentor-element-found-in">
  371. <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>
  372. :
  373. <span class="phpdocumentor-element-found-in__line">55</span>
  374. </aside>
  375. <code class="phpdocumentor-code phpdocumentor-signature ">
  376. <span class="phpdocumentor-signature__visibility">protected</span>
  377. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  378. <span class="phpdocumentor-signature__name">$options</span>
  379. </code>
  380. </article>
  381. <article
  382. class="
  383. phpdocumentor-element
  384. -property
  385. -protected
  386. "
  387. >
  388. <h4 class="phpdocumentor-element__name" id="property_scale">
  389. $scale
  390. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  391. <span class="phpdocumentor-element__modifiers">
  392. </span>
  393. </h4>
  394. <aside class="phpdocumentor-element-found-in">
  395. <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>
  396. :
  397. <span class="phpdocumentor-element-found-in__line">35</span>
  398. </aside>
  399. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  400. <code class="phpdocumentor-code phpdocumentor-signature ">
  401. <span class="phpdocumentor-signature__visibility">protected</span>
  402. <span class="phpdocumentor-signature__type">int</span>
  403. <span class="phpdocumentor-signature__name">$scale</span>
  404. </code>
  405. <section class="phpdocumentor-description"></section>
  406. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  407. Tags
  408. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  409. </h5>
  410. <dl class="phpdocumentor-tag-list">
  411. <dt class="phpdocumentor-tag-list__entry">
  412. <span class="phpdocumentor-tag__name">see</span>
  413. </dt>
  414. <dd class="phpdocumentor-tag-list__definition">
  415. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  416. </dd>
  417. </dl>
  418. </article>
  419. </section>
  420. <section class="phpdocumentor-methods">
  421. <h3 class="phpdocumentor-elements__header" id="methods">
  422. Methods
  423. <a href="classes/chillerlan-QRCode-Output-QRString.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  424. </h3>
  425. <article
  426. class="phpdocumentor-element
  427. -method
  428. -public
  429. "
  430. >
  431. <h4 class="phpdocumentor-element__name" id="method___construct">
  432. __construct()
  433. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  434. </h4>
  435. <aside class="phpdocumentor-element-found-in">
  436. <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>
  437. :
  438. <span class="phpdocumentor-element-found-in__line">60</span>
  439. </aside>
  440. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  441. <code class="phpdocumentor-code phpdocumentor-signature ">
  442. <span class="phpdocumentor-signature__visibility">public</span>
  443. <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>
  444. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  445. <dl class="phpdocumentor-argument-list">
  446. <dt class="phpdocumentor-argument-list__entry">
  447. <span class="phpdocumentor-signature__argument__name">$options</span>
  448. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  449. </dt>
  450. <dd class="phpdocumentor-argument-list__definition">
  451. <section class="phpdocumentor-description"></section>
  452. </dd>
  453. <dt class="phpdocumentor-argument-list__entry">
  454. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  455. : <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>
  456. </dt>
  457. <dd class="phpdocumentor-argument-list__definition">
  458. <section class="phpdocumentor-description"></section>
  459. </dd>
  460. </dl>
  461. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  462. <span class="phpdocumentor-signature__response_type">mixed</span>
  463. &mdash;
  464. </article>
  465. <article
  466. class="phpdocumentor-element
  467. -method
  468. -public
  469. "
  470. >
  471. <h4 class="phpdocumentor-element__name" id="method_dump">
  472. dump()
  473. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  474. </h4>
  475. <aside class="phpdocumentor-element-found-in">
  476. <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>
  477. :
  478. <span class="phpdocumentor-element-found-in__line">47</span>
  479. </aside>
  480. <code class="phpdocumentor-code phpdocumentor-signature ">
  481. <span class="phpdocumentor-signature__visibility">public</span>
  482. <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>
  483. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  484. <dl class="phpdocumentor-argument-list">
  485. <dt class="phpdocumentor-argument-list__entry">
  486. <span class="phpdocumentor-signature__argument__name">$file</span>
  487. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  488. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  489. <dd class="phpdocumentor-argument-list__definition">
  490. <section class="phpdocumentor-description"></section>
  491. </dd>
  492. </dl>
  493. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  494. Tags
  495. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  496. </h5>
  497. <dl class="phpdocumentor-tag-list">
  498. <dt class="phpdocumentor-tag-list__entry">
  499. <span class="phpdocumentor-tag__name">inheritDoc</span>
  500. </dt>
  501. <dd class="phpdocumentor-tag-list__definition">
  502. </dd>
  503. </dl>
  504. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  505. <span class="phpdocumentor-signature__response_type">string</span>
  506. &mdash;
  507. </article>
  508. <article
  509. class="phpdocumentor-element
  510. -method
  511. -public
  512. -static "
  513. >
  514. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  515. moduleValueIsValid()
  516. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  517. </h4>
  518. <aside class="phpdocumentor-element-found-in">
  519. <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>
  520. :
  521. <span class="phpdocumentor-element-found-in__line">26</span>
  522. </aside>
  523. <code class="phpdocumentor-code phpdocumentor-signature ">
  524. <span class="phpdocumentor-signature__visibility">public</span>
  525. <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>
  526. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  527. <dl class="phpdocumentor-argument-list">
  528. <dt class="phpdocumentor-argument-list__entry">
  529. <span class="phpdocumentor-signature__argument__name">$value</span>
  530. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  531. </dt>
  532. <dd class="phpdocumentor-argument-list__definition">
  533. <section class="phpdocumentor-description"></section>
  534. </dd>
  535. </dl>
  536. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  537. Tags
  538. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  539. </h5>
  540. <dl class="phpdocumentor-tag-list">
  541. <dt class="phpdocumentor-tag-list__entry">
  542. <span class="phpdocumentor-tag__name">inheritDoc</span>
  543. </dt>
  544. <dd class="phpdocumentor-tag-list__definition">
  545. </dd>
  546. </dl>
  547. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  548. <span class="phpdocumentor-signature__response_type">bool</span>
  549. &mdash;
  550. </article>
  551. <article
  552. class="phpdocumentor-element
  553. -method
  554. -protected
  555. "
  556. >
  557. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  558. collectModules()
  559. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  560. </h4>
  561. <aside class="phpdocumentor-element-found-in">
  562. <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>
  563. :
  564. <span class="phpdocumentor-element-found-in__line">169</span>
  565. </aside>
  566. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  567. returns an array with the transformed modules</p>
  568. <code class="phpdocumentor-code phpdocumentor-signature ">
  569. <span class="phpdocumentor-signature__visibility">protected</span>
  570. <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>
  571. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  572. <p>$x - current column
  573. $y - current row
  574. $M_TYPE - field value
  575. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  576. </section>
  577. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  578. <dl class="phpdocumentor-argument-list">
  579. <dt class="phpdocumentor-argument-list__entry">
  580. <span class="phpdocumentor-signature__argument__name">$transform</span>
  581. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  582. </dt>
  583. <dd class="phpdocumentor-argument-list__definition">
  584. <section class="phpdocumentor-description"></section>
  585. </dd>
  586. </dl>
  587. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  588. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  589. &mdash;
  590. </article>
  591. <article
  592. class="phpdocumentor-element
  593. -method
  594. -protected
  595. "
  596. >
  597. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  598. getDefaultModuleValue()
  599. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  600. </h4>
  601. <aside class="phpdocumentor-element-found-in">
  602. <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>
  603. :
  604. <span class="phpdocumentor-element-found-in__line">40</span>
  605. </aside>
  606. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
  607. <code class="phpdocumentor-code phpdocumentor-signature ">
  608. <span class="phpdocumentor-signature__visibility">protected</span>
  609. <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>
  610. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  611. <dl class="phpdocumentor-argument-list">
  612. <dt class="phpdocumentor-argument-list__entry">
  613. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  614. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  615. </dt>
  616. <dd class="phpdocumentor-argument-list__definition">
  617. <section class="phpdocumentor-description"></section>
  618. </dd>
  619. </dl>
  620. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  621. Tags
  622. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  623. </h5>
  624. <dl class="phpdocumentor-tag-list">
  625. <dt class="phpdocumentor-tag-list__entry">
  626. <span class="phpdocumentor-tag__name">inheritDoc</span>
  627. </dt>
  628. <dd class="phpdocumentor-tag-list__definition">
  629. </dd>
  630. </dl>
  631. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  632. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  633. &mdash;
  634. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  635. </section>
  636. </article>
  637. <article
  638. class="phpdocumentor-element
  639. -method
  640. -protected
  641. "
  642. >
  643. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  644. getModuleValue()
  645. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  646. </h4>
  647. <aside class="phpdocumentor-element-found-in">
  648. <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>
  649. :
  650. <span class="phpdocumentor-element-found-in__line">99</span>
  651. </aside>
  652. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  653. <code class="phpdocumentor-code phpdocumentor-signature ">
  654. <span class="phpdocumentor-signature__visibility">protected</span>
  655. <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>
  656. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  657. <dl class="phpdocumentor-argument-list">
  658. <dt class="phpdocumentor-argument-list__entry">
  659. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  660. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  661. </dt>
  662. <dd class="phpdocumentor-argument-list__definition">
  663. <section class="phpdocumentor-description"></section>
  664. </dd>
  665. </dl>
  666. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  667. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  668. &mdash;
  669. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  670. </section>
  671. </article>
  672. <article
  673. class="phpdocumentor-element
  674. -method
  675. -protected
  676. "
  677. >
  678. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  679. getModuleValueAt()
  680. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  681. </h4>
  682. <aside class="phpdocumentor-element-found-in">
  683. <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>
  684. :
  685. <span class="phpdocumentor-element-found-in__line">108</span>
  686. </aside>
  687. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  688. <code class="phpdocumentor-code phpdocumentor-signature ">
  689. <span class="phpdocumentor-signature__visibility">protected</span>
  690. <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>
  691. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  692. <dl class="phpdocumentor-argument-list">
  693. <dt class="phpdocumentor-argument-list__entry">
  694. <span class="phpdocumentor-signature__argument__name">$x</span>
  695. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  696. </dt>
  697. <dd class="phpdocumentor-argument-list__definition">
  698. <section class="phpdocumentor-description"></section>
  699. </dd>
  700. <dt class="phpdocumentor-argument-list__entry">
  701. <span class="phpdocumentor-signature__argument__name">$y</span>
  702. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  703. </dt>
  704. <dd class="phpdocumentor-argument-list__definition">
  705. <section class="phpdocumentor-description"></section>
  706. </dd>
  707. </dl>
  708. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  709. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  710. &mdash;
  711. </article>
  712. <article
  713. class="phpdocumentor-element
  714. -method
  715. -protected
  716. "
  717. >
  718. <h4 class="phpdocumentor-element__name" id="method_json">
  719. json()
  720. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_json" class="headerlink"><i class="fas fa-link"></i></a>
  721. </h4>
  722. <aside class="phpdocumentor-element-found-in">
  723. <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>
  724. :
  725. <span class="phpdocumentor-element-found-in__line">85</span>
  726. </aside>
  727. <p class="phpdocumentor-summary">JSON output</p>
  728. <code class="phpdocumentor-code phpdocumentor-signature ">
  729. <span class="phpdocumentor-signature__visibility">protected</span>
  730. <span class="phpdocumentor-signature__name">json</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  731. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  732. <span class="phpdocumentor-signature__response_type">string</span>
  733. &mdash;
  734. </article>
  735. <article
  736. class="phpdocumentor-element
  737. -method
  738. -protected
  739. "
  740. >
  741. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  742. prepareModuleValue()
  743. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  744. </h4>
  745. <aside class="phpdocumentor-element-found-in">
  746. <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>
  747. :
  748. <span class="phpdocumentor-element-found-in__line">33</span>
  749. </aside>
  750. <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
  751. <code class="phpdocumentor-code phpdocumentor-signature ">
  752. <span class="phpdocumentor-signature__visibility">protected</span>
  753. <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>
  754. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  755. <dl class="phpdocumentor-argument-list">
  756. <dt class="phpdocumentor-argument-list__entry">
  757. <span class="phpdocumentor-signature__argument__name">$value</span>
  758. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  759. </dt>
  760. <dd class="phpdocumentor-argument-list__definition">
  761. </dd>
  762. </dl>
  763. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  764. Tags
  765. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  766. </h5>
  767. <dl class="phpdocumentor-tag-list">
  768. <dt class="phpdocumentor-tag-list__entry">
  769. <span class="phpdocumentor-tag__name">inheritDoc</span>
  770. </dt>
  771. <dd class="phpdocumentor-tag-list__definition">
  772. </dd>
  773. </dl>
  774. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  775. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  776. &mdash;
  777. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  778. </section>
  779. </article>
  780. <article
  781. class="phpdocumentor-element
  782. -method
  783. -protected
  784. "
  785. >
  786. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  787. saveToFile()
  788. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  789. </h4>
  790. <aside class="phpdocumentor-element-found-in">
  791. <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>
  792. :
  793. <span class="phpdocumentor-element-found-in__line">143</span>
  794. </aside>
  795. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  796. <code class="phpdocumentor-code phpdocumentor-signature ">
  797. <span class="phpdocumentor-signature__visibility">protected</span>
  798. <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>
  799. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  800. <dl class="phpdocumentor-argument-list">
  801. <dt class="phpdocumentor-argument-list__entry">
  802. <span class="phpdocumentor-signature__argument__name">$data</span>
  803. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  804. </dt>
  805. <dd class="phpdocumentor-argument-list__definition">
  806. <section class="phpdocumentor-description"></section>
  807. </dd>
  808. <dt class="phpdocumentor-argument-list__entry">
  809. <span class="phpdocumentor-signature__argument__name">$file</span>
  810. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  811. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  812. <dd class="phpdocumentor-argument-list__definition">
  813. <section class="phpdocumentor-description"></section>
  814. </dd>
  815. </dl>
  816. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  817. Tags
  818. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  819. </h5>
  820. <dl class="phpdocumentor-tag-list">
  821. <dt class="phpdocumentor-tag-list__entry">
  822. <span class="phpdocumentor-tag__name">see</span>
  823. </dt>
  824. <dd class="phpdocumentor-tag-list__definition">
  825. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  826. </dd>
  827. <dt class="phpdocumentor-tag-list__entry">
  828. <span class="phpdocumentor-tag__name">see</span>
  829. </dt>
  830. <dd class="phpdocumentor-tag-list__definition">
  831. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  832. </dd>
  833. <dt class="phpdocumentor-tag-list__entry">
  834. <span class="phpdocumentor-tag__name">throws</span>
  835. </dt>
  836. <dd class="phpdocumentor-tag-list__definition">
  837. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  838. </dd>
  839. </dl>
  840. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  841. <span class="phpdocumentor-signature__response_type">void</span>
  842. &mdash;
  843. </article>
  844. <article
  845. class="phpdocumentor-element
  846. -method
  847. -protected
  848. "
  849. >
  850. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  851. setMatrixDimensions()
  852. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  853. </h4>
  854. <aside class="phpdocumentor-element-found-in">
  855. <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>
  856. :
  857. <span class="phpdocumentor-element-found-in__line">73</span>
  858. </aside>
  859. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  860. <code class="phpdocumentor-code phpdocumentor-signature ">
  861. <span class="phpdocumentor-signature__visibility">protected</span>
  862. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  863. <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>
  864. </section>
  865. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  866. <span class="phpdocumentor-signature__response_type">void</span>
  867. &mdash;
  868. </article>
  869. <article
  870. class="phpdocumentor-element
  871. -method
  872. -protected
  873. "
  874. >
  875. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  876. setModuleValues()
  877. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  878. </h4>
  879. <aside class="phpdocumentor-element-found-in">
  880. <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>
  881. :
  882. <span class="phpdocumentor-element-found-in__line">82</span>
  883. </aside>
  884. <p class="phpdocumentor-summary">Sets the initial module values</p>
  885. <code class="phpdocumentor-code phpdocumentor-signature ">
  886. <span class="phpdocumentor-signature__visibility">protected</span>
  887. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  888. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  889. <span class="phpdocumentor-signature__response_type">void</span>
  890. &mdash;
  891. </article>
  892. <article
  893. class="phpdocumentor-element
  894. -method
  895. -protected
  896. "
  897. >
  898. <h4 class="phpdocumentor-element__name" id="method_text">
  899. text()
  900. <a href="classes/chillerlan-QRCode-Output-QRString.html#method_text" class="headerlink"><i class="fas fa-link"></i></a>
  901. </h4>
  902. <aside class="phpdocumentor-element-found-in">
  903. <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>
  904. :
  905. <span class="phpdocumentor-element-found-in__line">66</span>
  906. </aside>
  907. <p class="phpdocumentor-summary">string output</p>
  908. <code class="phpdocumentor-code phpdocumentor-signature ">
  909. <span class="phpdocumentor-signature__visibility">protected</span>
  910. <span class="phpdocumentor-signature__name">text</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  911. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  912. <span class="phpdocumentor-signature__response_type">string</span>
  913. &mdash;
  914. </article>
  915. <article
  916. class="phpdocumentor-element
  917. -method
  918. -protected
  919. "
  920. >
  921. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  922. toBase64DataURI()
  923. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  924. </h4>
  925. <aside class="phpdocumentor-element-found-in">
  926. <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>
  927. :
  928. <span class="phpdocumentor-element-found-in__line">131</span>
  929. </aside>
  930. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  931. <code class="phpdocumentor-code phpdocumentor-signature ">
  932. <span class="phpdocumentor-signature__visibility">protected</span>
  933. <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>
  934. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  935. <dl class="phpdocumentor-argument-list">
  936. <dt class="phpdocumentor-argument-list__entry">
  937. <span class="phpdocumentor-signature__argument__name">$data</span>
  938. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  939. </dt>
  940. <dd class="phpdocumentor-argument-list__definition">
  941. <section class="phpdocumentor-description"></section>
  942. </dd>
  943. <dt class="phpdocumentor-argument-list__entry">
  944. <span class="phpdocumentor-signature__argument__name">$mime</span>
  945. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  946. </dt>
  947. <dd class="phpdocumentor-argument-list__definition">
  948. <section class="phpdocumentor-description"></section>
  949. </dd>
  950. </dl>
  951. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  952. <span class="phpdocumentor-signature__response_type">string</span>
  953. &mdash;
  954. </article>
  955. </section>
  956. <script type="text/javascript">
  957. function loadExternalCodeSnippets(line) {
  958. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  959. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  960. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  961. var language = 'php';
  962. var code = document.createElement('code');
  963. code.className = 'language-' + language;
  964. pre.textContent = '';
  965. pre.setAttribute('data-line', line)
  966. code.textContent = 'Loading…';
  967. pre.appendChild(code);
  968. var xhr = new XMLHttpRequest();
  969. xhr.open('GET', src, true);
  970. xhr.onreadystatechange = function () {
  971. if (xhr.readyState == 4) {
  972. if (xhr.status < 400 && xhr.responseText) {
  973. code.textContent = xhr.responseText;
  974. Prism.highlightElement(code);
  975. }
  976. else if (xhr.status >= 400) {
  977. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  978. }
  979. else {
  980. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  981. }
  982. }
  983. };
  984. xhr.send(null);
  985. });
  986. }
  987. var modals = document.querySelectorAll("[data-modal]");
  988. modals.forEach(function (trigger) {
  989. trigger.addEventListener("click", function (event) {
  990. //event.preventDefault();
  991. const modal = document.getElementById(trigger.dataset.modal);
  992. modal.classList.add("phpdocumentor-modal__open");
  993. loadExternalCodeSnippets(trigger.dataset.line)
  994. const exits = modal.querySelectorAll("[data-exit-button]");
  995. exits.forEach(function (exit) {
  996. exit.addEventListener("click", function (event) {
  997. event.preventDefault();
  998. modal.classList.remove("phpdocumentor-modal__open");
  999. });
  1000. });
  1001. });
  1002. });
  1003. </script>
  1004. </article>
  1005. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1006. <section class="phpdocumentor-search-results__dialog">
  1007. <header class="phpdocumentor-search-results__header">
  1008. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1009. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1010. </header>
  1011. <section class="phpdocumentor-search-results__body">
  1012. <ul class="phpdocumentor-search-results__entries"></ul>
  1013. </section>
  1014. </section>
  1015. </section>
  1016. </div>
  1017. </div>
  1018. <a href="classes/chillerlan-QRCode-Output-QRString.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1019. </main>
  1020. <script>
  1021. cssVars({});
  1022. </script>
  1023. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1024. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1025. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1026. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1027. </body>
  1028. </html>