chillerlan-QRCode-Output-QRStringJSON.html 107 KB

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