chillerlan-QRCode-Output-QRStringJSON.html 117 KB

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