chillerlan-QRCode-Output-QRMarkup.html 109 KB

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