chillerlan-QRCode-Output-QRMarkupHTML.html 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170
  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. QRMarkupHTML
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Output-QRMarkup.html"><abbr title="\chillerlan\QRCode\Output\QRMarkup">QRMarkup</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/QRMarkupHTML.php"><a href="files/src-output-qrmarkuphtml.html"><abbr title="src/Output/QRMarkupHTML.php">QRMarkupHTML.php</abbr></a></abbr>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">18</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">HTML output</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-QRMarkup.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 -protected">
  163. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode">base64encode()</a>
  164. <span>
  165. &nbsp;: string </span>
  166. </dt>
  167. <dd>Returns a base64 data URI for the given string and mime type</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 functio 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-QRMarkupHTML.html#method_createMarkup">createMarkup()</a>
  177. <span>
  178. &nbsp;: string </span>
  179. </dt>
  180. <dd></dd>
  181. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  182. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#method_getCssClass">getCssClass()</a>
  183. <span>
  184. &nbsp;: string </span>
  185. </dt>
  186. <dd>returns a string with all css classes for the current element</dd>
  187. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  188. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  189. <span>
  190. &nbsp;: mixed </span>
  191. </dt>
  192. <dd>Returns a defualt value for either dark or light modules (return value depends on the output module)</dd>
  193. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  194. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  195. <span>
  196. &nbsp;: mixed </span>
  197. </dt>
  198. <dd>Returns the final value for the given input (return value depends on the output module)</dd>
  199. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  200. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  201. <span>
  202. &nbsp;: bool </span>
  203. </dt>
  204. <dd>Determines whether the given value is valid</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</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  212. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  213. <span>
  214. &nbsp;: void </span>
  215. </dt>
  216. <dd>Sets the initial module values</dd>
  217. </dl>
  218. <section class="phpdocumentor-properties">
  219. <h3 class="phpdocumentor-elements__header" id="properties">
  220. Properties
  221. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  222. </h3>
  223. <article
  224. class="
  225. phpdocumentor-element
  226. -property
  227. -protected
  228. "
  229. >
  230. <h4 class="phpdocumentor-element__name" id="property_length">
  231. $length
  232. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  233. <span class="phpdocumentor-element__modifiers">
  234. </span>
  235. </h4>
  236. <aside class="phpdocumentor-element-found-in">
  237. <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>
  238. :
  239. <span class="phpdocumentor-element-found-in__line">40</span>
  240. </aside>
  241. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  242. <code class="phpdocumentor-code phpdocumentor-signature ">
  243. <span class="phpdocumentor-signature__visibility">protected</span>
  244. <span class="phpdocumentor-signature__type">int</span>
  245. <span class="phpdocumentor-signature__name">$length</span>
  246. </code>
  247. <section class="phpdocumentor-description"></section>
  248. </article>
  249. <article
  250. class="
  251. phpdocumentor-element
  252. -property
  253. -protected
  254. "
  255. >
  256. <h4 class="phpdocumentor-element__name" id="property_matrix">
  257. $matrix
  258. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  259. <span class="phpdocumentor-element__modifiers">
  260. </span>
  261. </h4>
  262. <aside class="phpdocumentor-element-found-in">
  263. <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>
  264. :
  265. <span class="phpdocumentor-element-found-in__line">50</span>
  266. </aside>
  267. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  268. <code class="phpdocumentor-code phpdocumentor-signature ">
  269. <span class="phpdocumentor-signature__visibility">protected</span>
  270. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  271. <span class="phpdocumentor-signature__name">$matrix</span>
  272. </code>
  273. <section class="phpdocumentor-description"></section>
  274. </article>
  275. <article
  276. class="
  277. phpdocumentor-element
  278. -property
  279. -protected
  280. "
  281. >
  282. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  283. $moduleCount
  284. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  285. <span class="phpdocumentor-element__modifiers">
  286. </span>
  287. </h4>
  288. <aside class="phpdocumentor-element-found-in">
  289. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  290. :
  291. <span class="phpdocumentor-element-found-in__line">28</span>
  292. </aside>
  293. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  294. <code class="phpdocumentor-code phpdocumentor-signature ">
  295. <span class="phpdocumentor-signature__visibility">protected</span>
  296. <span class="phpdocumentor-signature__type">int</span>
  297. <span class="phpdocumentor-signature__name">$moduleCount</span>
  298. </code>
  299. <section class="phpdocumentor-description"></section>
  300. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  301. Tags
  302. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  303. </h5>
  304. <dl class="phpdocumentor-tag-list">
  305. <dt class="phpdocumentor-tag-list__entry">
  306. <span class="phpdocumentor-tag__name">see</span>
  307. </dt>
  308. <dd class="phpdocumentor-tag-list__definition">
  309. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size"><abbr title="\chillerlan\QRCode\Data\QRMatrix::size()">QRMatrix::size()</abbr></a></span>
  310. </dd>
  311. </dl>
  312. </article>
  313. <article
  314. class="
  315. phpdocumentor-element
  316. -property
  317. -protected
  318. "
  319. >
  320. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  321. $moduleValues
  322. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  323. <span class="phpdocumentor-element__modifiers">
  324. </span>
  325. </h4>
  326. <aside class="phpdocumentor-element-found-in">
  327. <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>
  328. :
  329. <span class="phpdocumentor-element-found-in__line">45</span>
  330. </aside>
  331. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  332. <code class="phpdocumentor-code phpdocumentor-signature ">
  333. <span class="phpdocumentor-signature__visibility">protected</span>
  334. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  335. <span class="phpdocumentor-signature__name">$moduleValues</span>
  336. </code>
  337. <section class="phpdocumentor-description"></section>
  338. </article>
  339. <article
  340. class="
  341. phpdocumentor-element
  342. -property
  343. -protected
  344. "
  345. >
  346. <h4 class="phpdocumentor-element__name" id="property_options">
  347. $options
  348. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  349. <span class="phpdocumentor-element__modifiers">
  350. </span>
  351. </h4>
  352. <aside class="phpdocumentor-element-found-in">
  353. <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>
  354. :
  355. <span class="phpdocumentor-element-found-in__line">55</span>
  356. </aside>
  357. <code class="phpdocumentor-code phpdocumentor-signature ">
  358. <span class="phpdocumentor-signature__visibility">protected</span>
  359. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  360. <span class="phpdocumentor-signature__name">$options</span>
  361. </code>
  362. </article>
  363. <article
  364. class="
  365. phpdocumentor-element
  366. -property
  367. -protected
  368. "
  369. >
  370. <h4 class="phpdocumentor-element__name" id="property_scale">
  371. $scale
  372. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  373. <span class="phpdocumentor-element__modifiers">
  374. </span>
  375. </h4>
  376. <aside class="phpdocumentor-element-found-in">
  377. <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>
  378. :
  379. <span class="phpdocumentor-element-found-in__line">35</span>
  380. </aside>
  381. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  382. <code class="phpdocumentor-code phpdocumentor-signature ">
  383. <span class="phpdocumentor-signature__visibility">protected</span>
  384. <span class="phpdocumentor-signature__type">int</span>
  385. <span class="phpdocumentor-signature__name">$scale</span>
  386. </code>
  387. <section class="phpdocumentor-description"></section>
  388. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  389. Tags
  390. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  391. </h5>
  392. <dl class="phpdocumentor-tag-list">
  393. <dt class="phpdocumentor-tag-list__entry">
  394. <span class="phpdocumentor-tag__name">see</span>
  395. </dt>
  396. <dd class="phpdocumentor-tag-list__definition">
  397. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  398. </dd>
  399. </dl>
  400. </article>
  401. </section>
  402. <section class="phpdocumentor-methods">
  403. <h3 class="phpdocumentor-elements__header" id="methods">
  404. Methods
  405. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  406. </h3>
  407. <article
  408. class="phpdocumentor-element
  409. -method
  410. -public
  411. "
  412. >
  413. <h4 class="phpdocumentor-element__name" id="method___construct">
  414. __construct()
  415. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  416. </h4>
  417. <aside class="phpdocumentor-element-found-in">
  418. <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>
  419. :
  420. <span class="phpdocumentor-element-found-in__line">60</span>
  421. </aside>
  422. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  423. <code class="phpdocumentor-code phpdocumentor-signature ">
  424. <span class="phpdocumentor-signature__visibility">public</span>
  425. <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>
  426. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  427. <dl class="phpdocumentor-argument-list">
  428. <dt class="phpdocumentor-argument-list__entry">
  429. <span class="phpdocumentor-signature__argument__name">$options</span>
  430. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  431. </dt>
  432. <dd class="phpdocumentor-argument-list__definition">
  433. <section class="phpdocumentor-description"></section>
  434. </dd>
  435. <dt class="phpdocumentor-argument-list__entry">
  436. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  437. : <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>
  438. </dt>
  439. <dd class="phpdocumentor-argument-list__definition">
  440. <section class="phpdocumentor-description"></section>
  441. </dd>
  442. </dl>
  443. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  444. <span class="phpdocumentor-signature__response_type">mixed</span>
  445. &mdash;
  446. </article>
  447. <article
  448. class="phpdocumentor-element
  449. -method
  450. -public
  451. "
  452. >
  453. <h4 class="phpdocumentor-element__name" id="method_dump">
  454. dump()
  455. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  456. </h4>
  457. <aside class="phpdocumentor-element-found-in">
  458. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkup.php"><a href="files/src-output-qrmarkup.html"><abbr title="src/Output/QRMarkup.php">QRMarkup.php</abbr></a></abbr>
  459. :
  460. <span class="phpdocumentor-element-found-in__line">44</span>
  461. </aside>
  462. <code class="phpdocumentor-code phpdocumentor-signature ">
  463. <span class="phpdocumentor-signature__visibility">public</span>
  464. <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>
  465. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  466. <dl class="phpdocumentor-argument-list">
  467. <dt class="phpdocumentor-argument-list__entry">
  468. <span class="phpdocumentor-signature__argument__name">$file</span>
  469. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  470. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  471. <dd class="phpdocumentor-argument-list__definition">
  472. <section class="phpdocumentor-description"></section>
  473. </dd>
  474. </dl>
  475. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  476. Tags
  477. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  478. </h5>
  479. <dl class="phpdocumentor-tag-list">
  480. <dt class="phpdocumentor-tag-list__entry">
  481. <span class="phpdocumentor-tag__name">inheritDoc</span>
  482. </dt>
  483. <dd class="phpdocumentor-tag-list__definition">
  484. </dd>
  485. </dl>
  486. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  487. <span class="phpdocumentor-signature__response_type">string</span>
  488. &mdash;
  489. </article>
  490. <article
  491. class="phpdocumentor-element
  492. -method
  493. -protected
  494. "
  495. >
  496. <h4 class="phpdocumentor-element__name" id="method_base64encode">
  497. base64encode()
  498. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode" class="headerlink"><i class="fas fa-link"></i></a>
  499. </h4>
  500. <aside class="phpdocumentor-element-found-in">
  501. <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>
  502. :
  503. <span class="phpdocumentor-element-found-in__line">111</span>
  504. </aside>
  505. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  506. <code class="phpdocumentor-code phpdocumentor-signature ">
  507. <span class="phpdocumentor-signature__visibility">protected</span>
  508. <span class="phpdocumentor-signature__name">base64encode</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>
  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">$data</span>
  513. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  514. </dt>
  515. <dd class="phpdocumentor-argument-list__definition">
  516. <section class="phpdocumentor-description"></section>
  517. </dd>
  518. <dt class="phpdocumentor-argument-list__entry">
  519. <span class="phpdocumentor-signature__argument__name">$mime</span>
  520. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  521. </dt>
  522. <dd class="phpdocumentor-argument-list__definition">
  523. <section class="phpdocumentor-description"></section>
  524. </dd>
  525. </dl>
  526. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  527. <span class="phpdocumentor-signature__response_type">string</span>
  528. &mdash;
  529. </article>
  530. <article
  531. class="phpdocumentor-element
  532. -method
  533. -protected
  534. "
  535. >
  536. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  537. collectModules()
  538. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  539. </h4>
  540. <aside class="phpdocumentor-element-found-in">
  541. <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>
  542. :
  543. <span class="phpdocumentor-element-found-in__line">145</span>
  544. </aside>
  545. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform functio on each module and
  546. returns an array with the transformed modules</p>
  547. <code class="phpdocumentor-code phpdocumentor-signature ">
  548. <span class="phpdocumentor-signature__visibility">protected</span>
  549. <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>
  550. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  551. <p>$x - current column
  552. $y - current row
  553. $M_TYPE - field value
  554. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  555. </section>
  556. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  557. <dl class="phpdocumentor-argument-list">
  558. <dt class="phpdocumentor-argument-list__entry">
  559. <span class="phpdocumentor-signature__argument__name">$transform</span>
  560. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  561. </dt>
  562. <dd class="phpdocumentor-argument-list__definition">
  563. <section class="phpdocumentor-description"></section>
  564. </dd>
  565. </dl>
  566. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  567. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  568. &mdash;
  569. </article>
  570. <article
  571. class="phpdocumentor-element
  572. -method
  573. -protected
  574. "
  575. >
  576. <h4 class="phpdocumentor-element__name" id="method_createMarkup">
  577. createMarkup()
  578. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#method_createMarkup" class="headerlink"><i class="fas fa-link"></i></a>
  579. </h4>
  580. <aside class="phpdocumentor-element-found-in">
  581. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupHTML.php"><a href="files/src-output-qrmarkuphtml.html"><abbr title="src/Output/QRMarkupHTML.php">QRMarkupHTML.php</abbr></a></abbr>
  582. :
  583. <span class="phpdocumentor-element-found-in__line">23</span>
  584. </aside>
  585. <code class="phpdocumentor-code phpdocumentor-signature ">
  586. <span class="phpdocumentor-signature__visibility">protected</span>
  587. <span class="phpdocumentor-signature__name">createMarkup</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$saveToFile</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  588. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  589. <dl class="phpdocumentor-argument-list">
  590. <dt class="phpdocumentor-argument-list__entry">
  591. <span class="phpdocumentor-signature__argument__name">$saveToFile</span>
  592. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  593. </dt>
  594. <dd class="phpdocumentor-argument-list__definition">
  595. <section class="phpdocumentor-description"></section>
  596. </dd>
  597. </dl>
  598. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  599. Tags
  600. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  601. </h5>
  602. <dl class="phpdocumentor-tag-list">
  603. <dt class="phpdocumentor-tag-list__entry">
  604. <span class="phpdocumentor-tag__name">inheritDoc</span>
  605. </dt>
  606. <dd class="phpdocumentor-tag-list__definition">
  607. </dd>
  608. </dl>
  609. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  610. <span class="phpdocumentor-signature__response_type">string</span>
  611. &mdash;
  612. </article>
  613. <article
  614. class="phpdocumentor-element
  615. -method
  616. -protected
  617. "
  618. >
  619. <h4 class="phpdocumentor-element__name" id="method_getCssClass">
  620. getCssClass()
  621. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#method_getCssClass" class="headerlink"><i class="fas fa-link"></i></a>
  622. </h4>
  623. <aside class="phpdocumentor-element-found-in">
  624. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupHTML.php"><a href="files/src-output-qrmarkuphtml.html"><abbr title="src/Output/QRMarkupHTML.php">QRMarkupHTML.php</abbr></a></abbr>
  625. :
  626. <span class="phpdocumentor-element-found-in__line">56</span>
  627. </aside>
  628. <p class="phpdocumentor-summary">returns a string with all css classes for the current element</p>
  629. <code class="phpdocumentor-code phpdocumentor-signature ">
  630. <span class="phpdocumentor-signature__visibility">protected</span>
  631. <span class="phpdocumentor-signature__name">getCssClass</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">string</span></code>
  632. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  633. <dl class="phpdocumentor-argument-list">
  634. <dt class="phpdocumentor-argument-list__entry">
  635. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  636. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  637. </dt>
  638. <dd class="phpdocumentor-argument-list__definition">
  639. <section class="phpdocumentor-description"></section>
  640. </dd>
  641. </dl>
  642. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  643. Tags
  644. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  645. </h5>
  646. <dl class="phpdocumentor-tag-list">
  647. <dt class="phpdocumentor-tag-list__entry">
  648. <span class="phpdocumentor-tag__name">inheritDoc</span>
  649. </dt>
  650. <dd class="phpdocumentor-tag-list__definition">
  651. </dd>
  652. </dl>
  653. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  654. <span class="phpdocumentor-signature__response_type">string</span>
  655. &mdash;
  656. </article>
  657. <article
  658. class="phpdocumentor-element
  659. -method
  660. -protected
  661. -abstract "
  662. >
  663. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  664. getDefaultModuleValue()
  665. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  666. </h4>
  667. <aside class="phpdocumentor-element-found-in">
  668. <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>
  669. :
  670. <span class="phpdocumentor-element-found-in__line">106</span>
  671. </aside>
  672. <p class="phpdocumentor-summary">Returns a defualt value for either dark or light modules (return value depends on the output module)</p>
  673. <code class="phpdocumentor-code phpdocumentor-signature ">
  674. <span class="phpdocumentor-signature__visibility">protected</span>
  675. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getDefaultModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$isDark</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  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">$isDark</span>
  680. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  681. </dt>
  682. <dd class="phpdocumentor-argument-list__definition">
  683. <section class="phpdocumentor-description"></section>
  684. </dd>
  685. </dl>
  686. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  687. <span class="phpdocumentor-signature__response_type">mixed</span>
  688. &mdash;
  689. </article>
  690. <article
  691. class="phpdocumentor-element
  692. -method
  693. -protected
  694. -abstract "
  695. >
  696. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  697. getModuleValue()
  698. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  702. :
  703. <span class="phpdocumentor-element-found-in__line">99</span>
  704. </aside>
  705. <p class="phpdocumentor-summary">Returns the final value for the given input (return value depends on the output module)</p>
  706. <code class="phpdocumentor-code phpdocumentor-signature ">
  707. <span class="phpdocumentor-signature__visibility">protected</span>
  708. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  709. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  710. <dl class="phpdocumentor-argument-list">
  711. <dt class="phpdocumentor-argument-list__entry">
  712. <span class="phpdocumentor-signature__argument__name">$value</span>
  713. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  714. </dt>
  715. <dd class="phpdocumentor-argument-list__definition">
  716. </dd>
  717. </dl>
  718. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  719. <span class="phpdocumentor-signature__response_type">mixed</span>
  720. &mdash;
  721. </article>
  722. <article
  723. class="phpdocumentor-element
  724. -method
  725. -protected
  726. -abstract "
  727. >
  728. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  729. moduleValueIsValid()
  730. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  731. </h4>
  732. <aside class="phpdocumentor-element-found-in">
  733. <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>
  734. :
  735. <span class="phpdocumentor-element-found-in__line">90</span>
  736. </aside>
  737. <p class="phpdocumentor-summary">Determines whether the given value is valid</p>
  738. <code class="phpdocumentor-code phpdocumentor-signature ">
  739. <span class="phpdocumentor-signature__visibility">protected</span>
  740. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">moduleValueIsValid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  741. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  742. <dl class="phpdocumentor-argument-list">
  743. <dt class="phpdocumentor-argument-list__entry">
  744. <span class="phpdocumentor-signature__argument__name">$value</span>
  745. : <span class="phpdocumentor-signature__argument__return-type">mixed|null</span>
  746. </dt>
  747. <dd class="phpdocumentor-argument-list__definition">
  748. </dd>
  749. </dl>
  750. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  751. <span class="phpdocumentor-signature__response_type">bool</span>
  752. &mdash;
  753. </article>
  754. <article
  755. class="phpdocumentor-element
  756. -method
  757. -protected
  758. "
  759. >
  760. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  761. saveToFile()
  762. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  763. </h4>
  764. <aside class="phpdocumentor-element-found-in">
  765. <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>
  766. :
  767. <span class="phpdocumentor-element-found-in__line">123</span>
  768. </aside>
  769. <p class="phpdocumentor-summary">saves the qr data to a file</p>
  770. <code class="phpdocumentor-code phpdocumentor-signature ">
  771. <span class="phpdocumentor-signature__visibility">protected</span>
  772. <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 class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  773. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  774. <dl class="phpdocumentor-argument-list">
  775. <dt class="phpdocumentor-argument-list__entry">
  776. <span class="phpdocumentor-signature__argument__name">$data</span>
  777. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  778. </dt>
  779. <dd class="phpdocumentor-argument-list__definition">
  780. <section class="phpdocumentor-description"></section>
  781. </dd>
  782. <dt class="phpdocumentor-argument-list__entry">
  783. <span class="phpdocumentor-signature__argument__name">$file</span>
  784. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  785. </dt>
  786. <dd class="phpdocumentor-argument-list__definition">
  787. <section class="phpdocumentor-description"></section>
  788. </dd>
  789. </dl>
  790. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  791. Tags
  792. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  793. </h5>
  794. <dl class="phpdocumentor-tag-list">
  795. <dt class="phpdocumentor-tag-list__entry">
  796. <span class="phpdocumentor-tag__name">see</span>
  797. </dt>
  798. <dd class="phpdocumentor-tag-list__definition">
  799. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  800. </dd>
  801. <dt class="phpdocumentor-tag-list__entry">
  802. <span class="phpdocumentor-tag__name">see</span>
  803. </dt>
  804. <dd class="phpdocumentor-tag-list__definition">
  805. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::cachefile">QROptions::cachefile</abbr></span>
  806. </dd>
  807. <dt class="phpdocumentor-tag-list__entry">
  808. <span class="phpdocumentor-tag__name">throws</span>
  809. </dt>
  810. <dd class="phpdocumentor-tag-list__definition">
  811. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  812. </dd>
  813. </dl>
  814. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  815. <span class="phpdocumentor-signature__response_type">void</span>
  816. &mdash;
  817. </article>
  818. <article
  819. class="phpdocumentor-element
  820. -method
  821. -protected
  822. "
  823. >
  824. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  825. setModuleValues()
  826. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  827. </h4>
  828. <aside class="phpdocumentor-element-found-in">
  829. <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>
  830. :
  831. <span class="phpdocumentor-element-found-in__line">73</span>
  832. </aside>
  833. <p class="phpdocumentor-summary">Sets the initial module values</p>
  834. <code class="phpdocumentor-code phpdocumentor-signature ">
  835. <span class="phpdocumentor-signature__visibility">protected</span>
  836. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  837. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  838. <span class="phpdocumentor-signature__response_type">void</span>
  839. &mdash;
  840. </article>
  841. </section>
  842. <script type="text/javascript">
  843. function loadExternalCodeSnippets(line) {
  844. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  845. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  846. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  847. var language = 'php';
  848. var code = document.createElement('code');
  849. code.className = 'language-' + language;
  850. pre.textContent = '';
  851. pre.setAttribute('data-line', line)
  852. code.textContent = 'Loading…';
  853. pre.appendChild(code);
  854. var xhr = new XMLHttpRequest();
  855. xhr.open('GET', src, true);
  856. xhr.onreadystatechange = function () {
  857. if (xhr.readyState == 4) {
  858. if (xhr.status < 400 && xhr.responseText) {
  859. code.textContent = xhr.responseText;
  860. Prism.highlightElement(code);
  861. }
  862. else if (xhr.status >= 400) {
  863. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  864. }
  865. else {
  866. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  867. }
  868. }
  869. };
  870. xhr.send(null);
  871. });
  872. }
  873. var modals = document.querySelectorAll("[data-modal]");
  874. modals.forEach(function (trigger) {
  875. trigger.addEventListener("click", function (event) {
  876. //event.preventDefault();
  877. const modal = document.getElementById(trigger.dataset.modal);
  878. modal.classList.add("phpdocumentor-modal__open");
  879. loadExternalCodeSnippets(trigger.dataset.line)
  880. const exits = modal.querySelectorAll("[data-exit-button]");
  881. exits.forEach(function (exit) {
  882. exit.addEventListener("click", function (event) {
  883. event.preventDefault();
  884. modal.classList.remove("phpdocumentor-modal__open");
  885. });
  886. });
  887. });
  888. });
  889. </script>
  890. </article>
  891. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  892. <section class="phpdocumentor-search-results__dialog">
  893. <header class="phpdocumentor-search-results__header">
  894. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  895. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  896. </header>
  897. <section class="phpdocumentor-search-results__body">
  898. <ul class="phpdocumentor-search-results__entries"></ul>
  899. </section>
  900. </section>
  901. </section>
  902. </div>
  903. </div>
  904. <a href="classes/chillerlan-QRCode-Output-QRMarkupHTML.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  905. </main>
  906. <script>
  907. cssVars({});
  908. </script>
  909. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  910. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  911. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  912. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  913. </body>
  914. </html>