chillerlan-QRCode-Output-QRStringJSON.html 104 KB

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