chillerlan-QRCode-Output-QRImagick.html 109 KB

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