chillerlan-QRCode-Output-QREps.html 111 KB

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