chillerlan-QRCode-Output-QRStringText.html 110 KB

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