chillerlan-QRCode-Output-QRMarkupHTML.html 110 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354
  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">null</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">null</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">null</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">null</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">null</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">null</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>