chillerlan-QRCode-Output-QRMarkupHTML.html 111 KB

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