chillerlan-QRCode-Output-QROutputAbstract.html 85 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798
  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=Open+Sans:wght@100;200;300;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/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. <h4 class="phpdocumentor-sidebar__root-namespace">
  89. <a href="namespaces/output.html" class="">Output</a>
  90. </h4>
  91. </section>
  92. <section class="phpdocumentor-sidebar__category -packages">
  93. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  94. <h4 class="phpdocumentor-sidebar__root-namespace">
  95. <a href="packages/Application.html" class="">Application</a>
  96. </h4>
  97. </section>
  98. <section class="phpdocumentor-sidebar__category -reports">
  99. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  100. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  101. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  102. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  103. </section>
  104. <section class="phpdocumentor-sidebar__category -indices">
  105. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  106. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  107. </section>
  108. </aside>
  109. <div class="phpdocumentor-column -nine phpdocumentor-content">
  110. <section>
  111. <ul class="phpdocumentor-breadcrumbs">
  112. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  113. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  114. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  115. </ul>
  116. <article class="phpdocumentor-element -class">
  117. <h2 class="phpdocumentor-content__title">
  118. QROutputAbstract
  119. <div class="phpdocumentor-element__package">
  120. in package
  121. <ul class="phpdocumentor-breadcrumbs">
  122. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  123. </ul>
  124. </div>
  125. <span class="phpdocumentor-element__implements">
  126. implements
  127. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a> </span>
  128. </h2>
  129. <div class="phpdocumentor-label-line">
  130. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Abstract</span><span>Yes</span></div>
  131. </div>
  132. <aside class="phpdocumentor-element-found-in">
  133. <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>
  134. :
  135. <span class="phpdocumentor-element-found-in__line">22</span>
  136. </aside>
  137. <p class="phpdocumentor-summary">common output abstract</p>
  138. <h3 id="toc">
  139. Table of Contents
  140. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  141. </h3>
  142. <h4 id="toc-interfaces">
  143. Interfaces
  144. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc-interfaces" class="headerlink"><i class="fas fa-link"></i></a>
  145. </h4>
  146. <dl class="phpdocumentor-table-of-contents">
  147. <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></dt><dd>Converts the data matrix into readable output</dd> </dl>
  148. <h4 id="toc-properties">
  149. Properties
  150. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  151. </h4>
  152. <dl class="phpdocumentor-table-of-contents">
  153. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  154. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter</a>
  155. <span>
  156. &nbsp;: float </span>
  157. </dt>
  158. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  159. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius</a>
  160. <span>
  161. &nbsp;: float </span>
  162. </dt>
  163. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  164. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths</a>
  165. <span>
  166. &nbsp;: bool </span>
  167. </dt>
  168. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules</a>
  170. <span>
  171. &nbsp;: bool </span>
  172. </dt>
  173. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  174. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules</a>
  175. <span>
  176. &nbsp;: bool </span>
  177. </dt>
  178. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  179. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol</a>
  180. <span>
  181. &nbsp;: string </span>
  182. </dt>
  183. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  184. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect</a>
  185. <span>
  186. &nbsp;: array&lt;string|int, mixed&gt; </span>
  187. </dt>
  188. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  189. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare</a>
  190. <span>
  191. &nbsp;: array&lt;string|int, mixed&gt; </span>
  192. </dt>
  193. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  194. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  195. <span>
  196. &nbsp;: int </span>
  197. </dt>
  198. <dd>the side length of the QR image (modules * scale)</dd>
  199. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  200. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  201. <span>
  202. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  203. </dt>
  204. <dd>the (filled) data matrix object</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  206. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  207. <span>
  208. &nbsp;: int </span>
  209. </dt>
  210. <dd>the current size of the QR matrix</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  212. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  213. <span>
  214. &nbsp;: array&lt;string|int, mixed&gt; </span>
  215. </dt>
  216. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  217. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  218. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  219. <span>
  220. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  221. </dt>
  222. <dd>the options instance</dd>
  223. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  224. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  225. <span>
  226. &nbsp;: int </span>
  227. </dt>
  228. </dl>
  229. <h4 id="toc-methods">
  230. Methods
  231. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  232. </h4>
  233. <dl class="phpdocumentor-table-of-contents">
  234. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  235. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  236. <span>
  237. &nbsp;: mixed </span>
  238. </dt>
  239. <dd>QROutputAbstract constructor.</dd>
  240. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  241. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  242. <span>
  243. &nbsp;: array&lt;string|int, mixed&gt; </span>
  244. </dt>
  245. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  246. returns an array with the transformed modules</dd>
  247. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  248. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a>
  249. <span>
  250. &nbsp;: void </span>
  251. </dt>
  252. <dd>Creates copies of several QROptions values to avoid calling the magic getters
  253. in long loops for a significant performance increase.</dd>
  254. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  255. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  256. <span>
  257. &nbsp;: mixed </span>
  258. </dt>
  259. <dd>Returns a default value for either dark or light modules (return value depends on the output class)</dd>
  260. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  261. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  262. <span>
  263. &nbsp;: mixed </span>
  264. </dt>
  265. <dd>Returns the prepared value for the given $M_TYPE</dd>
  266. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  267. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  268. <span>
  269. &nbsp;: mixed </span>
  270. </dt>
  271. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  272. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  273. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a>
  274. <span>
  275. &nbsp;: array&lt;string|int, mixed&gt; </span>
  276. </dt>
  277. <dd>Returns a 2 element array with the current output width and height</dd>
  278. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  279. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a>
  280. <span>
  281. &nbsp;: mixed </span>
  282. </dt>
  283. <dd>Prepares the value for the given input (return value depends on the output class)</dd>
  284. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  285. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  286. <span>
  287. &nbsp;: void </span>
  288. </dt>
  289. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  290. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  291. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  292. <span>
  293. &nbsp;: void </span>
  294. </dt>
  295. <dd>Sets/updates the matrix dimensions</dd>
  296. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  297. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  298. <span>
  299. &nbsp;: void </span>
  300. </dt>
  301. <dd>Sets the initial module values</dd>
  302. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  303. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  304. <span>
  305. &nbsp;: string </span>
  306. </dt>
  307. <dd>Returns a base64 data URI for the given string and mime type</dd>
  308. </dl>
  309. <section class="phpdocumentor-properties">
  310. <h3 class="phpdocumentor-elements__header" id="properties">
  311. Properties
  312. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  313. </h3>
  314. <article
  315. class="
  316. phpdocumentor-element
  317. -property
  318. -protected
  319. "
  320. >
  321. <h4 class="phpdocumentor-element__name" id="property_circleDiameter">
  322. $circleDiameter
  323. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter" class="headerlink"><i class="fas fa-link"></i></a>
  324. <span class="phpdocumentor-element__modifiers">
  325. </span>
  326. </h4>
  327. <aside class="phpdocumentor-element-found-in">
  328. <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>
  329. :
  330. <span class="phpdocumentor-element-found-in__line">67</span>
  331. </aside>
  332. <code class="phpdocumentor-code phpdocumentor-signature ">
  333. <span class="phpdocumentor-signature__visibility">protected</span>
  334. <span class="phpdocumentor-signature__type">float</span>
  335. <span class="phpdocumentor-signature__name">$circleDiameter</span>
  336. </code>
  337. </article>
  338. <article
  339. class="
  340. phpdocumentor-element
  341. -property
  342. -protected
  343. "
  344. >
  345. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  346. $circleRadius
  347. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  348. <span class="phpdocumentor-element__modifiers">
  349. </span>
  350. </h4>
  351. <aside class="phpdocumentor-element-found-in">
  352. <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>
  353. :
  354. <span class="phpdocumentor-element-found-in__line">66</span>
  355. </aside>
  356. <code class="phpdocumentor-code phpdocumentor-signature ">
  357. <span class="phpdocumentor-signature__visibility">protected</span>
  358. <span class="phpdocumentor-signature__type">float</span>
  359. <span class="phpdocumentor-signature__name">$circleRadius</span>
  360. </code>
  361. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  362. Tags
  363. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius#tags" class="headerlink"><i class="fas fa-link"></i></a>
  364. </h5>
  365. <dl class="phpdocumentor-tag-list">
  366. <dt class="phpdocumentor-tag-list__entry">
  367. <span class="phpdocumentor-tag__name">see</span>
  368. </dt>
  369. <dd class="phpdocumentor-tag-list__definition">
  370. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$circleRadius">QROptions::$circleRadius</abbr></span>
  371. </dd>
  372. </dl>
  373. </article>
  374. <article
  375. class="
  376. phpdocumentor-element
  377. -property
  378. -protected
  379. "
  380. >
  381. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  382. $connectPaths
  383. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  384. <span class="phpdocumentor-element__modifiers">
  385. </span>
  386. </h4>
  387. <aside class="phpdocumentor-element-found-in">
  388. <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>
  389. :
  390. <span class="phpdocumentor-element-found-in__line">54</span>
  391. </aside>
  392. <code class="phpdocumentor-code phpdocumentor-signature ">
  393. <span class="phpdocumentor-signature__visibility">protected</span>
  394. <span class="phpdocumentor-signature__type">bool</span>
  395. <span class="phpdocumentor-signature__name">$connectPaths</span>
  396. </code>
  397. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  398. Tags
  399. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  400. </h5>
  401. <dl class="phpdocumentor-tag-list">
  402. <dt class="phpdocumentor-tag-list__entry">
  403. <span class="phpdocumentor-tag__name">see</span>
  404. </dt>
  405. <dd class="phpdocumentor-tag-list__definition">
  406. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$connectPaths">QROptions::$connectPaths</abbr></span>
  407. </dd>
  408. </dl>
  409. </article>
  410. <article
  411. class="
  412. phpdocumentor-element
  413. -property
  414. -protected
  415. "
  416. >
  417. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  418. $drawCircularModules
  419. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  420. <span class="phpdocumentor-element__modifiers">
  421. </span>
  422. </h4>
  423. <aside class="phpdocumentor-element-found-in">
  424. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  425. :
  426. <span class="phpdocumentor-element-found-in__line">62</span>
  427. </aside>
  428. <code class="phpdocumentor-code phpdocumentor-signature ">
  429. <span class="phpdocumentor-signature__visibility">protected</span>
  430. <span class="phpdocumentor-signature__type">bool</span>
  431. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  432. </code>
  433. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  434. Tags
  435. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  436. </h5>
  437. <dl class="phpdocumentor-tag-list">
  438. <dt class="phpdocumentor-tag-list__entry">
  439. <span class="phpdocumentor-tag__name">see</span>
  440. </dt>
  441. <dd class="phpdocumentor-tag-list__definition">
  442. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawCircularModules">QROptions::$drawCircularModules</abbr></span>
  443. </dd>
  444. </dl>
  445. </article>
  446. <article
  447. class="
  448. phpdocumentor-element
  449. -property
  450. -protected
  451. "
  452. >
  453. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  454. $drawLightModules
  455. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  456. <span class="phpdocumentor-element__modifiers">
  457. </span>
  458. </h4>
  459. <aside class="phpdocumentor-element-found-in">
  460. <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>
  461. :
  462. <span class="phpdocumentor-element-found-in__line">60</span>
  463. </aside>
  464. <code class="phpdocumentor-code phpdocumentor-signature ">
  465. <span class="phpdocumentor-signature__visibility">protected</span>
  466. <span class="phpdocumentor-signature__type">bool</span>
  467. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  468. </code>
  469. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  470. Tags
  471. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  472. </h5>
  473. <dl class="phpdocumentor-tag-list">
  474. <dt class="phpdocumentor-tag-list__entry">
  475. <span class="phpdocumentor-tag__name">see</span>
  476. </dt>
  477. <dd class="phpdocumentor-tag-list__definition">
  478. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawLightModules">QROptions::$drawLightModules</abbr></span>
  479. </dd>
  480. </dl>
  481. </article>
  482. <article
  483. class="
  484. phpdocumentor-element
  485. -property
  486. -protected
  487. "
  488. >
  489. <h4 class="phpdocumentor-element__name" id="property_eol">
  490. $eol
  491. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  492. <span class="phpdocumentor-element__modifiers">
  493. </span>
  494. </h4>
  495. <aside class="phpdocumentor-element-found-in">
  496. <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>
  497. :
  498. <span class="phpdocumentor-element-found-in__line">58</span>
  499. </aside>
  500. <code class="phpdocumentor-code phpdocumentor-signature ">
  501. <span class="phpdocumentor-signature__visibility">protected</span>
  502. <span class="phpdocumentor-signature__type">string</span>
  503. <span class="phpdocumentor-signature__name">$eol</span>
  504. </code>
  505. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  506. Tags
  507. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol#tags" class="headerlink"><i class="fas fa-link"></i></a>
  508. </h5>
  509. <dl class="phpdocumentor-tag-list">
  510. <dt class="phpdocumentor-tag-list__entry">
  511. <span class="phpdocumentor-tag__name">see</span>
  512. </dt>
  513. <dd class="phpdocumentor-tag-list__definition">
  514. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$eol">QROptions::$eol</abbr></span>
  515. </dd>
  516. </dl>
  517. </article>
  518. <article
  519. class="
  520. phpdocumentor-element
  521. -property
  522. -protected
  523. "
  524. >
  525. <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
  526. $excludeFromConnect
  527. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  528. <span class="phpdocumentor-element__modifiers">
  529. </span>
  530. </h4>
  531. <aside class="phpdocumentor-element-found-in">
  532. <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>
  533. :
  534. <span class="phpdocumentor-element-found-in__line">56</span>
  535. </aside>
  536. <code class="phpdocumentor-code phpdocumentor-signature ">
  537. <span class="phpdocumentor-signature__visibility">protected</span>
  538. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  539. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  540. </code>
  541. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  542. Tags
  543. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect#tags" class="headerlink"><i class="fas fa-link"></i></a>
  544. </h5>
  545. <dl class="phpdocumentor-tag-list">
  546. <dt class="phpdocumentor-tag-list__entry">
  547. <span class="phpdocumentor-tag__name">see</span>
  548. </dt>
  549. <dd class="phpdocumentor-tag-list__definition">
  550. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$excludeFromConnect">QROptions::$excludeFromConnect</abbr></span>
  551. </dd>
  552. </dl>
  553. </article>
  554. <article
  555. class="
  556. phpdocumentor-element
  557. -property
  558. -protected
  559. "
  560. >
  561. <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
  562. $keepAsSquare
  563. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  564. <span class="phpdocumentor-element__modifiers">
  565. </span>
  566. </h4>
  567. <aside class="phpdocumentor-element-found-in">
  568. <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>
  569. :
  570. <span class="phpdocumentor-element-found-in__line">64</span>
  571. </aside>
  572. <code class="phpdocumentor-code phpdocumentor-signature ">
  573. <span class="phpdocumentor-signature__visibility">protected</span>
  574. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  575. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  576. </code>
  577. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  578. Tags
  579. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare#tags" class="headerlink"><i class="fas fa-link"></i></a>
  580. </h5>
  581. <dl class="phpdocumentor-tag-list">
  582. <dt class="phpdocumentor-tag-list__entry">
  583. <span class="phpdocumentor-tag__name">see</span>
  584. </dt>
  585. <dd class="phpdocumentor-tag-list__definition">
  586. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$keepAsSquare">QROptions::$keepAsSquare</abbr></span>
  587. </dd>
  588. </dl>
  589. </article>
  590. <article
  591. class="
  592. phpdocumentor-element
  593. -property
  594. -protected
  595. "
  596. >
  597. <h4 class="phpdocumentor-element__name" id="property_length">
  598. $length
  599. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  600. <span class="phpdocumentor-element__modifiers">
  601. </span>
  602. </h4>
  603. <aside class="phpdocumentor-element-found-in">
  604. <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>
  605. :
  606. <span class="phpdocumentor-element-found-in__line">34</span>
  607. </aside>
  608. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  609. <code class="phpdocumentor-code phpdocumentor-signature ">
  610. <span class="phpdocumentor-signature__visibility">protected</span>
  611. <span class="phpdocumentor-signature__type">int</span>
  612. <span class="phpdocumentor-signature__name">$length</span>
  613. </code>
  614. </article>
  615. <article
  616. class="
  617. phpdocumentor-element
  618. -property
  619. -protected
  620. "
  621. >
  622. <h4 class="phpdocumentor-element__name" id="property_matrix">
  623. $matrix
  624. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  625. <span class="phpdocumentor-element__modifiers">
  626. </span>
  627. </h4>
  628. <aside class="phpdocumentor-element-found-in">
  629. <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>
  630. :
  631. <span class="phpdocumentor-element-found-in__line">44</span>
  632. </aside>
  633. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  634. <code class="phpdocumentor-code phpdocumentor-signature ">
  635. <span class="phpdocumentor-signature__visibility">protected</span>
  636. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  637. <span class="phpdocumentor-signature__name">$matrix</span>
  638. </code>
  639. </article>
  640. <article
  641. class="
  642. phpdocumentor-element
  643. -property
  644. -protected
  645. "
  646. >
  647. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  648. $moduleCount
  649. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  650. <span class="phpdocumentor-element__modifiers">
  651. </span>
  652. </h4>
  653. <aside class="phpdocumentor-element-found-in">
  654. <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>
  655. :
  656. <span class="phpdocumentor-element-found-in__line">29</span>
  657. </aside>
  658. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  659. <code class="phpdocumentor-code phpdocumentor-signature ">
  660. <span class="phpdocumentor-signature__visibility">protected</span>
  661. <span class="phpdocumentor-signature__type">int</span>
  662. <span class="phpdocumentor-signature__name">$moduleCount</span>
  663. </code>
  664. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  665. Tags
  666. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  667. </h5>
  668. <dl class="phpdocumentor-tag-list">
  669. <dt class="phpdocumentor-tag-list__entry">
  670. <span class="phpdocumentor-tag__name">see</span>
  671. </dt>
  672. <dd class="phpdocumentor-tag-list__definition">
  673. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getSize()">QRMatrix::getSize()</abbr></a></span>
  674. </dd>
  675. </dl>
  676. </article>
  677. <article
  678. class="
  679. phpdocumentor-element
  680. -property
  681. -protected
  682. "
  683. >
  684. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  685. $moduleValues
  686. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  687. <span class="phpdocumentor-element__modifiers">
  688. </span>
  689. </h4>
  690. <aside class="phpdocumentor-element-found-in">
  691. <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>
  692. :
  693. <span class="phpdocumentor-element-found-in__line">39</span>
  694. </aside>
  695. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  696. <code class="phpdocumentor-code phpdocumentor-signature ">
  697. <span class="phpdocumentor-signature__visibility">protected</span>
  698. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  699. <span class="phpdocumentor-signature__name">$moduleValues</span>
  700. </code>
  701. </article>
  702. <article
  703. class="
  704. phpdocumentor-element
  705. -property
  706. -protected
  707. "
  708. >
  709. <h4 class="phpdocumentor-element__name" id="property_options">
  710. $options
  711. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  712. <span class="phpdocumentor-element__modifiers">
  713. </span>
  714. </h4>
  715. <aside class="phpdocumentor-element-found-in">
  716. <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>
  717. :
  718. <span class="phpdocumentor-element-found-in__line">49</span>
  719. </aside>
  720. <p class="phpdocumentor-summary">the options instance</p>
  721. <code class="phpdocumentor-code phpdocumentor-signature ">
  722. <span class="phpdocumentor-signature__visibility">protected</span>
  723. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  724. <span class="phpdocumentor-signature__name">$options</span>
  725. </code>
  726. </article>
  727. <article
  728. class="
  729. phpdocumentor-element
  730. -property
  731. -protected
  732. "
  733. >
  734. <h4 class="phpdocumentor-element__name" id="property_scale">
  735. $scale
  736. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  737. <span class="phpdocumentor-element__modifiers">
  738. </span>
  739. </h4>
  740. <aside class="phpdocumentor-element-found-in">
  741. <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>
  742. :
  743. <span class="phpdocumentor-element-found-in__line">52</span>
  744. </aside>
  745. <code class="phpdocumentor-code phpdocumentor-signature ">
  746. <span class="phpdocumentor-signature__visibility">protected</span>
  747. <span class="phpdocumentor-signature__type">int</span>
  748. <span class="phpdocumentor-signature__name">$scale</span>
  749. </code>
  750. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  751. Tags
  752. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  753. </h5>
  754. <dl class="phpdocumentor-tag-list">
  755. <dt class="phpdocumentor-tag-list__entry">
  756. <span class="phpdocumentor-tag__name">see</span>
  757. </dt>
  758. <dd class="phpdocumentor-tag-list__definition">
  759. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  760. </dd>
  761. </dl>
  762. </article>
  763. </section>
  764. <section class="phpdocumentor-methods">
  765. <h3 class="phpdocumentor-elements__header" id="methods">
  766. Methods
  767. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  768. </h3>
  769. <article
  770. class="phpdocumentor-element
  771. -method
  772. -public
  773. "
  774. >
  775. <h4 class="phpdocumentor-element__name" id="method___construct">
  776. __construct()
  777. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  778. </h4>
  779. <aside class="phpdocumentor-element-found-in">
  780. <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>
  781. :
  782. <span class="phpdocumentor-element-found-in__line">72</span>
  783. </aside>
  784. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  785. <code class="phpdocumentor-code phpdocumentor-signature ">
  786. <span class="phpdocumentor-signature__visibility">public</span>
  787. <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>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a>&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>
  788. <div class="phpdocumentor-label-line">
  789. </div>
  790. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  791. <dl class="phpdocumentor-argument-list">
  792. <dt class="phpdocumentor-argument-list__entry">
  793. <span class="phpdocumentor-signature__argument__name">$options</span>
  794. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  795. </dt>
  796. <dd class="phpdocumentor-argument-list__definition">
  797. </dd>
  798. <dt class="phpdocumentor-argument-list__entry">
  799. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  800. : <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>
  801. </dt>
  802. <dd class="phpdocumentor-argument-list__definition">
  803. </dd>
  804. </dl>
  805. </article>
  806. <article
  807. class="phpdocumentor-element
  808. -method
  809. -protected
  810. "
  811. >
  812. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  813. collectModules()
  814. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  815. </h4>
  816. <aside class="phpdocumentor-element-found-in">
  817. <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>
  818. :
  819. <span class="phpdocumentor-element-found-in__line">221</span>
  820. </aside>
  821. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  822. returns an array with the transformed modules</p>
  823. <code class="phpdocumentor-code phpdocumentor-signature ">
  824. <span class="phpdocumentor-signature__visibility">protected</span>
  825. <span class="phpdocumentor-signature__name">collectModules</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$transform</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  826. <div class="phpdocumentor-label-line">
  827. </div>
  828. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  829. <p>$x - current column
  830. $y - current row
  831. $M_TYPE - field value
  832. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  833. </section>
  834. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  835. <dl class="phpdocumentor-argument-list">
  836. <dt class="phpdocumentor-argument-list__entry">
  837. <span class="phpdocumentor-signature__argument__name">$transform</span>
  838. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  839. </dt>
  840. <dd class="phpdocumentor-argument-list__definition">
  841. </dd>
  842. </dl>
  843. <section>
  844. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  845. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  846. </section>
  847. </article>
  848. <article
  849. class="phpdocumentor-element
  850. -method
  851. -protected
  852. "
  853. >
  854. <h4 class="phpdocumentor-element__name" id="method_copyVars">
  855. copyVars()
  856. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars" class="headerlink"><i class="fas fa-link"></i></a>
  857. </h4>
  858. <aside class="phpdocumentor-element-found-in">
  859. <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>
  860. :
  861. <span class="phpdocumentor-element-found-in__line">91</span>
  862. </aside>
  863. <p class="phpdocumentor-summary">Creates copies of several QROptions values to avoid calling the magic getters
  864. in long loops for a significant performance increase.</p>
  865. <code class="phpdocumentor-code phpdocumentor-signature ">
  866. <span class="phpdocumentor-signature__visibility">protected</span>
  867. <span class="phpdocumentor-signature__name">copyVars</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  868. <div class="phpdocumentor-label-line">
  869. </div>
  870. <section class="phpdocumentor-description"><p>These variables are usually used in the &quot;module&quot; methods and are called up to 31329 times (at version 40).</p>
  871. </section>
  872. </article>
  873. <article
  874. class="phpdocumentor-element
  875. -method
  876. -protected
  877. -abstract "
  878. >
  879. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  880. getDefaultModuleValue()
  881. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  885. :
  886. <span class="phpdocumentor-element-found-in__line">157</span>
  887. </aside>
  888. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output class)</p>
  889. <code class="phpdocumentor-code phpdocumentor-signature ">
  890. <span class="phpdocumentor-signature__visibility">protected</span>
  891. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getDefaultModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$isDark</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  892. <div class="phpdocumentor-label-line">
  893. </div>
  894. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  895. <dl class="phpdocumentor-argument-list">
  896. <dt class="phpdocumentor-argument-list__entry">
  897. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  898. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  899. </dt>
  900. <dd class="phpdocumentor-argument-list__definition">
  901. </dd>
  902. </dl>
  903. </article>
  904. <article
  905. class="phpdocumentor-element
  906. -method
  907. -protected
  908. "
  909. >
  910. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  911. getModuleValue()
  912. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  913. </h4>
  914. <aside class="phpdocumentor-element-found-in">
  915. <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>
  916. :
  917. <span class="phpdocumentor-element-found-in__line">164</span>
  918. </aside>
  919. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  920. <code class="phpdocumentor-code phpdocumentor-signature ">
  921. <span class="phpdocumentor-signature__visibility">protected</span>
  922. <span class="phpdocumentor-signature__name">getModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  923. <div class="phpdocumentor-label-line">
  924. </div>
  925. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  926. <dl class="phpdocumentor-argument-list">
  927. <dt class="phpdocumentor-argument-list__entry">
  928. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  929. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  930. </dt>
  931. <dd class="phpdocumentor-argument-list__definition">
  932. </dd>
  933. </dl>
  934. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  935. Tags
  936. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  937. </h5>
  938. <dl class="phpdocumentor-tag-list">
  939. <dt class="phpdocumentor-tag-list__entry">
  940. <span class="phpdocumentor-tag__name">throws</span>
  941. </dt>
  942. <dd class="phpdocumentor-tag-list__definition">
  943. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  944. <section class="phpdocumentor-description"><p>if $moduleValues[$M_TYPE] doesn't exist</p>
  945. </section>
  946. </dd>
  947. </dl>
  948. </article>
  949. <article
  950. class="phpdocumentor-element
  951. -method
  952. -protected
  953. "
  954. >
  955. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  956. getModuleValueAt()
  957. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  958. </h4>
  959. <aside class="phpdocumentor-element-found-in">
  960. <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>
  961. :
  962. <span class="phpdocumentor-element-found-in__line">176</span>
  963. </aside>
  964. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  965. <code class="phpdocumentor-code phpdocumentor-signature ">
  966. <span class="phpdocumentor-signature__visibility">protected</span>
  967. <span class="phpdocumentor-signature__name">getModuleValueAt</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  968. <div class="phpdocumentor-label-line">
  969. </div>
  970. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  971. <dl class="phpdocumentor-argument-list">
  972. <dt class="phpdocumentor-argument-list__entry">
  973. <span class="phpdocumentor-signature__argument__name">$x</span>
  974. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  975. </dt>
  976. <dd class="phpdocumentor-argument-list__definition">
  977. </dd>
  978. <dt class="phpdocumentor-argument-list__entry">
  979. <span class="phpdocumentor-signature__argument__name">$y</span>
  980. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  981. </dt>
  982. <dd class="phpdocumentor-argument-list__definition">
  983. </dd>
  984. </dl>
  985. </article>
  986. <article
  987. class="phpdocumentor-element
  988. -method
  989. -protected
  990. "
  991. >
  992. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  993. getOutputDimensions()
  994. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  995. </h4>
  996. <aside class="phpdocumentor-element-found-in">
  997. <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>
  998. :
  999. <span class="phpdocumentor-element-found-in__line">126</span>
  1000. </aside>
  1001. <p class="phpdocumentor-summary">Returns a 2 element array with the current output width and height</p>
  1002. <code class="phpdocumentor-code phpdocumentor-signature ">
  1003. <span class="phpdocumentor-signature__visibility">protected</span>
  1004. <span class="phpdocumentor-signature__name">getOutputDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1005. <div class="phpdocumentor-label-line">
  1006. </div>
  1007. <section class="phpdocumentor-description"><p>The type and units of the values depend on the output class. The default value is the current module count * scale.</p>
  1008. </section>
  1009. <section>
  1010. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1011. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1012. </section>
  1013. </article>
  1014. <article
  1015. class="phpdocumentor-element
  1016. -method
  1017. -protected
  1018. -abstract "
  1019. >
  1020. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  1021. prepareModuleValue()
  1022. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1023. </h4>
  1024. <aside class="phpdocumentor-element-found-in">
  1025. <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>
  1026. :
  1027. <span class="phpdocumentor-element-found-in__line">152</span>
  1028. </aside>
  1029. <p class="phpdocumentor-summary">Prepares the value for the given input (return value depends on the output class)</p>
  1030. <code class="phpdocumentor-code phpdocumentor-signature ">
  1031. <span class="phpdocumentor-signature__visibility">protected</span>
  1032. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">prepareModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  1033. <div class="phpdocumentor-label-line">
  1034. </div>
  1035. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1036. <dl class="phpdocumentor-argument-list">
  1037. <dt class="phpdocumentor-argument-list__entry">
  1038. <span class="phpdocumentor-signature__argument__name">$value</span>
  1039. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1040. </dt>
  1041. <dd class="phpdocumentor-argument-list__definition">
  1042. </dd>
  1043. </dl>
  1044. </article>
  1045. <article
  1046. class="phpdocumentor-element
  1047. -method
  1048. -protected
  1049. "
  1050. >
  1051. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1052. saveToFile()
  1053. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1054. </h4>
  1055. <aside class="phpdocumentor-element-found-in">
  1056. <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>
  1057. :
  1058. <span class="phpdocumentor-element-found-in__line">195</span>
  1059. </aside>
  1060. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1061. <code class="phpdocumentor-code phpdocumentor-signature ">
  1062. <span class="phpdocumentor-signature__visibility">protected</span>
  1063. <span class="phpdocumentor-signature__name">saveToFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1064. <div class="phpdocumentor-label-line">
  1065. </div>
  1066. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1067. <dl class="phpdocumentor-argument-list">
  1068. <dt class="phpdocumentor-argument-list__entry">
  1069. <span class="phpdocumentor-signature__argument__name">$data</span>
  1070. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1071. </dt>
  1072. <dd class="phpdocumentor-argument-list__definition">
  1073. </dd>
  1074. <dt class="phpdocumentor-argument-list__entry">
  1075. <span class="phpdocumentor-signature__argument__name">$file</span>
  1076. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1077. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1078. <dd class="phpdocumentor-argument-list__definition">
  1079. </dd>
  1080. </dl>
  1081. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1082. Tags
  1083. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1084. </h5>
  1085. <dl class="phpdocumentor-tag-list">
  1086. <dt class="phpdocumentor-tag-list__entry">
  1087. <span class="phpdocumentor-tag__name">see</span>
  1088. </dt>
  1089. <dd class="phpdocumentor-tag-list__definition">
  1090. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1091. </dd>
  1092. <dt class="phpdocumentor-tag-list__entry">
  1093. <span class="phpdocumentor-tag__name">see</span>
  1094. </dt>
  1095. <dd class="phpdocumentor-tag-list__definition">
  1096. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1097. </dd>
  1098. <dt class="phpdocumentor-tag-list__entry">
  1099. <span class="phpdocumentor-tag__name">throws</span>
  1100. </dt>
  1101. <dd class="phpdocumentor-tag-list__definition">
  1102. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1103. </dd>
  1104. </dl>
  1105. </article>
  1106. <article
  1107. class="phpdocumentor-element
  1108. -method
  1109. -protected
  1110. "
  1111. >
  1112. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1113. setMatrixDimensions()
  1114. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1115. </h4>
  1116. <aside class="phpdocumentor-element-found-in">
  1117. <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>
  1118. :
  1119. <span class="phpdocumentor-element-found-in__line">115</span>
  1120. </aside>
  1121. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1122. <code class="phpdocumentor-code phpdocumentor-signature ">
  1123. <span class="phpdocumentor-signature__visibility">protected</span>
  1124. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1125. <div class="phpdocumentor-label-line">
  1126. </div>
  1127. <section class="phpdocumentor-description"><p>Call this method if you modify the matrix from within your custom module in case the dimensions have been changed</p>
  1128. </section>
  1129. </article>
  1130. <article
  1131. class="phpdocumentor-element
  1132. -method
  1133. -protected
  1134. "
  1135. >
  1136. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1137. setModuleValues()
  1138. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1139. </h4>
  1140. <aside class="phpdocumentor-element-found-in">
  1141. <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>
  1142. :
  1143. <span class="phpdocumentor-element-found-in__line">133</span>
  1144. </aside>
  1145. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1146. <code class="phpdocumentor-code phpdocumentor-signature ">
  1147. <span class="phpdocumentor-signature__visibility">protected</span>
  1148. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1149. <div class="phpdocumentor-label-line">
  1150. </div>
  1151. </article>
  1152. <article
  1153. class="phpdocumentor-element
  1154. -method
  1155. -protected
  1156. "
  1157. >
  1158. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1159. toBase64DataURI()
  1160. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1161. </h4>
  1162. <aside class="phpdocumentor-element-found-in">
  1163. <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>
  1164. :
  1165. <span class="phpdocumentor-element-found-in__line">183</span>
  1166. </aside>
  1167. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1168. <code class="phpdocumentor-code phpdocumentor-signature ">
  1169. <span class="phpdocumentor-signature__visibility">protected</span>
  1170. <span class="phpdocumentor-signature__name">toBase64DataURI</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1171. <div class="phpdocumentor-label-line">
  1172. </div>
  1173. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1174. <dl class="phpdocumentor-argument-list">
  1175. <dt class="phpdocumentor-argument-list__entry">
  1176. <span class="phpdocumentor-signature__argument__name">$data</span>
  1177. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1178. </dt>
  1179. <dd class="phpdocumentor-argument-list__definition">
  1180. </dd>
  1181. <dt class="phpdocumentor-argument-list__entry">
  1182. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1183. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1184. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1185. <dd class="phpdocumentor-argument-list__definition">
  1186. </dd>
  1187. </dl>
  1188. <section>
  1189. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1190. <span class="phpdocumentor-signature__response_type">string</span>
  1191. </section>
  1192. </article>
  1193. </section>
  1194. <div class="phpdocumentor-modal" id="source-view">
  1195. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1196. <div class="phpdocumentor-modal-container">
  1197. <div class="phpdocumentor-modal-content">
  1198. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Output/QROutputAbstract.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  1199. </div>
  1200. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1201. </div>
  1202. </div>
  1203. <script type="text/javascript">
  1204. (function () {
  1205. function loadExternalCodeSnippet(el, url, line) {
  1206. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1207. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1208. const language = 'php';
  1209. const code = document.createElement('code');
  1210. code.className = 'language-' + language;
  1211. pre.textContent = '';
  1212. pre.setAttribute('data-line', line)
  1213. code.textContent = 'Loading…';
  1214. pre.appendChild(code);
  1215. var xhr = new XMLHttpRequest();
  1216. xhr.open('GET', src, true);
  1217. xhr.onreadystatechange = function () {
  1218. if (xhr.readyState !== 4) {
  1219. return;
  1220. }
  1221. if (xhr.status < 400 && xhr.responseText) {
  1222. code.textContent = xhr.responseText;
  1223. Prism.highlightElement(code);
  1224. return;
  1225. }
  1226. if (xhr.status === 404) {
  1227. code.textContent = '✖ Error: File could not be found';
  1228. return;
  1229. }
  1230. if (xhr.status >= 400) {
  1231. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1232. return;
  1233. }
  1234. code.textContent = '✖ Error: An unknown error occurred';
  1235. };
  1236. xhr.send(null);
  1237. });
  1238. }
  1239. const modalButtons = document.querySelectorAll("[data-modal]");
  1240. const openedAsLocalFile = window.location.protocol === 'file:';
  1241. if (modalButtons.length > 0 && openedAsLocalFile) {
  1242. console.warn(
  1243. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1244. 'browsers block XHR requests when a page is opened this way'
  1245. );
  1246. }
  1247. modalButtons.forEach(function (trigger) {
  1248. if (openedAsLocalFile) {
  1249. trigger.setAttribute("hidden", "hidden");
  1250. }
  1251. trigger.addEventListener("click", function (event) {
  1252. event.preventDefault();
  1253. const modal = document.getElementById(trigger.dataset.modal);
  1254. if (!modal) {
  1255. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1256. return;
  1257. }
  1258. modal.classList.add("phpdocumentor-modal__open");
  1259. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1260. const exits = modal.querySelectorAll("[data-exit-button]");
  1261. exits.forEach(function (exit) {
  1262. exit.addEventListener("click", function (event) {
  1263. event.preventDefault();
  1264. modal.classList.remove("phpdocumentor-modal__open");
  1265. });
  1266. });
  1267. });
  1268. });
  1269. })();
  1270. </script>
  1271. </article>
  1272. </section>
  1273. <section class="phpdocumentor-on-this-page__sidebar">
  1274. <section class="phpdocumentor-on-this-page__content">
  1275. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1276. <ul class="phpdocumentor-list -clean">
  1277. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1278. <li>
  1279. <ul class="phpdocumentor-list -clean">
  1280. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc-properties">Properties</a></li>
  1281. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc-methods">Methods</a></li>
  1282. </ul>
  1283. </li>
  1284. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1285. <li>
  1286. <ul class="phpdocumentor-list -clean">
  1287. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1288. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1289. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1290. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1291. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1292. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1293. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1294. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1295. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1296. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1297. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1298. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1299. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1300. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1301. </ul>
  1302. </li>
  1303. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1304. <li>
  1305. <ul class="phpdocumentor-list -clean">
  1306. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a></li>
  1307. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1308. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a></li>
  1309. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1310. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1311. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1312. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1313. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1314. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1315. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1316. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1317. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1318. </ul>
  1319. </li>
  1320. </ul>
  1321. </section>
  1322. </section>
  1323. </div>
  1324. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1325. <section class="phpdocumentor-search-results__dialog">
  1326. <header class="phpdocumentor-search-results__header">
  1327. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1328. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1329. </header>
  1330. <section class="phpdocumentor-search-results__body">
  1331. <ul class="phpdocumentor-search-results__entries"></ul>
  1332. </section>
  1333. </section>
  1334. </section>
  1335. </div>
  1336. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1337. </main>
  1338. <script>
  1339. cssVars({});
  1340. </script>
  1341. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1342. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1343. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1344. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1345. </body>
  1346. </html>