chillerlan-QRCode-Output-QRMarkupHTML.html 58 KB

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