chillerlan-QRCode-Output-QRImagick.html 77 KB

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