chillerlan-QRCode-Output-QROutputAbstract.html 96 KB

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