chillerlan-QRCode-Output-QREps.html 109 KB

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