chillerlan-QRCode-Output-QRImagick.html 85 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. </ul>
  59. </nav>
  60. </header>
  61. <main class="phpdocumentor">
  62. <div class="phpdocumentor-section">
  63. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  64. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  65. Menu
  66. </label>
  67. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  68. <section class="phpdocumentor-sidebar__category">
  69. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  70. <h4 class="phpdocumentor-sidebar__root-namespace">
  71. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  72. </h4>
  73. <ul class="phpdocumentor-list">
  74. <li>
  75. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  76. </li>
  77. <li>
  78. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  79. </li>
  80. </ul>
  81. </section>
  82. <section class="phpdocumentor-sidebar__category">
  83. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  84. <h4 class="phpdocumentor-sidebar__root-namespace">
  85. <a href="packages/Application.html" class="">Application</a>
  86. </h4>
  87. </section>
  88. <section class="phpdocumentor-sidebar__category">
  89. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  92. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  93. </section>
  94. <section class="phpdocumentor-sidebar__category">
  95. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  96. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  97. </section>
  98. </aside>
  99. <div class="phpdocumentor-column -nine phpdocumentor-content">
  100. <section>
  101. <ul class="phpdocumentor-breadcrumbs">
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  103. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  104. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  105. </ul>
  106. <article class="phpdocumentor-element -class">
  107. <h2 class="phpdocumentor-content__title">
  108. QRImagick
  109. <span class="phpdocumentor-element__extends">
  110. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  111. </span>
  112. <div class="phpdocumentor-element__package">
  113. in package
  114. <ul class="phpdocumentor-breadcrumbs">
  115. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  116. </ul>
  117. </div>
  118. </h2>
  119. <div class="phpdocumentor-label-line">
  120. </div>
  121. <aside class="phpdocumentor-element-found-in">
  122. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRImagick.php"><a href="files/src-output-qrimagick.html"><abbr title="src/Output/QRImagick.php">QRImagick.php</abbr></a></abbr>
  123. :
  124. <span class="phpdocumentor-element-found-in__line">27</span>
  125. </aside>
  126. <p class="phpdocumentor-summary">ImageMagick output module (requires ext-imagick)</p>
  127. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  128. Tags
  129. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  130. </h5>
  131. <dl class="phpdocumentor-tag-list">
  132. <dt class="phpdocumentor-tag-list__entry">
  133. <span class="phpdocumentor-tag__name">see</span>
  134. </dt>
  135. <dd class="phpdocumentor-tag-list__definition">
  136. <span class="phpdocumentor-tag-link"><a href="https://php.net/manual/book.imagick.php">https://php.net/manual/book.imagick.php</a></span>
  137. </dd>
  138. <dt class="phpdocumentor-tag-list__entry">
  139. <span class="phpdocumentor-tag__name">see</span>
  140. </dt>
  141. <dd class="phpdocumentor-tag-list__definition">
  142. <span class="phpdocumentor-tag-link"><a href="https://phpimagick.com">https://phpimagick.com</a></span>
  143. </dd>
  144. </dl>
  145. <h3 id="toc">
  146. Table of Contents
  147. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  148. </h3>
  149. <h4 id="toc-properties">
  150. Properties
  151. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  152. </h4>
  153. <dl class="phpdocumentor-table-of-contents">
  154. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  155. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_background">$background</a>
  156. <span>
  157. &nbsp;: <abbr title="\ImagickPixel">ImagickPixel</abbr> </span>
  158. </dt>
  159. <dd>The allocated background color</dd>
  160. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  161. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick">$imagick</a>
  162. <span>
  163. &nbsp;: <abbr title="\Imagick">Imagick</abbr> </span>
  164. </dt>
  165. <dd>The main image instance</dd>
  166. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  167. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw">$imagickDraw</a>
  168. <span>
  169. &nbsp;: <abbr title="\ImagickDraw">ImagickDraw</abbr> </span>
  170. </dt>
  171. <dd>The main draw instance</dd>
  172. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  173. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  174. <span>
  175. &nbsp;: int </span>
  176. </dt>
  177. <dd>the side length of the QR image (modules * scale)</dd>
  178. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  179. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  180. <span>
  181. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  182. </dt>
  183. <dd>the (filled) data matrix object</dd>
  184. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  185. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  186. <span>
  187. &nbsp;: int </span>
  188. </dt>
  189. <dd>the current size of the QR matrix</dd>
  190. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  191. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  192. <span>
  193. &nbsp;: array&lt;string|int, mixed&gt; </span>
  194. </dt>
  195. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  196. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  197. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  198. <span>
  199. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  200. </dt>
  201. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  202. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  203. <span>
  204. &nbsp;: int </span>
  205. </dt>
  206. <dd>the current scaling for a QR pixel</dd>
  207. </dl>
  208. <h4 id="toc-methods">
  209. Methods
  210. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  211. </h4>
  212. <dl class="phpdocumentor-table-of-contents">
  213. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  214. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct">__construct()</a>
  215. <span>
  216. &nbsp;: mixed </span>
  217. </dt>
  218. <dd>QROutputAbstract constructor.</dd>
  219. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  220. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump">dump()</a>
  221. <span>
  222. &nbsp;: string|<abbr title="\Imagick">Imagick</abbr> </span>
  223. </dt>
  224. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  225. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  226. <span>
  227. &nbsp;: bool </span>
  228. </dt>
  229. <dd>note: we&#039;re not necessarily validating the several values, just checking the general syntax</dd>
  230. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  231. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  232. <span>
  233. &nbsp;: array&lt;string|int, mixed&gt; </span>
  234. </dt>
  235. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  236. returns an array with the transformed modules</dd>
  237. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  238. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage">drawImage()</a>
  239. <span>
  240. &nbsp;: void </span>
  241. </dt>
  242. <dd>Creates the QR image via ImagickDraw</dd>
  243. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  244. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  245. <span>
  246. &nbsp;: mixed|null </span>
  247. </dt>
  248. <dd>Returns a default value for either dark or light modules</dd>
  249. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  250. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  251. <span>
  252. &nbsp;: mixed|null </span>
  253. </dt>
  254. <dd>Returns the prepared value for the given $M_TYPE</dd>
  255. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  256. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  257. <span>
  258. &nbsp;: mixed|null </span>
  259. </dt>
  260. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  261. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  262. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_module">module()</a>
  263. <span>
  264. &nbsp;: void </span>
  265. </dt>
  266. <dd>draws a single pixel at the given position</dd>
  267. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  268. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_prepareModuleValue">prepareModuleValue()</a>
  269. <span>
  270. &nbsp;: mixed|null </span>
  271. </dt>
  272. <dd>Prepares the value for the given input ()</dd>
  273. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  274. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  275. <span>
  276. &nbsp;: void </span>
  277. </dt>
  278. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  279. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  280. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setBgColor">setBgColor()</a>
  281. <span>
  282. &nbsp;: void </span>
  283. </dt>
  284. <dd>Sets the background color</dd>
  285. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  286. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  287. <span>
  288. &nbsp;: void </span>
  289. </dt>
  290. <dd>Sets/updates the matrix dimensions</dd>
  291. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  292. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  293. <span>
  294. &nbsp;: void </span>
  295. </dt>
  296. <dd>Sets the initial module values</dd>
  297. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  298. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setTransparencyColor">setTransparencyColor()</a>
  299. <span>
  300. &nbsp;: void </span>
  301. </dt>
  302. <dd>Sets the transparency color</dd>
  303. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  304. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  305. <span>
  306. &nbsp;: string </span>
  307. </dt>
  308. <dd>Returns a base64 data URI for the given string and mime type</dd>
  309. </dl>
  310. <section class="phpdocumentor-properties">
  311. <h3 class="phpdocumentor-elements__header" id="properties">
  312. Properties
  313. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  314. </h3>
  315. <article
  316. class="
  317. phpdocumentor-element
  318. -property
  319. -protected
  320. "
  321. >
  322. <h4 class="phpdocumentor-element__name" id="property_background">
  323. $background
  324. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_background" class="headerlink"><i class="fas fa-link"></i></a>
  325. <span class="phpdocumentor-element__modifiers">
  326. </span>
  327. </h4>
  328. <aside class="phpdocumentor-element-found-in">
  329. <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>
  330. :
  331. <span class="phpdocumentor-element-found-in__line">42</span>
  332. </aside>
  333. <p class="phpdocumentor-summary">The allocated background color</p>
  334. <code class="phpdocumentor-code phpdocumentor-signature ">
  335. <span class="phpdocumentor-signature__visibility">protected</span>
  336. <span class="phpdocumentor-signature__type"><abbr title="\ImagickPixel">ImagickPixel</abbr></span>
  337. <span class="phpdocumentor-signature__name">$background</span>
  338. </code>
  339. </article>
  340. <article
  341. class="
  342. phpdocumentor-element
  343. -property
  344. -protected
  345. "
  346. >
  347. <h4 class="phpdocumentor-element__name" id="property_imagick">
  348. $imagick
  349. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick" class="headerlink"><i class="fas fa-link"></i></a>
  350. <span class="phpdocumentor-element__modifiers">
  351. </span>
  352. </h4>
  353. <aside class="phpdocumentor-element-found-in">
  354. <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>
  355. :
  356. <span class="phpdocumentor-element-found-in__line">32</span>
  357. </aside>
  358. <p class="phpdocumentor-summary">The main image instance</p>
  359. <code class="phpdocumentor-code phpdocumentor-signature ">
  360. <span class="phpdocumentor-signature__visibility">protected</span>
  361. <span class="phpdocumentor-signature__type"><abbr title="\Imagick">Imagick</abbr></span>
  362. <span class="phpdocumentor-signature__name">$imagick</span>
  363. </code>
  364. </article>
  365. <article
  366. class="
  367. phpdocumentor-element
  368. -property
  369. -protected
  370. "
  371. >
  372. <h4 class="phpdocumentor-element__name" id="property_imagickDraw">
  373. $imagickDraw
  374. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw" class="headerlink"><i class="fas fa-link"></i></a>
  375. <span class="phpdocumentor-element__modifiers">
  376. </span>
  377. </h4>
  378. <aside class="phpdocumentor-element-found-in">
  379. <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>
  380. :
  381. <span class="phpdocumentor-element-found-in__line">37</span>
  382. </aside>
  383. <p class="phpdocumentor-summary">The main draw instance</p>
  384. <code class="phpdocumentor-code phpdocumentor-signature ">
  385. <span class="phpdocumentor-signature__visibility">protected</span>
  386. <span class="phpdocumentor-signature__type"><abbr title="\ImagickDraw">ImagickDraw</abbr></span>
  387. <span class="phpdocumentor-signature__name">$imagickDraw</span>
  388. </code>
  389. </article>
  390. <article
  391. class="
  392. phpdocumentor-element
  393. -property
  394. -protected
  395. "
  396. >
  397. <h4 class="phpdocumentor-element__name" id="property_length">
  398. $length
  399. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  400. <span class="phpdocumentor-element__modifiers">
  401. </span>
  402. </h4>
  403. <aside class="phpdocumentor-element-found-in">
  404. <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>
  405. :
  406. <span class="phpdocumentor-element-found-in__line">40</span>
  407. </aside>
  408. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  409. <code class="phpdocumentor-code phpdocumentor-signature ">
  410. <span class="phpdocumentor-signature__visibility">protected</span>
  411. <span class="phpdocumentor-signature__type">int</span>
  412. <span class="phpdocumentor-signature__name">$length</span>
  413. </code>
  414. </article>
  415. <article
  416. class="
  417. phpdocumentor-element
  418. -property
  419. -protected
  420. "
  421. >
  422. <h4 class="phpdocumentor-element__name" id="property_matrix">
  423. $matrix
  424. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  425. <span class="phpdocumentor-element__modifiers">
  426. </span>
  427. </h4>
  428. <aside class="phpdocumentor-element-found-in">
  429. <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>
  430. :
  431. <span class="phpdocumentor-element-found-in__line">50</span>
  432. </aside>
  433. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  434. <code class="phpdocumentor-code phpdocumentor-signature ">
  435. <span class="phpdocumentor-signature__visibility">protected</span>
  436. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  437. <span class="phpdocumentor-signature__name">$matrix</span>
  438. </code>
  439. </article>
  440. <article
  441. class="
  442. phpdocumentor-element
  443. -property
  444. -protected
  445. "
  446. >
  447. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  448. $moduleCount
  449. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  450. <span class="phpdocumentor-element__modifiers">
  451. </span>
  452. </h4>
  453. <aside class="phpdocumentor-element-found-in">
  454. <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>
  455. :
  456. <span class="phpdocumentor-element-found-in__line">28</span>
  457. </aside>
  458. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  459. <code class="phpdocumentor-code phpdocumentor-signature ">
  460. <span class="phpdocumentor-signature__visibility">protected</span>
  461. <span class="phpdocumentor-signature__type">int</span>
  462. <span class="phpdocumentor-signature__name">$moduleCount</span>
  463. </code>
  464. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  465. Tags
  466. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  467. </h5>
  468. <dl class="phpdocumentor-tag-list">
  469. <dt class="phpdocumentor-tag-list__entry">
  470. <span class="phpdocumentor-tag__name">see</span>
  471. </dt>
  472. <dd class="phpdocumentor-tag-list__definition">
  473. <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>
  474. </dd>
  475. </dl>
  476. </article>
  477. <article
  478. class="
  479. phpdocumentor-element
  480. -property
  481. -protected
  482. "
  483. >
  484. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  485. $moduleValues
  486. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  487. <span class="phpdocumentor-element__modifiers">
  488. </span>
  489. </h4>
  490. <aside class="phpdocumentor-element-found-in">
  491. <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>
  492. :
  493. <span class="phpdocumentor-element-found-in__line">45</span>
  494. </aside>
  495. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  496. <code class="phpdocumentor-code phpdocumentor-signature ">
  497. <span class="phpdocumentor-signature__visibility">protected</span>
  498. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  499. <span class="phpdocumentor-signature__name">$moduleValues</span>
  500. </code>
  501. </article>
  502. <article
  503. class="
  504. phpdocumentor-element
  505. -property
  506. -protected
  507. "
  508. >
  509. <h4 class="phpdocumentor-element__name" id="property_options">
  510. $options
  511. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  512. <span class="phpdocumentor-element__modifiers">
  513. </span>
  514. </h4>
  515. <aside class="phpdocumentor-element-found-in">
  516. <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>
  517. :
  518. <span class="phpdocumentor-element-found-in__line">55</span>
  519. </aside>
  520. <code class="phpdocumentor-code phpdocumentor-signature ">
  521. <span class="phpdocumentor-signature__visibility">protected</span>
  522. <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>
  523. <span class="phpdocumentor-signature__name">$options</span>
  524. </code>
  525. </article>
  526. <article
  527. class="
  528. phpdocumentor-element
  529. -property
  530. -protected
  531. "
  532. >
  533. <h4 class="phpdocumentor-element__name" id="property_scale">
  534. $scale
  535. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  536. <span class="phpdocumentor-element__modifiers">
  537. </span>
  538. </h4>
  539. <aside class="phpdocumentor-element-found-in">
  540. <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>
  541. :
  542. <span class="phpdocumentor-element-found-in__line">35</span>
  543. </aside>
  544. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  545. <code class="phpdocumentor-code phpdocumentor-signature ">
  546. <span class="phpdocumentor-signature__visibility">protected</span>
  547. <span class="phpdocumentor-signature__type">int</span>
  548. <span class="phpdocumentor-signature__name">$scale</span>
  549. </code>
  550. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  551. Tags
  552. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  553. </h5>
  554. <dl class="phpdocumentor-tag-list">
  555. <dt class="phpdocumentor-tag-list__entry">
  556. <span class="phpdocumentor-tag__name">see</span>
  557. </dt>
  558. <dd class="phpdocumentor-tag-list__definition">
  559. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  560. </dd>
  561. </dl>
  562. </article>
  563. </section>
  564. <section class="phpdocumentor-methods">
  565. <h3 class="phpdocumentor-elements__header" id="methods">
  566. Methods
  567. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  568. </h3>
  569. <article
  570. class="phpdocumentor-element
  571. -method
  572. -public
  573. "
  574. >
  575. <h4 class="phpdocumentor-element__name" id="method___construct">
  576. __construct()
  577. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  578. </h4>
  579. <aside class="phpdocumentor-element-found-in">
  580. <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>
  581. :
  582. <span class="phpdocumentor-element-found-in__line">49</span>
  583. </aside>
  584. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  585. <code class="phpdocumentor-code phpdocumentor-signature ">
  586. <span class="phpdocumentor-signature__visibility">public</span>
  587. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  588. <div class="phpdocumentor-label-line">
  589. </div>
  590. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  591. <dl class="phpdocumentor-argument-list">
  592. <dt class="phpdocumentor-argument-list__entry">
  593. <span class="phpdocumentor-signature__argument__name">$options</span>
  594. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  595. </dt>
  596. <dd class="phpdocumentor-argument-list__definition">
  597. </dd>
  598. <dt class="phpdocumentor-argument-list__entry">
  599. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  600. : <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>
  601. </dt>
  602. <dd class="phpdocumentor-argument-list__definition">
  603. </dd>
  604. </dl>
  605. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  606. Tags
  607. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
  608. </h5>
  609. <dl class="phpdocumentor-tag-list">
  610. <dt class="phpdocumentor-tag-list__entry">
  611. <span class="phpdocumentor-tag__name">inheritDoc</span>
  612. </dt>
  613. <dd class="phpdocumentor-tag-list__definition">
  614. </dd>
  615. <dt class="phpdocumentor-tag-list__entry">
  616. <span class="phpdocumentor-tag__name">throws</span>
  617. </dt>
  618. <dd class="phpdocumentor-tag-list__definition">
  619. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  620. </dd>
  621. </dl>
  622. </article>
  623. <article
  624. class="phpdocumentor-element
  625. -method
  626. -public
  627. "
  628. >
  629. <h4 class="phpdocumentor-element__name" id="method_dump">
  630. dump()
  631. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  632. </h4>
  633. <aside class="phpdocumentor-element-found-in">
  634. <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>
  635. :
  636. <span class="phpdocumentor-element-found-in__line">117</span>
  637. </aside>
  638. <code class="phpdocumentor-code phpdocumentor-signature ">
  639. <span class="phpdocumentor-signature__visibility">public</span>
  640. <span class="phpdocumentor-signature__name">dump</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|<abbr title="\Imagick">Imagick</abbr></span></code>
  641. <div class="phpdocumentor-label-line">
  642. </div>
  643. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  644. <dl class="phpdocumentor-argument-list">
  645. <dt class="phpdocumentor-argument-list__entry">
  646. <span class="phpdocumentor-signature__argument__name">$file</span>
  647. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  648. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  649. <dd class="phpdocumentor-argument-list__definition">
  650. </dd>
  651. </dl>
  652. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  653. Tags
  654. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  655. </h5>
  656. <dl class="phpdocumentor-tag-list">
  657. <dt class="phpdocumentor-tag-list__entry">
  658. <span class="phpdocumentor-tag__name">inheritDoc</span>
  659. </dt>
  660. <dd class="phpdocumentor-tag-list__definition">
  661. </dd>
  662. </dl>
  663. <section>
  664. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  665. <span class="phpdocumentor-signature__response_type">string|<abbr title="\Imagick">Imagick</abbr></span>
  666. </section>
  667. </article>
  668. <article
  669. class="phpdocumentor-element
  670. -method
  671. -public
  672. -static "
  673. >
  674. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  675. moduleValueIsValid()
  676. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  677. </h4>
  678. <aside class="phpdocumentor-element-found-in">
  679. <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>
  680. :
  681. <span class="phpdocumentor-element-found-in__line">68</span>
  682. </aside>
  683. <p class="phpdocumentor-summary">note: we&#039;re not necessarily validating the several values, just checking the general syntax</p>
  684. <code class="phpdocumentor-code phpdocumentor-signature ">
  685. <span class="phpdocumentor-signature__visibility">public</span>
  686. <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>
  687. <div class="phpdocumentor-label-line">
  688. </div>
  689. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  690. <dl class="phpdocumentor-argument-list">
  691. <dt class="phpdocumentor-argument-list__entry">
  692. <span class="phpdocumentor-signature__argument__name">$value</span>
  693. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  694. </dt>
  695. <dd class="phpdocumentor-argument-list__definition">
  696. </dd>
  697. </dl>
  698. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  699. Tags
  700. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid#tags" class="headerlink"><i class="fas fa-link"></i></a>
  701. </h5>
  702. <dl class="phpdocumentor-tag-list">
  703. <dt class="phpdocumentor-tag-list__entry">
  704. <span class="phpdocumentor-tag__name">see</span>
  705. </dt>
  706. <dd class="phpdocumentor-tag-list__definition">
  707. <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>
  708. </dd>
  709. <dt class="phpdocumentor-tag-list__entry">
  710. <span class="phpdocumentor-tag__name">inheritDoc</span>
  711. </dt>
  712. <dd class="phpdocumentor-tag-list__definition">
  713. </dd>
  714. </dl>
  715. <section>
  716. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  717. <span class="phpdocumentor-signature__response_type">bool</span>
  718. </section>
  719. </article>
  720. <article
  721. class="phpdocumentor-element
  722. -method
  723. -protected
  724. "
  725. >
  726. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  727. collectModules()
  728. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  729. </h4>
  730. <aside class="phpdocumentor-element-found-in">
  731. <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>
  732. :
  733. <span class="phpdocumentor-element-found-in__line">176</span>
  734. </aside>
  735. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  736. returns an array with the transformed modules</p>
  737. <code class="phpdocumentor-code phpdocumentor-signature ">
  738. <span class="phpdocumentor-signature__visibility">protected</span>
  739. <span class="phpdocumentor-signature__name">collectModules</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$transform</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  740. <div class="phpdocumentor-label-line">
  741. </div>
  742. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  743. <p>$x - current column
  744. $y - current row
  745. $M_TYPE - field value
  746. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  747. </section>
  748. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  749. <dl class="phpdocumentor-argument-list">
  750. <dt class="phpdocumentor-argument-list__entry">
  751. <span class="phpdocumentor-signature__argument__name">$transform</span>
  752. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  753. </dt>
  754. <dd class="phpdocumentor-argument-list__definition">
  755. </dd>
  756. </dl>
  757. <section>
  758. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  759. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  760. </section>
  761. </article>
  762. <article
  763. class="phpdocumentor-element
  764. -method
  765. -protected
  766. "
  767. >
  768. <h4 class="phpdocumentor-element__name" id="method_drawImage">
  769. drawImage()
  770. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage" class="headerlink"><i class="fas fa-link"></i></a>
  771. </h4>
  772. <aside class="phpdocumentor-element-found-in">
  773. <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>
  774. :
  775. <span class="phpdocumentor-element-found-in__line">188</span>
  776. </aside>
  777. <p class="phpdocumentor-summary">Creates the QR image via ImagickDraw</p>
  778. <code class="phpdocumentor-code phpdocumentor-signature ">
  779. <span class="phpdocumentor-signature__visibility">protected</span>
  780. <span class="phpdocumentor-signature__name">drawImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  781. <div class="phpdocumentor-label-line">
  782. </div>
  783. </article>
  784. <article
  785. class="phpdocumentor-element
  786. -method
  787. -protected
  788. "
  789. >
  790. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  791. getDefaultModuleValue()
  792. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  793. </h4>
  794. <aside class="phpdocumentor-element-found-in">
  795. <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>
  796. :
  797. <span class="phpdocumentor-element-found-in__line">108</span>
  798. </aside>
  799. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
  800. <code class="phpdocumentor-code phpdocumentor-signature ">
  801. <span class="phpdocumentor-signature__visibility">protected</span>
  802. <span class="phpdocumentor-signature__name">getDefaultModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$isDark</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  803. <div class="phpdocumentor-label-line">
  804. </div>
  805. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  806. <dl class="phpdocumentor-argument-list">
  807. <dt class="phpdocumentor-argument-list__entry">
  808. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  809. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  810. </dt>
  811. <dd class="phpdocumentor-argument-list__definition">
  812. </dd>
  813. </dl>
  814. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  815. Tags
  816. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  817. </h5>
  818. <dl class="phpdocumentor-tag-list">
  819. <dt class="phpdocumentor-tag-list__entry">
  820. <span class="phpdocumentor-tag__name">inheritDoc</span>
  821. </dt>
  822. <dd class="phpdocumentor-tag-list__definition">
  823. </dd>
  824. </dl>
  825. <section>
  826. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  827. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  828. &mdash;
  829. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  830. </section>
  831. </section>
  832. </article>
  833. <article
  834. class="phpdocumentor-element
  835. -method
  836. -protected
  837. "
  838. >
  839. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  840. getModuleValue()
  841. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  842. </h4>
  843. <aside class="phpdocumentor-element-found-in">
  844. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  845. :
  846. <span class="phpdocumentor-element-found-in__line">100</span>
  847. </aside>
  848. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  849. <code class="phpdocumentor-code phpdocumentor-signature ">
  850. <span class="phpdocumentor-signature__visibility">protected</span>
  851. <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|null</span></code>
  852. <div class="phpdocumentor-label-line">
  853. </div>
  854. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  855. <dl class="phpdocumentor-argument-list">
  856. <dt class="phpdocumentor-argument-list__entry">
  857. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  858. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  859. </dt>
  860. <dd class="phpdocumentor-argument-list__definition">
  861. </dd>
  862. </dl>
  863. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  864. Tags
  865. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  866. </h5>
  867. <dl class="phpdocumentor-tag-list">
  868. <dt class="phpdocumentor-tag-list__entry">
  869. <span class="phpdocumentor-tag__name">throws</span>
  870. </dt>
  871. <dd class="phpdocumentor-tag-list__definition">
  872. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  873. </dd>
  874. </dl>
  875. <section>
  876. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  877. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  878. &mdash;
  879. <section class="phpdocumentor-description"><p>return value depends on the output class, null if $moduleValues[$M_TYPE] doesn't exist</p>
  880. </section>
  881. </section>
  882. </article>
  883. <article
  884. class="phpdocumentor-element
  885. -method
  886. -protected
  887. "
  888. >
  889. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  890. getModuleValueAt()
  891. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  892. </h4>
  893. <aside class="phpdocumentor-element-found-in">
  894. <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>
  895. :
  896. <span class="phpdocumentor-element-found-in__line">115</span>
  897. </aside>
  898. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  899. <code class="phpdocumentor-code phpdocumentor-signature ">
  900. <span class="phpdocumentor-signature__visibility">protected</span>
  901. <span class="phpdocumentor-signature__name">getModuleValueAt</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  902. <div class="phpdocumentor-label-line">
  903. </div>
  904. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  905. <dl class="phpdocumentor-argument-list">
  906. <dt class="phpdocumentor-argument-list__entry">
  907. <span class="phpdocumentor-signature__argument__name">$x</span>
  908. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  909. </dt>
  910. <dd class="phpdocumentor-argument-list__definition">
  911. </dd>
  912. <dt class="phpdocumentor-argument-list__entry">
  913. <span class="phpdocumentor-signature__argument__name">$y</span>
  914. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  915. </dt>
  916. <dd class="phpdocumentor-argument-list__definition">
  917. </dd>
  918. </dl>
  919. <section>
  920. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  921. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  922. </section>
  923. </article>
  924. <article
  925. class="phpdocumentor-element
  926. -method
  927. -protected
  928. "
  929. >
  930. <h4 class="phpdocumentor-element__name" id="method_module">
  931. module()
  932. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  933. </h4>
  934. <aside class="phpdocumentor-element-found-in">
  935. <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>
  936. :
  937. <span class="phpdocumentor-element-found-in__line">204</span>
  938. </aside>
  939. <p class="phpdocumentor-summary">draws a single pixel at the given position</p>
  940. <code class="phpdocumentor-code phpdocumentor-signature ">
  941. <span class="phpdocumentor-signature__visibility">protected</span>
  942. <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>
  943. <div class="phpdocumentor-label-line">
  944. </div>
  945. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  946. <dl class="phpdocumentor-argument-list">
  947. <dt class="phpdocumentor-argument-list__entry">
  948. <span class="phpdocumentor-signature__argument__name">$x</span>
  949. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  950. </dt>
  951. <dd class="phpdocumentor-argument-list__definition">
  952. </dd>
  953. <dt class="phpdocumentor-argument-list__entry">
  954. <span class="phpdocumentor-signature__argument__name">$y</span>
  955. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  956. </dt>
  957. <dd class="phpdocumentor-argument-list__definition">
  958. </dd>
  959. <dt class="phpdocumentor-argument-list__entry">
  960. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  961. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  962. </dt>
  963. <dd class="phpdocumentor-argument-list__definition">
  964. </dd>
  965. </dl>
  966. </article>
  967. <article
  968. class="phpdocumentor-element
  969. -method
  970. -protected
  971. "
  972. >
  973. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  974. prepareModuleValue()
  975. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  976. </h4>
  977. <aside class="phpdocumentor-element-found-in">
  978. <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>
  979. :
  980. <span class="phpdocumentor-element-found-in__line">101</span>
  981. </aside>
  982. <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
  983. <code class="phpdocumentor-code phpdocumentor-signature ">
  984. <span class="phpdocumentor-signature__visibility">protected</span>
  985. <span class="phpdocumentor-signature__name">prepareModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  986. <div class="phpdocumentor-label-line">
  987. </div>
  988. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  989. <dl class="phpdocumentor-argument-list">
  990. <dt class="phpdocumentor-argument-list__entry">
  991. <span class="phpdocumentor-signature__argument__name">$value</span>
  992. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  993. </dt>
  994. <dd class="phpdocumentor-argument-list__definition">
  995. </dd>
  996. </dl>
  997. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  998. Tags
  999. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_prepareModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1000. </h5>
  1001. <dl class="phpdocumentor-tag-list">
  1002. <dt class="phpdocumentor-tag-list__entry">
  1003. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1004. </dt>
  1005. <dd class="phpdocumentor-tag-list__definition">
  1006. </dd>
  1007. </dl>
  1008. <section>
  1009. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1010. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  1011. &mdash;
  1012. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  1013. </section>
  1014. </section>
  1015. </article>
  1016. <article
  1017. class="phpdocumentor-element
  1018. -method
  1019. -protected
  1020. "
  1021. >
  1022. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1023. saveToFile()
  1024. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1025. </h4>
  1026. <aside class="phpdocumentor-element-found-in">
  1027. <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>
  1028. :
  1029. <span class="phpdocumentor-element-found-in__line">150</span>
  1030. </aside>
  1031. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1032. <code class="phpdocumentor-code phpdocumentor-signature ">
  1033. <span class="phpdocumentor-signature__visibility">protected</span>
  1034. <span class="phpdocumentor-signature__name">saveToFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1035. <div class="phpdocumentor-label-line">
  1036. </div>
  1037. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1038. <dl class="phpdocumentor-argument-list">
  1039. <dt class="phpdocumentor-argument-list__entry">
  1040. <span class="phpdocumentor-signature__argument__name">$data</span>
  1041. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1042. </dt>
  1043. <dd class="phpdocumentor-argument-list__definition">
  1044. </dd>
  1045. <dt class="phpdocumentor-argument-list__entry">
  1046. <span class="phpdocumentor-signature__argument__name">$file</span>
  1047. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1048. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1049. <dd class="phpdocumentor-argument-list__definition">
  1050. </dd>
  1051. </dl>
  1052. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1053. Tags
  1054. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1055. </h5>
  1056. <dl class="phpdocumentor-tag-list">
  1057. <dt class="phpdocumentor-tag-list__entry">
  1058. <span class="phpdocumentor-tag__name">see</span>
  1059. </dt>
  1060. <dd class="phpdocumentor-tag-list__definition">
  1061. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1062. </dd>
  1063. <dt class="phpdocumentor-tag-list__entry">
  1064. <span class="phpdocumentor-tag__name">see</span>
  1065. </dt>
  1066. <dd class="phpdocumentor-tag-list__definition">
  1067. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1068. </dd>
  1069. <dt class="phpdocumentor-tag-list__entry">
  1070. <span class="phpdocumentor-tag__name">throws</span>
  1071. </dt>
  1072. <dd class="phpdocumentor-tag-list__definition">
  1073. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1074. </dd>
  1075. </dl>
  1076. </article>
  1077. <article
  1078. class="phpdocumentor-element
  1079. -method
  1080. -protected
  1081. "
  1082. >
  1083. <h4 class="phpdocumentor-element__name" id="method_setBgColor">
  1084. setBgColor()
  1085. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setBgColor" class="headerlink"><i class="fas fa-link"></i></a>
  1086. </h4>
  1087. <aside class="phpdocumentor-element-found-in">
  1088. <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>
  1089. :
  1090. <span class="phpdocumentor-element-found-in__line">152</span>
  1091. </aside>
  1092. <p class="phpdocumentor-summary">Sets the background color</p>
  1093. <code class="phpdocumentor-code phpdocumentor-signature ">
  1094. <span class="phpdocumentor-signature__visibility">protected</span>
  1095. <span class="phpdocumentor-signature__name">setBgColor</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1096. <div class="phpdocumentor-label-line">
  1097. </div>
  1098. </article>
  1099. <article
  1100. class="phpdocumentor-element
  1101. -method
  1102. -protected
  1103. "
  1104. >
  1105. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1106. setMatrixDimensions()
  1107. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1108. </h4>
  1109. <aside class="phpdocumentor-element-found-in">
  1110. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1111. :
  1112. <span class="phpdocumentor-element-found-in__line">73</span>
  1113. </aside>
  1114. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1115. <code class="phpdocumentor-code phpdocumentor-signature ">
  1116. <span class="phpdocumentor-signature__visibility">protected</span>
  1117. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1118. <div class="phpdocumentor-label-line">
  1119. </div>
  1120. <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>
  1121. </section>
  1122. </article>
  1123. <article
  1124. class="phpdocumentor-element
  1125. -method
  1126. -protected
  1127. "
  1128. >
  1129. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1130. setModuleValues()
  1131. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1132. </h4>
  1133. <aside class="phpdocumentor-element-found-in">
  1134. <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>
  1135. :
  1136. <span class="phpdocumentor-element-found-in__line">82</span>
  1137. </aside>
  1138. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1139. <code class="phpdocumentor-code phpdocumentor-signature ">
  1140. <span class="phpdocumentor-signature__visibility">protected</span>
  1141. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1142. <div class="phpdocumentor-label-line">
  1143. </div>
  1144. </article>
  1145. <article
  1146. class="phpdocumentor-element
  1147. -method
  1148. -protected
  1149. "
  1150. >
  1151. <h4 class="phpdocumentor-element__name" id="method_setTransparencyColor">
  1152. setTransparencyColor()
  1153. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setTransparencyColor" class="headerlink"><i class="fas fa-link"></i></a>
  1154. </h4>
  1155. <aside class="phpdocumentor-element-found-in">
  1156. <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>
  1157. :
  1158. <span class="phpdocumentor-element-found-in__line">170</span>
  1159. </aside>
  1160. <p class="phpdocumentor-summary">Sets the transparency color</p>
  1161. <code class="phpdocumentor-code phpdocumentor-signature ">
  1162. <span class="phpdocumentor-signature__visibility">protected</span>
  1163. <span class="phpdocumentor-signature__name">setTransparencyColor</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1164. <div class="phpdocumentor-label-line">
  1165. </div>
  1166. </article>
  1167. <article
  1168. class="phpdocumentor-element
  1169. -method
  1170. -protected
  1171. "
  1172. >
  1173. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1174. toBase64DataURI()
  1175. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1176. </h4>
  1177. <aside class="phpdocumentor-element-found-in">
  1178. <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>
  1179. :
  1180. <span class="phpdocumentor-element-found-in__line">138</span>
  1181. </aside>
  1182. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1183. <code class="phpdocumentor-code phpdocumentor-signature ">
  1184. <span class="phpdocumentor-signature__visibility">protected</span>
  1185. <span class="phpdocumentor-signature__name">toBase64DataURI</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1186. <div class="phpdocumentor-label-line">
  1187. </div>
  1188. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1189. <dl class="phpdocumentor-argument-list">
  1190. <dt class="phpdocumentor-argument-list__entry">
  1191. <span class="phpdocumentor-signature__argument__name">$data</span>
  1192. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1193. </dt>
  1194. <dd class="phpdocumentor-argument-list__definition">
  1195. </dd>
  1196. <dt class="phpdocumentor-argument-list__entry">
  1197. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1198. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1199. </dt>
  1200. <dd class="phpdocumentor-argument-list__definition">
  1201. </dd>
  1202. </dl>
  1203. <section>
  1204. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1205. <span class="phpdocumentor-signature__response_type">string</span>
  1206. </section>
  1207. </article>
  1208. </section>
  1209. <div class="phpdocumentor-modal" id="source-view">
  1210. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1211. <div class="phpdocumentor-modal-container">
  1212. <div class="phpdocumentor-modal-content">
  1213. <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>
  1214. </div>
  1215. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1216. </div>
  1217. </div>
  1218. <script type="text/javascript">
  1219. (function () {
  1220. function loadExternalCodeSnippet(el, url, line) {
  1221. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1222. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1223. const language = 'php';
  1224. const code = document.createElement('code');
  1225. code.className = 'language-' + language;
  1226. pre.textContent = '';
  1227. pre.setAttribute('data-line', line)
  1228. code.textContent = 'Loading…';
  1229. pre.appendChild(code);
  1230. var xhr = new XMLHttpRequest();
  1231. xhr.open('GET', src, true);
  1232. xhr.onreadystatechange = function () {
  1233. if (xhr.readyState !== 4) {
  1234. return;
  1235. }
  1236. if (xhr.status < 400 && xhr.responseText) {
  1237. code.textContent = xhr.responseText;
  1238. Prism.highlightElement(code);
  1239. return;
  1240. }
  1241. if (xhr.status === 404) {
  1242. code.textContent = '✖ Error: File could not be found';
  1243. return;
  1244. }
  1245. if (xhr.status >= 400) {
  1246. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1247. return;
  1248. }
  1249. code.textContent = '✖ Error: An unknown error occurred';
  1250. };
  1251. xhr.send(null);
  1252. });
  1253. }
  1254. const modalButtons = document.querySelectorAll("[data-modal]");
  1255. const openedAsLocalFile = window.location.protocol === 'file:';
  1256. if (modalButtons.length > 0 && openedAsLocalFile) {
  1257. console.warn(
  1258. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1259. 'browsers block XHR requests when a page is opened this way'
  1260. );
  1261. }
  1262. modalButtons.forEach(function (trigger) {
  1263. if (openedAsLocalFile) {
  1264. trigger.setAttribute("hidden", "hidden");
  1265. }
  1266. trigger.addEventListener("click", function (event) {
  1267. event.preventDefault();
  1268. const modal = document.getElementById(trigger.dataset.modal);
  1269. if (!modal) {
  1270. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1271. return;
  1272. }
  1273. modal.classList.add("phpdocumentor-modal__open");
  1274. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1275. const exits = modal.querySelectorAll("[data-exit-button]");
  1276. exits.forEach(function (exit) {
  1277. exit.addEventListener("click", function (event) {
  1278. event.preventDefault();
  1279. modal.classList.remove("phpdocumentor-modal__open");
  1280. });
  1281. });
  1282. });
  1283. });
  1284. })();
  1285. </script>
  1286. </article>
  1287. </section>
  1288. <section class="phpdocumentor-on-this-page__sidebar">
  1289. <section class="phpdocumentor-on-this-page__content">
  1290. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1291. <ul class="phpdocumentor-list -clean">
  1292. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1293. <li>
  1294. <ul class="phpdocumentor-list -clean">
  1295. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#toc-properties">Properties</a></li>
  1296. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#toc-methods">Methods</a></li>
  1297. </ul>
  1298. </li>
  1299. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1300. <li>
  1301. <ul class="phpdocumentor-list -clean">
  1302. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_background">$background<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1303. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick">$imagick<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1304. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw">$imagickDraw<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1305. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1306. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1307. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1308. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1309. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1310. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1311. </ul>
  1312. </li>
  1313. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1314. <li>
  1315. <ul class="phpdocumentor-list -clean">
  1316. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct">__construct()</a></li>
  1317. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump">dump()</a></li>
  1318. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  1319. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1320. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage">drawImage()</a></li>
  1321. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1322. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1323. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1324. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_module">module()</a></li>
  1325. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1326. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1327. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setBgColor">setBgColor()</a></li>
  1328. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1329. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1330. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setTransparencyColor">setTransparencyColor()</a></li>
  1331. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1332. </ul>
  1333. </li>
  1334. </ul>
  1335. </section>
  1336. </section>
  1337. </div>
  1338. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1339. <section class="phpdocumentor-search-results__dialog">
  1340. <header class="phpdocumentor-search-results__header">
  1341. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1342. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1343. </header>
  1344. <section class="phpdocumentor-search-results__body">
  1345. <ul class="phpdocumentor-search-results__entries"></ul>
  1346. </section>
  1347. </section>
  1348. </section>
  1349. </div>
  1350. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1351. </main>
  1352. <script>
  1353. cssVars({});
  1354. </script>
  1355. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1356. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1357. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1358. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1359. </body>
  1360. </html>