chillerlan-QRCode-Output-QRStringText.html 104 KB

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