chillerlan-QRCode-Output-QRImagick.html 89 KB

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