chillerlan-QRCode-Output-QRStringJSON.html 114 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426
  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. QRStringJSON
  116. <span class="phpdocumentor-element__extends">
  117. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  118. </span>
  119. <div class="phpdocumentor-element__package">
  120. in package
  121. <ul class="phpdocumentor-breadcrumbs">
  122. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  123. </ul>
  124. </div>
  125. <span class="phpdocumentor-element__extends">
  126. uses
  127. <a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html"><abbr title="\chillerlan\QRCode\Output\CssColorModuleValueTrait">CssColorModuleValueTrait</abbr></a> </span>
  128. </h2>
  129. <div class="phpdocumentor-label-line">
  130. </div>
  131. <aside class="phpdocumentor-element-found-in">
  132. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRStringJSON.php"><a href="files/src-output-qrstringjson.html"><abbr title="src/Output/QRStringJSON.php">QRStringJSON.php</abbr></a></abbr>
  133. :
  134. <span class="phpdocumentor-element-found-in__line">26</span>
  135. </aside>
  136. <p class="phpdocumentor-summary">JSON Output</p>
  137. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  138. Tags
  139. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  140. </h5>
  141. <dl class="phpdocumentor-tag-list">
  142. <dt class="phpdocumentor-tag-list__entry">
  143. <span class="phpdocumentor-tag__name">phpstan-type</span>
  144. </dt>
  145. <dd class="phpdocumentor-tag-list__definition">
  146. <section class="phpdocumentor-description"><p>Module array{x: int, dark: bool, layer: string, value: string}</p>
  147. </section>
  148. </dd>
  149. </dl>
  150. <h3 id="toc">
  151. Table of Contents
  152. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  153. </h3>
  154. <h4 id="toc-constants">
  155. Constants
  156. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  157. </h4>
  158. <dl class="phpdocumentor-table-of-contents">
  159. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  160. <a class="" href="classes/chillerlan-QRCode-Output-QRStringJSON.html#constant_MIME_TYPE">MIME_TYPE</a>
  161. <span>
  162. &nbsp;= &#039;application/json&#039; </span>
  163. </dt>
  164. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  165. <a class="" href="classes/chillerlan-QRCode-Output-QRStringJSON.html#constant_SCHEMA">SCHEMA</a>
  166. <span>
  167. &nbsp;= &#039;https://raw.githubusercontent.com/chillerlan/php-qrcode/main/src/Output/qrcode.schema.json&#039; </span>
  168. </dt>
  169. </dl>
  170. <h4 id="toc-properties">
  171. Properties
  172. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  173. </h4>
  174. <dl class="phpdocumentor-table-of-contents">
  175. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  176. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter</a>
  177. <span>
  178. &nbsp;: float </span>
  179. </dt>
  180. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  181. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius</a>
  182. <span>
  183. &nbsp;: float </span>
  184. </dt>
  185. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  186. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths</a>
  187. <span>
  188. &nbsp;: bool </span>
  189. </dt>
  190. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  191. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules</a>
  192. <span>
  193. &nbsp;: bool </span>
  194. </dt>
  195. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  196. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules</a>
  197. <span>
  198. &nbsp;: bool </span>
  199. </dt>
  200. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  201. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol</a>
  202. <span>
  203. &nbsp;: string </span>
  204. </dt>
  205. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  206. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect</a>
  207. <span>
  208. &nbsp;: array&lt;string|int, int&gt; </span>
  209. </dt>
  210. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  211. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare</a>
  212. <span>
  213. &nbsp;: array&lt;string|int, int&gt; </span>
  214. </dt>
  215. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  216. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  217. <span>
  218. &nbsp;: int </span>
  219. </dt>
  220. <dd>the side length of the QR image (modules * scale)</dd>
  221. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  222. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  223. <span>
  224. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  225. </dt>
  226. <dd>the (filled) data matrix object</dd>
  227. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  228. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  229. <span>
  230. &nbsp;: int </span>
  231. </dt>
  232. <dd>the current size of the QR matrix</dd>
  233. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  234. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  235. <span>
  236. &nbsp;: array&lt;string|int, mixed&gt; </span>
  237. </dt>
  238. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  239. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  240. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  241. <span>
  242. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  243. </dt>
  244. <dd>the options instance</dd>
  245. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  246. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  247. <span>
  248. &nbsp;: int </span>
  249. </dt>
  250. </dl>
  251. <h4 id="toc-methods">
  252. Methods
  253. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  254. </h4>
  255. <dl class="phpdocumentor-table-of-contents">
  256. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  257. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  258. <span>
  259. &nbsp;: mixed </span>
  260. </dt>
  261. <dd>QROutputAbstract constructor.</dd>
  262. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  263. <a class="" href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_dump">dump()</a>
  264. <span>
  265. &nbsp;: string </span>
  266. </dt>
  267. <dd>Generates the output, optionally dumps it to a file, and returns it</dd>
  268. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  269. <a class="" href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_getModuleValue">getModuleValue()</a>
  270. <span>
  271. &nbsp;: string </span>
  272. </dt>
  273. <dd>Returns the prepared value for the given $M_TYPE</dd>
  274. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  275. <a class="" href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  276. <span>
  277. &nbsp;: bool </span>
  278. </dt>
  279. <dd>note: we&#039;re not necessarily validating the several values, just checking the general syntax
  280. note: css4 colors are not included</dd>
  281. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  282. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  283. <span>
  284. &nbsp;: array&lt;int, mixed&gt; </span>
  285. </dt>
  286. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  287. returns an array with the transformed modules</dd>
  288. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  289. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a>
  290. <span>
  291. &nbsp;: void </span>
  292. </dt>
  293. <dd>Creates copies of several QROptions values to avoid calling the magic getters
  294. in long loops for a significant performance increase.</dd>
  295. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  296. <a class="" href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  297. <span>
  298. &nbsp;: string </span>
  299. </dt>
  300. <dd>implements \chillerlan\QRCode\Output\QROutputAbstract::getDefaultModuleValue()</dd>
  301. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  302. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  303. <span>
  304. &nbsp;: mixed </span>
  305. </dt>
  306. <dd>Returns the prepared value for the given $M_TYPE</dd>
  307. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  308. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  309. <span>
  310. &nbsp;: mixed </span>
  311. </dt>
  312. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  313. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  314. <a class="" href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_getOutputDimensions">getOutputDimensions()</a>
  315. <span>
  316. &nbsp;: array&lt;string|int, int&gt; </span>
  317. </dt>
  318. <dd>Returns a 2 element array with the current output width and height</dd>
  319. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  320. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_guessMimeType">guessMimeType()</a>
  321. <span>
  322. &nbsp;: string </span>
  323. </dt>
  324. <dd>Guesses the mime type from the given $imageData</dd>
  325. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  326. <a class="" href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_module">module()</a>
  327. <span>
  328. &nbsp;: array&lt;string|int, mixed&gt;|null </span>
  329. </dt>
  330. <dd>Creates an array element for a single module</dd>
  331. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  332. <a class="" href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_prepareModuleValue">prepareModuleValue()</a>
  333. <span>
  334. &nbsp;: string </span>
  335. </dt>
  336. <dd>implements \chillerlan\QRCode\Output\QROutputAbstract::prepareModuleValue()</dd>
  337. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  338. <a class="" href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_row">row()</a>
  339. <span>
  340. &nbsp;: array&lt;string|int, mixed&gt;|null </span>
  341. </dt>
  342. <dd>Creates an array element for a matrix row</dd>
  343. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  344. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  345. <span>
  346. &nbsp;: void </span>
  347. </dt>
  348. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  349. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  350. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  351. <span>
  352. &nbsp;: void </span>
  353. </dt>
  354. <dd>Sets/updates the matrix dimensions</dd>
  355. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  356. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  357. <span>
  358. &nbsp;: void </span>
  359. </dt>
  360. <dd>Sets the initial module values</dd>
  361. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  362. <a class="" href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  363. <span>
  364. &nbsp;: string </span>
  365. </dt>
  366. <dd>Returns a base64 data URI for the given string and mime type</dd>
  367. </dl>
  368. <section class="phpdocumentor-constants">
  369. <h3 class="phpdocumentor-elements__header" id="constants">
  370. Constants
  371. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  372. </h3>
  373. <article class="phpdocumentor-element -constant -public ">
  374. <h4 class="phpdocumentor-element__name" id="constant_MIME_TYPE">
  375. MIME_TYPE
  376. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#constant_MIME_TYPE" class="headerlink"><i class="fas fa-link"></i></a>
  377. </h4>
  378. <aside class="phpdocumentor-element-found-in">
  379. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRStringJSON.php"><a href="files/src-output-qrstringjson.html"><abbr title="src/Output/QRStringJSON.php">QRStringJSON.php</abbr></a></abbr>
  380. :
  381. <span class="phpdocumentor-element-found-in__line">29</span>
  382. </aside>
  383. <code class="phpdocumentor-signature phpdocumentor-code ">
  384. <span class="phpdocumentor-signature__visibility">public</span>
  385. <span class="phpdocumentor-signature__final">final</span> <span class="phpdocumentor-signature__type">mixed</span>
  386. <span class="phpdocumentor-signature__name">MIME_TYPE</span>
  387. = <span class="phpdocumentor-signature__default-value">&#039;application/json&#039;</span>
  388. </code>
  389. </article>
  390. <article class="phpdocumentor-element -constant -public ">
  391. <h4 class="phpdocumentor-element__name" id="constant_SCHEMA">
  392. SCHEMA
  393. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#constant_SCHEMA" class="headerlink"><i class="fas fa-link"></i></a>
  394. </h4>
  395. <aside class="phpdocumentor-element-found-in">
  396. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRStringJSON.php"><a href="files/src-output-qrstringjson.html"><abbr title="src/Output/QRStringJSON.php">QRStringJSON.php</abbr></a></abbr>
  397. :
  398. <span class="phpdocumentor-element-found-in__line">30</span>
  399. </aside>
  400. <code class="phpdocumentor-signature phpdocumentor-code ">
  401. <span class="phpdocumentor-signature__visibility">public</span>
  402. <span class="phpdocumentor-signature__final">final</span> <span class="phpdocumentor-signature__type">mixed</span>
  403. <span class="phpdocumentor-signature__name">SCHEMA</span>
  404. = <span class="phpdocumentor-signature__default-value">&#039;https://raw.githubusercontent.com/chillerlan/php-qrcode/main/src/Output/qrcode.schema.json&#039;</span>
  405. </code>
  406. </article>
  407. </section>
  408. <section class="phpdocumentor-properties">
  409. <h3 class="phpdocumentor-elements__header" id="properties">
  410. Properties
  411. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  412. </h3>
  413. <article
  414. class="
  415. phpdocumentor-element
  416. -property
  417. -protected
  418. "
  419. >
  420. <h4 class="phpdocumentor-element__name" id="property_circleDiameter">
  421. $circleDiameter
  422. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter" class="headerlink"><i class="fas fa-link"></i></a>
  423. <span class="phpdocumentor-element__modifiers">
  424. </span>
  425. </h4>
  426. <aside class="phpdocumentor-element-found-in">
  427. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  428. :
  429. <span class="phpdocumentor-element-found-in__line">79</span>
  430. </aside>
  431. <code class="phpdocumentor-code phpdocumentor-signature ">
  432. <span class="phpdocumentor-signature__visibility">protected</span>
  433. <span class="phpdocumentor-signature__type">float</span>
  434. <span class="phpdocumentor-signature__name">$circleDiameter</span>
  435. </code>
  436. </article>
  437. <article
  438. class="
  439. phpdocumentor-element
  440. -property
  441. -protected
  442. "
  443. >
  444. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  445. $circleRadius
  446. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  447. <span class="phpdocumentor-element__modifiers">
  448. </span>
  449. </h4>
  450. <aside class="phpdocumentor-element-found-in">
  451. <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>
  452. :
  453. <span class="phpdocumentor-element-found-in__line">78</span>
  454. </aside>
  455. <code class="phpdocumentor-code phpdocumentor-signature ">
  456. <span class="phpdocumentor-signature__visibility">protected</span>
  457. <span class="phpdocumentor-signature__type">float</span>
  458. <span class="phpdocumentor-signature__name">$circleRadius</span>
  459. </code>
  460. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  461. Tags
  462. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius#tags" class="headerlink"><i class="fas fa-link"></i></a>
  463. </h5>
  464. <dl class="phpdocumentor-tag-list">
  465. <dt class="phpdocumentor-tag-list__entry">
  466. <span class="phpdocumentor-tag__name">see</span>
  467. </dt>
  468. <dd class="phpdocumentor-tag-list__definition">
  469. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$circleRadius">QROptions::$circleRadius</abbr></span>
  470. </dd>
  471. </dl>
  472. </article>
  473. <article
  474. class="
  475. phpdocumentor-element
  476. -property
  477. -protected
  478. "
  479. >
  480. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  481. $connectPaths
  482. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  483. <span class="phpdocumentor-element__modifiers">
  484. </span>
  485. </h4>
  486. <aside class="phpdocumentor-element-found-in">
  487. <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>
  488. :
  489. <span class="phpdocumentor-element-found-in__line">70</span>
  490. </aside>
  491. <code class="phpdocumentor-code phpdocumentor-signature ">
  492. <span class="phpdocumentor-signature__visibility">protected</span>
  493. <span class="phpdocumentor-signature__type">bool</span>
  494. <span class="phpdocumentor-signature__name">$connectPaths</span>
  495. </code>
  496. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  497. Tags
  498. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  499. </h5>
  500. <dl class="phpdocumentor-tag-list">
  501. <dt class="phpdocumentor-tag-list__entry">
  502. <span class="phpdocumentor-tag__name">see</span>
  503. </dt>
  504. <dd class="phpdocumentor-tag-list__definition">
  505. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$connectPaths">QROptions::$connectPaths</abbr></span>
  506. </dd>
  507. </dl>
  508. </article>
  509. <article
  510. class="
  511. phpdocumentor-element
  512. -property
  513. -protected
  514. "
  515. >
  516. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  517. $drawCircularModules
  518. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  519. <span class="phpdocumentor-element__modifiers">
  520. </span>
  521. </h4>
  522. <aside class="phpdocumentor-element-found-in">
  523. <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>
  524. :
  525. <span class="phpdocumentor-element-found-in__line">76</span>
  526. </aside>
  527. <code class="phpdocumentor-code phpdocumentor-signature ">
  528. <span class="phpdocumentor-signature__visibility">protected</span>
  529. <span class="phpdocumentor-signature__type">bool</span>
  530. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  531. </code>
  532. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  533. Tags
  534. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  535. </h5>
  536. <dl class="phpdocumentor-tag-list">
  537. <dt class="phpdocumentor-tag-list__entry">
  538. <span class="phpdocumentor-tag__name">see</span>
  539. </dt>
  540. <dd class="phpdocumentor-tag-list__definition">
  541. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawCircularModules">QROptions::$drawCircularModules</abbr></span>
  542. </dd>
  543. </dl>
  544. </article>
  545. <article
  546. class="
  547. phpdocumentor-element
  548. -property
  549. -protected
  550. "
  551. >
  552. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  553. $drawLightModules
  554. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  555. <span class="phpdocumentor-element__modifiers">
  556. </span>
  557. </h4>
  558. <aside class="phpdocumentor-element-found-in">
  559. <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>
  560. :
  561. <span class="phpdocumentor-element-found-in__line">74</span>
  562. </aside>
  563. <code class="phpdocumentor-code phpdocumentor-signature ">
  564. <span class="phpdocumentor-signature__visibility">protected</span>
  565. <span class="phpdocumentor-signature__type">bool</span>
  566. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  567. </code>
  568. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  569. Tags
  570. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  571. </h5>
  572. <dl class="phpdocumentor-tag-list">
  573. <dt class="phpdocumentor-tag-list__entry">
  574. <span class="phpdocumentor-tag__name">see</span>
  575. </dt>
  576. <dd class="phpdocumentor-tag-list__definition">
  577. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawLightModules">QROptions::$drawLightModules</abbr></span>
  578. </dd>
  579. </dl>
  580. </article>
  581. <article
  582. class="
  583. phpdocumentor-element
  584. -property
  585. -protected
  586. "
  587. >
  588. <h4 class="phpdocumentor-element__name" id="property_eol">
  589. $eol
  590. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  591. <span class="phpdocumentor-element__modifiers">
  592. </span>
  593. </h4>
  594. <aside class="phpdocumentor-element-found-in">
  595. <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>
  596. :
  597. <span class="phpdocumentor-element-found-in__line">72</span>
  598. </aside>
  599. <code class="phpdocumentor-code phpdocumentor-signature ">
  600. <span class="phpdocumentor-signature__visibility">protected</span>
  601. <span class="phpdocumentor-signature__type">string</span>
  602. <span class="phpdocumentor-signature__name">$eol</span>
  603. </code>
  604. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  605. Tags
  606. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol#tags" class="headerlink"><i class="fas fa-link"></i></a>
  607. </h5>
  608. <dl class="phpdocumentor-tag-list">
  609. <dt class="phpdocumentor-tag-list__entry">
  610. <span class="phpdocumentor-tag__name">see</span>
  611. </dt>
  612. <dd class="phpdocumentor-tag-list__definition">
  613. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$eol">QROptions::$eol</abbr></span>
  614. </dd>
  615. </dl>
  616. </article>
  617. <article
  618. class="
  619. phpdocumentor-element
  620. -property
  621. -protected
  622. "
  623. >
  624. <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
  625. $excludeFromConnect
  626. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  627. <span class="phpdocumentor-element__modifiers">
  628. </span>
  629. </h4>
  630. <aside class="phpdocumentor-element-found-in">
  631. <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>
  632. :
  633. <span class="phpdocumentor-element-found-in__line">61</span>
  634. </aside>
  635. <code class="phpdocumentor-code phpdocumentor-signature ">
  636. <span class="phpdocumentor-signature__visibility">protected</span>
  637. <span class="phpdocumentor-signature__type">array&lt;string|int, int&gt;</span>
  638. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  639. </code>
  640. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  641. Tags
  642. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect#tags" class="headerlink"><i class="fas fa-link"></i></a>
  643. </h5>
  644. <dl class="phpdocumentor-tag-list">
  645. <dt class="phpdocumentor-tag-list__entry">
  646. <span class="phpdocumentor-tag__name">see</span>
  647. </dt>
  648. <dd class="phpdocumentor-tag-list__definition">
  649. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$excludeFromConnect">QROptions::$excludeFromConnect</abbr></span>
  650. </dd>
  651. </dl>
  652. </article>
  653. <article
  654. class="
  655. phpdocumentor-element
  656. -property
  657. -protected
  658. "
  659. >
  660. <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
  661. $keepAsSquare
  662. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  663. <span class="phpdocumentor-element__modifiers">
  664. </span>
  665. </h4>
  666. <aside class="phpdocumentor-element-found-in">
  667. <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>
  668. :
  669. <span class="phpdocumentor-element-found-in__line">66</span>
  670. </aside>
  671. <code class="phpdocumentor-code phpdocumentor-signature ">
  672. <span class="phpdocumentor-signature__visibility">protected</span>
  673. <span class="phpdocumentor-signature__type">array&lt;string|int, int&gt;</span>
  674. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  675. </code>
  676. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  677. Tags
  678. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare#tags" class="headerlink"><i class="fas fa-link"></i></a>
  679. </h5>
  680. <dl class="phpdocumentor-tag-list">
  681. <dt class="phpdocumentor-tag-list__entry">
  682. <span class="phpdocumentor-tag__name">see</span>
  683. </dt>
  684. <dd class="phpdocumentor-tag-list__definition">
  685. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$keepAsSquare">QROptions::$keepAsSquare</abbr></span>
  686. </dd>
  687. </dl>
  688. </article>
  689. <article
  690. class="
  691. phpdocumentor-element
  692. -property
  693. -protected
  694. "
  695. >
  696. <h4 class="phpdocumentor-element__name" id="property_length">
  697. $length
  698. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  699. <span class="phpdocumentor-element__modifiers">
  700. </span>
  701. </h4>
  702. <aside class="phpdocumentor-element-found-in">
  703. <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>
  704. :
  705. <span class="phpdocumentor-element-found-in__line">38</span>
  706. </aside>
  707. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  708. <code class="phpdocumentor-code phpdocumentor-signature ">
  709. <span class="phpdocumentor-signature__visibility">protected</span>
  710. <span class="phpdocumentor-signature__type">int</span>
  711. <span class="phpdocumentor-signature__name">$length</span>
  712. </code>
  713. </article>
  714. <article
  715. class="
  716. phpdocumentor-element
  717. -property
  718. -protected
  719. "
  720. >
  721. <h4 class="phpdocumentor-element__name" id="property_matrix">
  722. $matrix
  723. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  724. <span class="phpdocumentor-element__modifiers">
  725. </span>
  726. </h4>
  727. <aside class="phpdocumentor-element-found-in">
  728. <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>
  729. :
  730. <span class="phpdocumentor-element-found-in__line">50</span>
  731. </aside>
  732. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  733. <code class="phpdocumentor-code phpdocumentor-signature ">
  734. <span class="phpdocumentor-signature__visibility">protected</span>
  735. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  736. <span class="phpdocumentor-signature__name">$matrix</span>
  737. </code>
  738. </article>
  739. <article
  740. class="
  741. phpdocumentor-element
  742. -property
  743. -protected
  744. "
  745. >
  746. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  747. $moduleCount
  748. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  749. <span class="phpdocumentor-element__modifiers">
  750. </span>
  751. </h4>
  752. <aside class="phpdocumentor-element-found-in">
  753. <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>
  754. :
  755. <span class="phpdocumentor-element-found-in__line">33</span>
  756. </aside>
  757. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  758. <code class="phpdocumentor-code phpdocumentor-signature ">
  759. <span class="phpdocumentor-signature__visibility">protected</span>
  760. <span class="phpdocumentor-signature__type">int</span>
  761. <span class="phpdocumentor-signature__name">$moduleCount</span>
  762. </code>
  763. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  764. Tags
  765. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  766. </h5>
  767. <dl class="phpdocumentor-tag-list">
  768. <dt class="phpdocumentor-tag-list__entry">
  769. <span class="phpdocumentor-tag__name">see</span>
  770. </dt>
  771. <dd class="phpdocumentor-tag-list__definition">
  772. <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>
  773. </dd>
  774. </dl>
  775. </article>
  776. <article
  777. class="
  778. phpdocumentor-element
  779. -property
  780. -protected
  781. "
  782. >
  783. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  784. $moduleValues
  785. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  786. <span class="phpdocumentor-element__modifiers">
  787. </span>
  788. </h4>
  789. <aside class="phpdocumentor-element-found-in">
  790. <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>
  791. :
  792. <span class="phpdocumentor-element-found-in__line">45</span>
  793. </aside>
  794. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  795. <code class="phpdocumentor-code phpdocumentor-signature ">
  796. <span class="phpdocumentor-signature__visibility">protected</span>
  797. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  798. <span class="phpdocumentor-signature__name">$moduleValues</span>
  799. </code>
  800. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  801. Tags
  802. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues#tags" class="headerlink"><i class="fas fa-link"></i></a>
  803. </h5>
  804. <dl class="phpdocumentor-tag-list">
  805. <dt class="phpdocumentor-tag-list__entry">
  806. <span class="phpdocumentor-tag__name">phpstan-var</span>
  807. </dt>
  808. <dd class="phpdocumentor-tag-list__definition">
  809. <section class="phpdocumentor-description"><p>array&lt;int, mixed&gt;</p>
  810. </section>
  811. </dd>
  812. </dl>
  813. </article>
  814. <article
  815. class="
  816. phpdocumentor-element
  817. -property
  818. -protected
  819. "
  820. >
  821. <h4 class="phpdocumentor-element__name" id="property_options">
  822. $options
  823. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  824. <span class="phpdocumentor-element__modifiers">
  825. </span>
  826. </h4>
  827. <aside class="phpdocumentor-element-found-in">
  828. <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>
  829. :
  830. <span class="phpdocumentor-element-found-in__line">55</span>
  831. </aside>
  832. <p class="phpdocumentor-summary">the options instance</p>
  833. <code class="phpdocumentor-code phpdocumentor-signature ">
  834. <span class="phpdocumentor-signature__visibility">protected</span>
  835. <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>
  836. <span class="phpdocumentor-signature__name">$options</span>
  837. </code>
  838. </article>
  839. <article
  840. class="
  841. phpdocumentor-element
  842. -property
  843. -protected
  844. "
  845. >
  846. <h4 class="phpdocumentor-element__name" id="property_scale">
  847. $scale
  848. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  849. <span class="phpdocumentor-element__modifiers">
  850. </span>
  851. </h4>
  852. <aside class="phpdocumentor-element-found-in">
  853. <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>
  854. :
  855. <span class="phpdocumentor-element-found-in__line">68</span>
  856. </aside>
  857. <code class="phpdocumentor-code phpdocumentor-signature ">
  858. <span class="phpdocumentor-signature__visibility">protected</span>
  859. <span class="phpdocumentor-signature__type">int</span>
  860. <span class="phpdocumentor-signature__name">$scale</span>
  861. </code>
  862. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  863. Tags
  864. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  865. </h5>
  866. <dl class="phpdocumentor-tag-list">
  867. <dt class="phpdocumentor-tag-list__entry">
  868. <span class="phpdocumentor-tag__name">see</span>
  869. </dt>
  870. <dd class="phpdocumentor-tag-list__definition">
  871. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  872. </dd>
  873. </dl>
  874. </article>
  875. </section>
  876. <section class="phpdocumentor-methods">
  877. <h3 class="phpdocumentor-elements__header" id="methods">
  878. Methods
  879. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  880. </h3>
  881. <article
  882. class="phpdocumentor-element
  883. -method
  884. -public
  885. "
  886. >
  887. <h4 class="phpdocumentor-element__name" id="method___construct">
  888. __construct()
  889. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  890. </h4>
  891. <aside class="phpdocumentor-element-found-in">
  892. <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>
  893. :
  894. <span class="phpdocumentor-element-found-in__line">84</span>
  895. </aside>
  896. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  897. <code class="phpdocumentor-code phpdocumentor-signature ">
  898. <span class="phpdocumentor-signature__visibility">public</span>
  899. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  900. <div class="phpdocumentor-label-line">
  901. </div>
  902. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  903. <dl class="phpdocumentor-argument-list">
  904. <dt class="phpdocumentor-argument-list__entry">
  905. <span class="phpdocumentor-signature__argument__name">$options</span>
  906. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  907. </dt>
  908. <dd class="phpdocumentor-argument-list__definition">
  909. </dd>
  910. <dt class="phpdocumentor-argument-list__entry">
  911. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  912. : <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>
  913. </dt>
  914. <dd class="phpdocumentor-argument-list__definition">
  915. </dd>
  916. </dl>
  917. </article>
  918. <article
  919. class="phpdocumentor-element
  920. -method
  921. -public
  922. "
  923. >
  924. <h4 class="phpdocumentor-element__name" id="method_dump">
  925. dump()
  926. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  927. </h4>
  928. <aside class="phpdocumentor-element-found-in">
  929. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRStringJSON.php"><a href="files/src-output-qrstringjson.html"><abbr title="src/Output/QRStringJSON.php">QRStringJSON.php</abbr></a></abbr>
  930. :
  931. <span class="phpdocumentor-element-found-in__line">45</span>
  932. </aside>
  933. <p class="phpdocumentor-summary">Generates the output, optionally dumps it to a file, and returns it</p>
  934. <code class="phpdocumentor-code phpdocumentor-signature ">
  935. <span class="phpdocumentor-signature__visibility">public</span>
  936. <span class="phpdocumentor-signature__name">dump</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  937. <div class="phpdocumentor-label-line">
  938. </div>
  939. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  940. <dl class="phpdocumentor-argument-list">
  941. <dt class="phpdocumentor-argument-list__entry">
  942. <span class="phpdocumentor-signature__argument__name">$file</span>
  943. : <span class="phpdocumentor-signature__argument__return-type">string|null</span>
  944. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  945. <dd class="phpdocumentor-argument-list__definition">
  946. </dd>
  947. </dl>
  948. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  949. Tags
  950. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  951. </h5>
  952. <dl class="phpdocumentor-tag-list">
  953. <dt class="phpdocumentor-tag-list__entry">
  954. <span class="phpdocumentor-tag__name">inheritDoc</span>
  955. </dt>
  956. <dd class="phpdocumentor-tag-list__definition">
  957. </dd>
  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"><abbr title="\JsonException">JsonException</abbr></span>
  963. </dd>
  964. </dl>
  965. <section>
  966. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  967. <span class="phpdocumentor-signature__response_type">string</span>
  968. </section>
  969. </article>
  970. <article
  971. class="phpdocumentor-element
  972. -method
  973. -public
  974. "
  975. >
  976. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  977. getModuleValue()
  978. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  979. </h4>
  980. <aside class="phpdocumentor-element-found-in">
  981. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRStringJSON.php"><a href="files/src-output-qrstringjson.html"><abbr title="src/Output/QRStringJSON.php">QRStringJSON.php</abbr></a></abbr>
  982. :
  983. <span class="phpdocumentor-element-found-in__line">0</span>
  984. </aside>
  985. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  986. <code class="phpdocumentor-code phpdocumentor-signature ">
  987. <span class="phpdocumentor-signature__visibility">public</span>
  988. <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">string</span></code>
  989. <div class="phpdocumentor-label-line">
  990. </div>
  991. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  992. <dl class="phpdocumentor-argument-list">
  993. <dt class="phpdocumentor-argument-list__entry">
  994. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  995. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  996. </dt>
  997. <dd class="phpdocumentor-argument-list__definition">
  998. </dd>
  999. </dl>
  1000. <section>
  1001. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1002. <span class="phpdocumentor-signature__response_type">string</span>
  1003. </section>
  1004. </article>
  1005. <article
  1006. class="phpdocumentor-element
  1007. -method
  1008. -public
  1009. -static "
  1010. >
  1011. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  1012. moduleValueIsValid()
  1013. <a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_moduleValueIsValid" 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/CssColorModuleValueTrait.php"><a href="files/src-output-csscolormodulevaluetrait.html"><abbr title="src/Output/CssColorModuleValueTrait.php">CssColorModuleValueTrait.php</abbr></a></abbr>
  1017. :
  1018. <span class="phpdocumentor-element-found-in__line">33</span>
  1019. </aside>
  1020. <p class="phpdocumentor-summary">note: we&#039;re not necessarily validating the several values, just checking the general syntax
  1021. note: css4 colors are not included</p>
  1022. <code class="phpdocumentor-code phpdocumentor-signature ">
  1023. <span class="phpdocumentor-signature__visibility">public</span>
  1024. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">moduleValueIsValid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1025. <div class="phpdocumentor-label-line">
  1026. </div>
  1027. <section class="phpdocumentor-description"><p>implements \chillerlan\QRCode\Output\QROutputInterface::moduleValueIsValid()</p>
  1028. </section>
  1029. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1030. <dl class="phpdocumentor-argument-list">
  1031. <dt class="phpdocumentor-argument-list__entry">
  1032. <span class="phpdocumentor-signature__argument__name">$value</span>
  1033. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1034. </dt>
  1035. <dd class="phpdocumentor-argument-list__definition">
  1036. </dd>
  1037. </dl>
  1038. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1039. Tags
  1040. <a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_moduleValueIsValid#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1041. </h5>
  1042. <dl class="phpdocumentor-tag-list">
  1043. <dt class="phpdocumentor-tag-list__entry">
  1044. <span class="phpdocumentor-tag__name">todo:</span>
  1045. </dt>
  1046. <dd class="phpdocumentor-tag-list__definition">
  1047. <section class="phpdocumentor-description"><p>XSS proof</p>
  1048. </section>
  1049. </dd>
  1050. <dt class="phpdocumentor-tag-list__entry">
  1051. <span class="phpdocumentor-tag__name">see</span>
  1052. </dt>
  1053. <dd class="phpdocumentor-tag-list__definition">
  1054. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value">https://developer.mozilla.org/en-US/docs/Web/CSS/color_value</a></span>
  1055. </dd>
  1056. </dl>
  1057. <section>
  1058. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1059. <span class="phpdocumentor-signature__response_type">bool</span>
  1060. </section>
  1061. </article>
  1062. <article
  1063. class="phpdocumentor-element
  1064. -method
  1065. -protected
  1066. "
  1067. >
  1068. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  1069. collectModules()
  1070. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  1071. </h4>
  1072. <aside class="phpdocumentor-element-found-in">
  1073. <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>
  1074. :
  1075. <span class="phpdocumentor-element-found-in__line">267</span>
  1076. </aside>
  1077. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  1078. returns an array with the transformed modules</p>
  1079. <code class="phpdocumentor-code phpdocumentor-signature ">
  1080. <span class="phpdocumentor-signature__visibility">protected</span>
  1081. <span class="phpdocumentor-signature__name">collectModules</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$transform</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;int, mixed&gt;</span></code>
  1082. <div class="phpdocumentor-label-line">
  1083. </div>
  1084. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  1085. <p>$x - current column
  1086. $y - current row
  1087. $M_TYPE - field value
  1088. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  1089. </section>
  1090. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1091. <dl class="phpdocumentor-argument-list">
  1092. <dt class="phpdocumentor-argument-list__entry">
  1093. <span class="phpdocumentor-signature__argument__name">$transform</span>
  1094. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  1095. </dt>
  1096. <dd class="phpdocumentor-argument-list__definition">
  1097. </dd>
  1098. </dl>
  1099. <section>
  1100. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1101. <span class="phpdocumentor-signature__response_type">array&lt;int, mixed&gt;</span>
  1102. </section>
  1103. </article>
  1104. <article
  1105. class="phpdocumentor-element
  1106. -method
  1107. -protected
  1108. "
  1109. >
  1110. <h4 class="phpdocumentor-element__name" id="method_copyVars">
  1111. copyVars()
  1112. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars" class="headerlink"><i class="fas fa-link"></i></a>
  1113. </h4>
  1114. <aside class="phpdocumentor-element-found-in">
  1115. <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>
  1116. :
  1117. <span class="phpdocumentor-element-found-in__line">103</span>
  1118. </aside>
  1119. <p class="phpdocumentor-summary">Creates copies of several QROptions values to avoid calling the magic getters
  1120. in long loops for a significant performance increase.</p>
  1121. <code class="phpdocumentor-code phpdocumentor-signature ">
  1122. <span class="phpdocumentor-signature__visibility">protected</span>
  1123. <span class="phpdocumentor-signature__name">copyVars</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1124. <div class="phpdocumentor-label-line">
  1125. </div>
  1126. <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>
  1127. </section>
  1128. </article>
  1129. <article
  1130. class="phpdocumentor-element
  1131. -method
  1132. -protected
  1133. "
  1134. >
  1135. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  1136. getDefaultModuleValue()
  1137. <a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1138. </h4>
  1139. <aside class="phpdocumentor-element-found-in">
  1140. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/CssColorModuleValueTrait.php"><a href="files/src-output-csscolormodulevaluetrait.html"><abbr title="src/Output/CssColorModuleValueTrait.php">CssColorModuleValueTrait.php</abbr></a></abbr>
  1141. :
  1142. <span class="phpdocumentor-element-found-in__line">73</span>
  1143. </aside>
  1144. <p class="phpdocumentor-summary">implements \chillerlan\QRCode\Output\QROutputAbstract::getDefaultModuleValue()</p>
  1145. <code class="phpdocumentor-code phpdocumentor-signature ">
  1146. <span class="phpdocumentor-signature__visibility">protected</span>
  1147. <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">string</span></code>
  1148. <div class="phpdocumentor-label-line">
  1149. </div>
  1150. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1151. <dl class="phpdocumentor-argument-list">
  1152. <dt class="phpdocumentor-argument-list__entry">
  1153. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  1154. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1155. </dt>
  1156. <dd class="phpdocumentor-argument-list__definition">
  1157. </dd>
  1158. </dl>
  1159. <section>
  1160. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1161. <span class="phpdocumentor-signature__response_type">string</span>
  1162. </section>
  1163. </article>
  1164. <article
  1165. class="phpdocumentor-element
  1166. -method
  1167. -protected
  1168. "
  1169. >
  1170. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  1171. getModuleValue()
  1172. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1173. </h4>
  1174. <aside class="phpdocumentor-element-found-in">
  1175. <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>
  1176. :
  1177. <span class="phpdocumentor-element-found-in__line">179</span>
  1178. </aside>
  1179. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  1180. <code class="phpdocumentor-code phpdocumentor-signature ">
  1181. <span class="phpdocumentor-signature__visibility">protected</span>
  1182. <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>
  1183. <div class="phpdocumentor-label-line">
  1184. </div>
  1185. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1186. <dl class="phpdocumentor-argument-list">
  1187. <dt class="phpdocumentor-argument-list__entry">
  1188. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1189. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1190. </dt>
  1191. <dd class="phpdocumentor-argument-list__definition">
  1192. </dd>
  1193. </dl>
  1194. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1195. Tags
  1196. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1197. </h5>
  1198. <dl class="phpdocumentor-tag-list">
  1199. <dt class="phpdocumentor-tag-list__entry">
  1200. <span class="phpdocumentor-tag__name">throws</span>
  1201. </dt>
  1202. <dd class="phpdocumentor-tag-list__definition">
  1203. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1204. <section class="phpdocumentor-description"><p>if $moduleValues[$M_TYPE] doesn't exist</p>
  1205. </section>
  1206. </dd>
  1207. </dl>
  1208. </article>
  1209. <article
  1210. class="phpdocumentor-element
  1211. -method
  1212. -protected
  1213. "
  1214. >
  1215. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  1216. getModuleValueAt()
  1217. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  1218. </h4>
  1219. <aside class="phpdocumentor-element-found-in">
  1220. <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>
  1221. :
  1222. <span class="phpdocumentor-element-found-in__line">191</span>
  1223. </aside>
  1224. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  1225. <code class="phpdocumentor-code phpdocumentor-signature ">
  1226. <span class="phpdocumentor-signature__visibility">protected</span>
  1227. <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>
  1228. <div class="phpdocumentor-label-line">
  1229. </div>
  1230. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1231. <dl class="phpdocumentor-argument-list">
  1232. <dt class="phpdocumentor-argument-list__entry">
  1233. <span class="phpdocumentor-signature__argument__name">$x</span>
  1234. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1235. </dt>
  1236. <dd class="phpdocumentor-argument-list__definition">
  1237. </dd>
  1238. <dt class="phpdocumentor-argument-list__entry">
  1239. <span class="phpdocumentor-signature__argument__name">$y</span>
  1240. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1241. </dt>
  1242. <dd class="phpdocumentor-argument-list__definition">
  1243. </dd>
  1244. </dl>
  1245. </article>
  1246. <article
  1247. class="phpdocumentor-element
  1248. -method
  1249. -protected
  1250. "
  1251. >
  1252. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  1253. getOutputDimensions()
  1254. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1255. </h4>
  1256. <aside class="phpdocumentor-element-found-in">
  1257. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRStringJSON.php"><a href="files/src-output-qrstringjson.html"><abbr title="src/Output/QRStringJSON.php">QRStringJSON.php</abbr></a></abbr>
  1258. :
  1259. <span class="phpdocumentor-element-found-in__line">37</span>
  1260. </aside>
  1261. <p class="phpdocumentor-summary">Returns a 2 element array with the current output width and height</p>
  1262. <code class="phpdocumentor-code phpdocumentor-signature ">
  1263. <span class="phpdocumentor-signature__visibility">protected</span>
  1264. <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>
  1265. <div class="phpdocumentor-label-line">
  1266. </div>
  1267. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1268. Tags
  1269. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_getOutputDimensions#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1270. </h5>
  1271. <dl class="phpdocumentor-tag-list">
  1272. <dt class="phpdocumentor-tag-list__entry">
  1273. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1274. </dt>
  1275. <dd class="phpdocumentor-tag-list__definition">
  1276. </dd>
  1277. </dl>
  1278. <section>
  1279. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1280. <span class="phpdocumentor-signature__response_type">array&lt;string|int, int&gt;</span>
  1281. </section>
  1282. </article>
  1283. <article
  1284. class="phpdocumentor-element
  1285. -method
  1286. -protected
  1287. "
  1288. >
  1289. <h4 class="phpdocumentor-element__name" id="method_guessMimeType">
  1290. guessMimeType()
  1291. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_guessMimeType" class="headerlink"><i class="fas fa-link"></i></a>
  1292. </h4>
  1293. <aside class="phpdocumentor-element-found-in">
  1294. <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>
  1295. :
  1296. <span class="phpdocumentor-element-found-in__line">216</span>
  1297. </aside>
  1298. <p class="phpdocumentor-summary">Guesses the mime type from the given $imageData</p>
  1299. <code class="phpdocumentor-code phpdocumentor-signature ">
  1300. <span class="phpdocumentor-signature__visibility">protected</span>
  1301. <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>
  1302. <div class="phpdocumentor-label-line">
  1303. </div>
  1304. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1305. <dl class="phpdocumentor-argument-list">
  1306. <dt class="phpdocumentor-argument-list__entry">
  1307. <span class="phpdocumentor-signature__argument__name">$imageData</span>
  1308. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1309. </dt>
  1310. <dd class="phpdocumentor-argument-list__definition">
  1311. </dd>
  1312. </dl>
  1313. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1314. Tags
  1315. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_guessMimeType#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1316. </h5>
  1317. <dl class="phpdocumentor-tag-list">
  1318. <dt class="phpdocumentor-tag-list__entry">
  1319. <span class="phpdocumentor-tag__name">throws</span>
  1320. </dt>
  1321. <dd class="phpdocumentor-tag-list__definition">
  1322. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  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. <article
  1331. class="phpdocumentor-element
  1332. -method
  1333. -protected
  1334. "
  1335. >
  1336. <h4 class="phpdocumentor-element__name" id="method_module">
  1337. module()
  1338. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  1339. </h4>
  1340. <aside class="phpdocumentor-element-found-in">
  1341. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRStringJSON.php"><a href="files/src-output-qrstringjson.html"><abbr title="src/Output/QRStringJSON.php">QRStringJSON.php</abbr></a></abbr>
  1342. :
  1343. <span class="phpdocumentor-element-found-in__line">115</span>
  1344. </aside>
  1345. <p class="phpdocumentor-summary">Creates an array element for a single module</p>
  1346. <code class="phpdocumentor-code phpdocumentor-signature ">
  1347. <span class="phpdocumentor-signature__visibility">protected</span>
  1348. <span class="phpdocumentor-signature__name">module</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>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
  1349. <div class="phpdocumentor-label-line">
  1350. </div>
  1351. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1352. <dl class="phpdocumentor-argument-list">
  1353. <dt class="phpdocumentor-argument-list__entry">
  1354. <span class="phpdocumentor-signature__argument__name">$x</span>
  1355. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1356. </dt>
  1357. <dd class="phpdocumentor-argument-list__definition">
  1358. </dd>
  1359. <dt class="phpdocumentor-argument-list__entry">
  1360. <span class="phpdocumentor-signature__argument__name">$y</span>
  1361. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1362. </dt>
  1363. <dd class="phpdocumentor-argument-list__definition">
  1364. </dd>
  1365. <dt class="phpdocumentor-argument-list__entry">
  1366. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1367. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1368. </dt>
  1369. <dd class="phpdocumentor-argument-list__definition">
  1370. </dd>
  1371. </dl>
  1372. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1373. Tags
  1374. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_module#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1375. </h5>
  1376. <dl class="phpdocumentor-tag-list">
  1377. <dt class="phpdocumentor-tag-list__entry">
  1378. <span class="phpdocumentor-tag__name">phpstan-return</span>
  1379. </dt>
  1380. <dd class="phpdocumentor-tag-list__definition">
  1381. <section class="phpdocumentor-description"><p>Module</p>
  1382. </section>
  1383. </dd>
  1384. </dl>
  1385. <section>
  1386. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1387. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
  1388. </section>
  1389. </article>
  1390. <article
  1391. class="phpdocumentor-element
  1392. -method
  1393. -protected
  1394. "
  1395. >
  1396. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  1397. prepareModuleValue()
  1398. <a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1399. </h4>
  1400. <aside class="phpdocumentor-element-found-in">
  1401. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/CssColorModuleValueTrait.php"><a href="files/src-output-csscolormodulevaluetrait.html"><abbr title="src/Output/CssColorModuleValueTrait.php">CssColorModuleValueTrait.php</abbr></a></abbr>
  1402. :
  1403. <span class="phpdocumentor-element-found-in__line">66</span>
  1404. </aside>
  1405. <p class="phpdocumentor-summary">implements \chillerlan\QRCode\Output\QROutputAbstract::prepareModuleValue()</p>
  1406. <code class="phpdocumentor-code phpdocumentor-signature ">
  1407. <span class="phpdocumentor-signature__visibility">protected</span>
  1408. <span class="phpdocumentor-signature__name">prepareModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1409. <div class="phpdocumentor-label-line">
  1410. </div>
  1411. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1412. <dl class="phpdocumentor-argument-list">
  1413. <dt class="phpdocumentor-argument-list__entry">
  1414. <span class="phpdocumentor-signature__argument__name">$value</span>
  1415. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1416. </dt>
  1417. <dd class="phpdocumentor-argument-list__definition">
  1418. </dd>
  1419. </dl>
  1420. <section>
  1421. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1422. <span class="phpdocumentor-signature__response_type">string</span>
  1423. </section>
  1424. </article>
  1425. <article
  1426. class="phpdocumentor-element
  1427. -method
  1428. -protected
  1429. "
  1430. >
  1431. <h4 class="phpdocumentor-element__name" id="method_row">
  1432. row()
  1433. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_row" class="headerlink"><i class="fas fa-link"></i></a>
  1434. </h4>
  1435. <aside class="phpdocumentor-element-found-in">
  1436. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRStringJSON.php"><a href="files/src-output-qrstringjson.html"><abbr title="src/Output/QRStringJSON.php">QRStringJSON.php</abbr></a></abbr>
  1437. :
  1438. <span class="phpdocumentor-element-found-in__line">91</span>
  1439. </aside>
  1440. <p class="phpdocumentor-summary">Creates an array element for a matrix row</p>
  1441. <code class="phpdocumentor-code phpdocumentor-signature ">
  1442. <span class="phpdocumentor-signature__visibility">protected</span>
  1443. <span class="phpdocumentor-signature__name">row</span><span>(</span><span class="phpdocumentor-signature__argument"><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">array&lt;string|int, int&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$row</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
  1444. <div class="phpdocumentor-label-line">
  1445. </div>
  1446. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1447. <dl class="phpdocumentor-argument-list">
  1448. <dt class="phpdocumentor-argument-list__entry">
  1449. <span class="phpdocumentor-signature__argument__name">$y</span>
  1450. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1451. </dt>
  1452. <dd class="phpdocumentor-argument-list__definition">
  1453. </dd>
  1454. <dt class="phpdocumentor-argument-list__entry">
  1455. <span class="phpdocumentor-signature__argument__name">$row</span>
  1456. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, int&gt;</span>
  1457. </dt>
  1458. <dd class="phpdocumentor-argument-list__definition">
  1459. </dd>
  1460. </dl>
  1461. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1462. Tags
  1463. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_row#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1464. </h5>
  1465. <dl class="phpdocumentor-tag-list">
  1466. <dt class="phpdocumentor-tag-list__entry">
  1467. <span class="phpdocumentor-tag__name">phpstan-return</span>
  1468. </dt>
  1469. <dd class="phpdocumentor-tag-list__definition">
  1470. <section class="phpdocumentor-description"><p>array{y: int, modules: array&lt;int, Module&gt;}</p>
  1471. </section>
  1472. </dd>
  1473. </dl>
  1474. <section>
  1475. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1476. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
  1477. </section>
  1478. </article>
  1479. <article
  1480. class="phpdocumentor-element
  1481. -method
  1482. -protected
  1483. "
  1484. >
  1485. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1486. saveToFile()
  1487. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1488. </h4>
  1489. <aside class="phpdocumentor-element-found-in">
  1490. <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>
  1491. :
  1492. <span class="phpdocumentor-element-found-in__line">239</span>
  1493. </aside>
  1494. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1495. <code class="phpdocumentor-code phpdocumentor-signature ">
  1496. <span class="phpdocumentor-signature__visibility">protected</span>
  1497. <span class="phpdocumentor-signature__name">saveToFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1498. <div class="phpdocumentor-label-line">
  1499. </div>
  1500. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1501. <dl class="phpdocumentor-argument-list">
  1502. <dt class="phpdocumentor-argument-list__entry">
  1503. <span class="phpdocumentor-signature__argument__name">$data</span>
  1504. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1505. </dt>
  1506. <dd class="phpdocumentor-argument-list__definition">
  1507. </dd>
  1508. <dt class="phpdocumentor-argument-list__entry">
  1509. <span class="phpdocumentor-signature__argument__name">$file</span>
  1510. : <span class="phpdocumentor-signature__argument__return-type">string|null</span>
  1511. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1512. <dd class="phpdocumentor-argument-list__definition">
  1513. </dd>
  1514. </dl>
  1515. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1516. Tags
  1517. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1518. </h5>
  1519. <dl class="phpdocumentor-tag-list">
  1520. <dt class="phpdocumentor-tag-list__entry">
  1521. <span class="phpdocumentor-tag__name">see</span>
  1522. </dt>
  1523. <dd class="phpdocumentor-tag-list__definition">
  1524. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1525. </dd>
  1526. <dt class="phpdocumentor-tag-list__entry">
  1527. <span class="phpdocumentor-tag__name">see</span>
  1528. </dt>
  1529. <dd class="phpdocumentor-tag-list__definition">
  1530. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1531. </dd>
  1532. <dt class="phpdocumentor-tag-list__entry">
  1533. <span class="phpdocumentor-tag__name">throws</span>
  1534. </dt>
  1535. <dd class="phpdocumentor-tag-list__definition">
  1536. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1537. </dd>
  1538. </dl>
  1539. </article>
  1540. <article
  1541. class="phpdocumentor-element
  1542. -method
  1543. -protected
  1544. "
  1545. >
  1546. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1547. setMatrixDimensions()
  1548. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1549. </h4>
  1550. <aside class="phpdocumentor-element-found-in">
  1551. <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>
  1552. :
  1553. <span class="phpdocumentor-element-found-in__line">127</span>
  1554. </aside>
  1555. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1556. <code class="phpdocumentor-code phpdocumentor-signature ">
  1557. <span class="phpdocumentor-signature__visibility">protected</span>
  1558. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1559. <div class="phpdocumentor-label-line">
  1560. </div>
  1561. <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>
  1562. </section>
  1563. </article>
  1564. <article
  1565. class="phpdocumentor-element
  1566. -method
  1567. -protected
  1568. "
  1569. >
  1570. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1571. setModuleValues()
  1572. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1573. </h4>
  1574. <aside class="phpdocumentor-element-found-in">
  1575. <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>
  1576. :
  1577. <span class="phpdocumentor-element-found-in__line">147</span>
  1578. </aside>
  1579. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1580. <code class="phpdocumentor-code phpdocumentor-signature ">
  1581. <span class="phpdocumentor-signature__visibility">protected</span>
  1582. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1583. <div class="phpdocumentor-label-line">
  1584. </div>
  1585. </article>
  1586. <article
  1587. class="phpdocumentor-element
  1588. -method
  1589. -protected
  1590. "
  1591. >
  1592. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1593. toBase64DataURI()
  1594. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1595. </h4>
  1596. <aside class="phpdocumentor-element-found-in">
  1597. <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>
  1598. :
  1599. <span class="phpdocumentor-element-found-in__line">201</span>
  1600. </aside>
  1601. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1602. <code class="phpdocumentor-code phpdocumentor-signature ">
  1603. <span class="phpdocumentor-signature__visibility">protected</span>
  1604. <span class="phpdocumentor-signature__name">toBase64DataURI</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1605. <div class="phpdocumentor-label-line">
  1606. </div>
  1607. <section class="phpdocumentor-description"><p>The mime type can be set via class constant MIME_TYPE in child classes,
  1608. or given via $mime, otherwise it is guessed from the image $data.</p>
  1609. </section>
  1610. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1611. <dl class="phpdocumentor-argument-list">
  1612. <dt class="phpdocumentor-argument-list__entry">
  1613. <span class="phpdocumentor-signature__argument__name">$data</span>
  1614. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1615. </dt>
  1616. <dd class="phpdocumentor-argument-list__definition">
  1617. </dd>
  1618. <dt class="phpdocumentor-argument-list__entry">
  1619. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1620. : <span class="phpdocumentor-signature__argument__return-type">string|null</span>
  1621. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1622. <dd class="phpdocumentor-argument-list__definition">
  1623. </dd>
  1624. </dl>
  1625. <section>
  1626. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1627. <span class="phpdocumentor-signature__response_type">string</span>
  1628. </section>
  1629. </article>
  1630. </section>
  1631. <div class="phpdocumentor-modal" id="source-view">
  1632. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1633. <div class="phpdocumentor-modal-container">
  1634. <div class="phpdocumentor-modal-content">
  1635. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Output/QRStringJSON.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  1636. </div>
  1637. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1638. </div>
  1639. </div>
  1640. <script type="text/javascript">
  1641. (function () {
  1642. function loadExternalCodeSnippet(el, url, line) {
  1643. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1644. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1645. const language = 'php';
  1646. const code = document.createElement('code');
  1647. code.className = 'language-' + language;
  1648. pre.textContent = '';
  1649. pre.setAttribute('data-line', line)
  1650. code.textContent = 'Loading…';
  1651. pre.appendChild(code);
  1652. var xhr = new XMLHttpRequest();
  1653. xhr.open('GET', src, true);
  1654. xhr.onreadystatechange = function () {
  1655. if (xhr.readyState !== 4) {
  1656. return;
  1657. }
  1658. if (xhr.status < 400 && xhr.responseText) {
  1659. code.textContent = xhr.responseText;
  1660. Prism.highlightElement(code);
  1661. return;
  1662. }
  1663. if (xhr.status === 404) {
  1664. code.textContent = '✖ Error: File could not be found';
  1665. return;
  1666. }
  1667. if (xhr.status >= 400) {
  1668. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1669. return;
  1670. }
  1671. code.textContent = '✖ Error: An unknown error occurred';
  1672. };
  1673. xhr.send(null);
  1674. });
  1675. }
  1676. const modalButtons = document.querySelectorAll("[data-modal]");
  1677. const openedAsLocalFile = window.location.protocol === 'file:';
  1678. if (modalButtons.length > 0 && openedAsLocalFile) {
  1679. console.warn(
  1680. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1681. 'browsers block XHR requests when a page is opened this way'
  1682. );
  1683. }
  1684. modalButtons.forEach(function (trigger) {
  1685. if (openedAsLocalFile) {
  1686. trigger.setAttribute("hidden", "hidden");
  1687. }
  1688. trigger.addEventListener("click", function (event) {
  1689. event.preventDefault();
  1690. const modal = document.getElementById(trigger.dataset.modal);
  1691. if (!modal) {
  1692. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1693. return;
  1694. }
  1695. modal.classList.add("phpdocumentor-modal__open");
  1696. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1697. const exits = modal.querySelectorAll("[data-exit-button]");
  1698. exits.forEach(function (exit) {
  1699. exit.addEventListener("click", function (event) {
  1700. event.preventDefault();
  1701. modal.classList.remove("phpdocumentor-modal__open");
  1702. });
  1703. });
  1704. });
  1705. });
  1706. })();
  1707. </script>
  1708. </article>
  1709. </section>
  1710. <section class="phpdocumentor-on-this-page__sidebar">
  1711. <section class="phpdocumentor-on-this-page__content">
  1712. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1713. <ul class="phpdocumentor-list -clean">
  1714. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1715. <li>
  1716. <ul class="phpdocumentor-list -clean">
  1717. <li><a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#toc-constants">Constants</a></li>
  1718. <li><a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#toc-properties">Properties</a></li>
  1719. <li><a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#toc-methods">Methods</a></li>
  1720. </ul>
  1721. </li>
  1722. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  1723. <li>
  1724. <ul class="phpdocumentor-list -clean">
  1725. <li class=""><a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#constant_MIME_TYPE">MIME_TYPE</a></li>
  1726. <li class=""><a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#constant_SCHEMA">SCHEMA</a></li>
  1727. </ul>
  1728. </li>
  1729. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1730. <li>
  1731. <ul class="phpdocumentor-list -clean">
  1732. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter</a></li>
  1733. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius</a></li>
  1734. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths</a></li>
  1735. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules</a></li>
  1736. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules</a></li>
  1737. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol</a></li>
  1738. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect</a></li>
  1739. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare</a></li>
  1740. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a></li>
  1741. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a></li>
  1742. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a></li>
  1743. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a></li>
  1744. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a></li>
  1745. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a></li>
  1746. </ul>
  1747. </li>
  1748. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1749. <li>
  1750. <ul class="phpdocumentor-list -clean">
  1751. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a></li>
  1752. <li class=""><a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_dump">dump()</a></li>
  1753. <li class=""><a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_getModuleValue">getModuleValue()</a></li>
  1754. <li class=""><a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  1755. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1756. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a></li>
  1757. <li class=""><a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1758. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1759. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1760. <li class=""><a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1761. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_guessMimeType">guessMimeType()</a></li>
  1762. <li class=""><a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_module">module()</a></li>
  1763. <li class=""><a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1764. <li class=""><a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#method_row">row()</a></li>
  1765. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1766. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1767. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1768. <li class=""><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1769. </ul>
  1770. </li>
  1771. </ul>
  1772. </section>
  1773. </section>
  1774. </div>
  1775. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1776. <section class="phpdocumentor-search-results__dialog">
  1777. <header class="phpdocumentor-search-results__header">
  1778. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1779. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1780. </header>
  1781. <section class="phpdocumentor-search-results__body">
  1782. <ul class="phpdocumentor-search-results__entries"></ul>
  1783. </section>
  1784. </section>
  1785. </section>
  1786. </div>
  1787. <a href="classes/chillerlan-QRCode-Output-QRStringJSON.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1788. </main>
  1789. <script>
  1790. cssVars({});
  1791. </script>
  1792. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1793. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1794. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1795. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1796. </body>
  1797. </html>