chillerlan-QRCode-Output-QRImagick.html 114 KB

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