chillerlan-QRCode-Output-QROutputAbstract.html 90 KB

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