chillerlan-QRCode-Output-QRInterventionImage.html 110 KB

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