chillerlan-QRCode-Output-QRStringJSON.html 111 KB

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