chillerlan-QRCode-Output-QROutputAbstract.html 85 KB

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