chillerlan-QRCode-Output-QROutputAbstract.html 89 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940
  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. return;
  1291. }
  1292. if (xhr.status === 404) {
  1293. code.textContent = '✖ Error: File could not be found';
  1294. return;
  1295. }
  1296. if (xhr.status >= 400) {
  1297. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1298. return;
  1299. }
  1300. code.textContent = '✖ Error: An unknown error occurred';
  1301. };
  1302. xhr.send(null);
  1303. });
  1304. }
  1305. const modalButtons = document.querySelectorAll("[data-modal]");
  1306. const openedAsLocalFile = window.location.protocol === 'file:';
  1307. if (modalButtons.length > 0 && openedAsLocalFile) {
  1308. console.warn(
  1309. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1310. 'browsers block XHR requests when a page is opened this way'
  1311. );
  1312. }
  1313. modalButtons.forEach(function (trigger) {
  1314. if (openedAsLocalFile) {
  1315. trigger.setAttribute("hidden", "hidden");
  1316. }
  1317. trigger.addEventListener("click", function (event) {
  1318. event.preventDefault();
  1319. const modal = document.getElementById(trigger.dataset.modal);
  1320. if (!modal) {
  1321. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1322. return;
  1323. }
  1324. modal.classList.add("phpdocumentor-modal__open");
  1325. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1326. const exits = modal.querySelectorAll("[data-exit-button]");
  1327. exits.forEach(function (exit) {
  1328. exit.addEventListener("click", function (event) {
  1329. event.preventDefault();
  1330. modal.classList.remove("phpdocumentor-modal__open");
  1331. });
  1332. });
  1333. });
  1334. });
  1335. })();
  1336. </script>
  1337. </article>
  1338. </section>
  1339. <section class="phpdocumentor-on-this-page__sidebar">
  1340. <section class="phpdocumentor-on-this-page__content">
  1341. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1342. <ul class="phpdocumentor-list -clean">
  1343. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1344. <li>
  1345. <ul class="phpdocumentor-list -clean">
  1346. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc-properties">Properties</a></li>
  1347. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc-methods">Methods</a></li>
  1348. </ul>
  1349. </li>
  1350. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1351. <li>
  1352. <ul class="phpdocumentor-list -clean">
  1353. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter</a></li>
  1354. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius</a></li>
  1355. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths</a></li>
  1356. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules</a></li>
  1357. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules</a></li>
  1358. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol</a></li>
  1359. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect</a></li>
  1360. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare</a></li>
  1361. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a></li>
  1362. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a></li>
  1363. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a></li>
  1364. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a></li>
  1365. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a></li>
  1366. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a></li>
  1367. </ul>
  1368. </li>
  1369. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1370. <li>
  1371. <ul class="phpdocumentor-list -clean">
  1372. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a></li>
  1373. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1374. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a></li>
  1375. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1376. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1377. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1378. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1379. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_guessMimeType">guessMimeType()</a></li>
  1380. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1381. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1382. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1383. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1384. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1385. </ul>
  1386. </li>
  1387. </ul>
  1388. </section>
  1389. </section>
  1390. </div>
  1391. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1392. <section class="phpdocumentor-search-results__dialog">
  1393. <header class="phpdocumentor-search-results__header">
  1394. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1395. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1396. </header>
  1397. <section class="phpdocumentor-search-results__body">
  1398. <ul class="phpdocumentor-search-results__entries"></ul>
  1399. </section>
  1400. </section>
  1401. </section>
  1402. </div>
  1403. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1404. </main>
  1405. <script>
  1406. cssVars({});
  1407. </script>
  1408. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1409. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1410. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1411. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1412. </body>
  1413. </html>