chillerlan-QRCode-Output-QRMarkup.html 63 KB

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