chillerlan-QRCode-Output-QRMarkup.html 64 KB

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