chillerlan-QRCode-Output-QRImagick.html 59 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250
  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. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/chillerlan.html">chillerlan</a></h4>
  56. <ul class="phpdocumentor-list">
  57. <li>
  58. <a href="namespaces/chillerlan-qrcode.html">QRCode</a>
  59. </li>
  60. <li>
  61. <a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a>
  62. </li>
  63. </ul>
  64. </section>
  65. <section class="phpdocumentor-sidebar__category">
  66. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  67. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
  68. </section>
  69. <section class="phpdocumentor-sidebar__category">
  70. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  71. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  72. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  73. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  74. </section>
  75. <section class="phpdocumentor-sidebar__category">
  76. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  78. </section>
  79. </aside>
  80. <div class="phpdocumentor-column -eight phpdocumentor-content">
  81. <ul class="phpdocumentor-breadcrumbs">
  82. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  83. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  84. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  85. </ul>
  86. <article class="phpdocumentor-element -class">
  87. <h2 class="phpdocumentor-content__title">
  88. QRImagick
  89. <span class="phpdocumentor-element__extends">
  90. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  91. </span>
  92. <div class="phpdocumentor-element__package">
  93. in package
  94. <ul class="phpdocumentor-breadcrumbs">
  95. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  96. </ul>
  97. </div>
  98. </h2>
  99. <aside class="phpdocumentor-element-found-in">
  100. <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>
  101. :
  102. <span class="phpdocumentor-element-found-in__line">27</span>
  103. </aside>
  104. <p class="phpdocumentor-summary">ImageMagick output module (requires ext-imagick)</p>
  105. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  106. Tags
  107. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  108. </h5>
  109. <dl class="phpdocumentor-tag-list">
  110. <dt class="phpdocumentor-tag-list__entry">
  111. <span class="phpdocumentor-tag__name">see</span>
  112. </dt>
  113. <dd class="phpdocumentor-tag-list__definition">
  114. <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>
  115. </dd>
  116. <dt class="phpdocumentor-tag-list__entry">
  117. <span class="phpdocumentor-tag__name">see</span>
  118. </dt>
  119. <dd class="phpdocumentor-tag-list__definition">
  120. <span class="phpdocumentor-tag-link"><a href="http://phpimagick.com"><abbr title="http://phpimagick.com">http://phpimagick.com</abbr></a></span>
  121. </dd>
  122. </dl>
  123. <h3 id="toc">
  124. Table of Contents
  125. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  126. </h3>
  127. <dl class="phpdocumentor-table-of-contents">
  128. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  129. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick">$imagick</a>
  130. <span>
  131. &nbsp;: <abbr title="\Imagick">Imagick</abbr> </span>
  132. </dt>
  133. <dd></dd>
  134. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  135. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw">$imagickDraw</a>
  136. <span>
  137. &nbsp;: <abbr title="\ImagickDraw">ImagickDraw</abbr> </span>
  138. </dt>
  139. <dd></dd>
  140. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  141. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  142. <span>
  143. &nbsp;: int </span>
  144. </dt>
  145. <dd>the side length of the QR image (modules * scale)</dd>
  146. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  147. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  148. <span>
  149. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  150. </dt>
  151. <dd>the (filled) data matrix object</dd>
  152. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  153. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  154. <span>
  155. &nbsp;: int </span>
  156. </dt>
  157. <dd>the current size of the QR matrix</dd>
  158. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  159. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  160. <span>
  161. &nbsp;: array&lt;string|int, mixed&gt; </span>
  162. </dt>
  163. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  164. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  165. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  166. <span>
  167. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  168. </dt>
  169. <dd></dd>
  170. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  171. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  172. <span>
  173. &nbsp;: int </span>
  174. </dt>
  175. <dd>the current scaling for a QR pixel</dd>
  176. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  177. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct">__construct()</a>
  178. <span>
  179. &nbsp;: mixed </span>
  180. </dt>
  181. <dd>QROutputAbstract constructor.</dd>
  182. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  183. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump">dump()</a>
  184. <span>
  185. &nbsp;: string|<abbr title="\Imagick">Imagick</abbr> </span>
  186. </dt>
  187. <dd></dd>
  188. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  189. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode">base64encode()</a>
  190. <span>
  191. &nbsp;: string </span>
  192. </dt>
  193. <dd>Returns a base64 data URI for the given string and mime type</dd>
  194. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  195. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage">drawImage()</a>
  196. <span>
  197. &nbsp;: void </span>
  198. </dt>
  199. <dd>Creates the QR image via ImagickDraw</dd>
  200. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  201. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  202. <span>
  203. &nbsp;: mixed </span>
  204. </dt>
  205. <dd>Returns a defualt value for either dark or light modules (return value depends on the output module)</dd>
  206. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  207. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getModuleValue">getModuleValue()</a>
  208. <span>
  209. &nbsp;: mixed </span>
  210. </dt>
  211. <dd>Returns the final value for the given input (return value depends on the output module)</dd>
  212. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  213. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  214. <span>
  215. &nbsp;: bool </span>
  216. </dt>
  217. <dd>Determines whether the given value is valid</dd>
  218. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  219. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  220. <span>
  221. &nbsp;: void </span>
  222. </dt>
  223. <dd>saves the qr data to a file</dd>
  224. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  225. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  226. <span>
  227. &nbsp;: void </span>
  228. </dt>
  229. <dd>Sets the initial module values</dd>
  230. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  231. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setPixel">setPixel()</a>
  232. <span>
  233. &nbsp;: void </span>
  234. </dt>
  235. <dd>draws a single pixel at the given position</dd>
  236. </dl>
  237. <section class="phpdocumentor-properties">
  238. <h3 class="phpdocumentor-elements__header" id="properties">
  239. Properties
  240. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  241. </h3>
  242. <article
  243. class="
  244. phpdocumentor-element
  245. -property
  246. -protected
  247. "
  248. >
  249. <h4 class="phpdocumentor-element__name" id="property_imagick">
  250. $imagick
  251. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick" class="headerlink"><i class="fas fa-link"></i></a>
  252. <span class="phpdocumentor-element__modifiers">
  253. </span>
  254. </h4>
  255. <aside class="phpdocumentor-element-found-in">
  256. <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>
  257. :
  258. <span class="phpdocumentor-element-found-in__line">29</span>
  259. </aside>
  260. <code class="phpdocumentor-code phpdocumentor-signature ">
  261. <span class="phpdocumentor-signature__visibility">protected</span>
  262. <span class="phpdocumentor-signature__type"><abbr title="\Imagick">Imagick</abbr></span>
  263. <span class="phpdocumentor-signature__name">$imagick</span>
  264. </code>
  265. <section class="phpdocumentor-description"></section>
  266. <section class="phpdocumentor-description"></section>
  267. </article>
  268. <article
  269. class="
  270. phpdocumentor-element
  271. -property
  272. -protected
  273. "
  274. >
  275. <h4 class="phpdocumentor-element__name" id="property_imagickDraw">
  276. $imagickDraw
  277. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw" class="headerlink"><i class="fas fa-link"></i></a>
  278. <span class="phpdocumentor-element__modifiers">
  279. </span>
  280. </h4>
  281. <aside class="phpdocumentor-element-found-in">
  282. <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>
  283. :
  284. <span class="phpdocumentor-element-found-in__line">30</span>
  285. </aside>
  286. <code class="phpdocumentor-code phpdocumentor-signature ">
  287. <span class="phpdocumentor-signature__visibility">protected</span>
  288. <span class="phpdocumentor-signature__type"><abbr title="\ImagickDraw">ImagickDraw</abbr></span>
  289. <span class="phpdocumentor-signature__name">$imagickDraw</span>
  290. </code>
  291. <section class="phpdocumentor-description"></section>
  292. <section class="phpdocumentor-description"></section>
  293. </article>
  294. <article
  295. class="
  296. phpdocumentor-element
  297. -property
  298. -protected
  299. "
  300. >
  301. <h4 class="phpdocumentor-element__name" id="property_length">
  302. $length
  303. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  304. <span class="phpdocumentor-element__modifiers">
  305. </span>
  306. </h4>
  307. <aside class="phpdocumentor-element-found-in">
  308. <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>
  309. :
  310. <span class="phpdocumentor-element-found-in__line">39</span>
  311. </aside>
  312. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  313. <code class="phpdocumentor-code phpdocumentor-signature ">
  314. <span class="phpdocumentor-signature__visibility">protected</span>
  315. <span class="phpdocumentor-signature__type">int</span>
  316. <span class="phpdocumentor-signature__name">$length</span>
  317. </code>
  318. <section class="phpdocumentor-description"></section>
  319. </article>
  320. <article
  321. class="
  322. phpdocumentor-element
  323. -property
  324. -protected
  325. "
  326. >
  327. <h4 class="phpdocumentor-element__name" id="property_matrix">
  328. $matrix
  329. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  330. <span class="phpdocumentor-element__modifiers">
  331. </span>
  332. </h4>
  333. <aside class="phpdocumentor-element-found-in">
  334. <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>
  335. :
  336. <span class="phpdocumentor-element-found-in__line">49</span>
  337. </aside>
  338. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  339. <code class="phpdocumentor-code phpdocumentor-signature ">
  340. <span class="phpdocumentor-signature__visibility">protected</span>
  341. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  342. <span class="phpdocumentor-signature__name">$matrix</span>
  343. </code>
  344. <section class="phpdocumentor-description"></section>
  345. </article>
  346. <article
  347. class="
  348. phpdocumentor-element
  349. -property
  350. -protected
  351. "
  352. >
  353. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  354. $moduleCount
  355. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  356. <span class="phpdocumentor-element__modifiers">
  357. </span>
  358. </h4>
  359. <aside class="phpdocumentor-element-found-in">
  360. <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>
  361. :
  362. <span class="phpdocumentor-element-found-in__line">27</span>
  363. </aside>
  364. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  365. <code class="phpdocumentor-code phpdocumentor-signature ">
  366. <span class="phpdocumentor-signature__visibility">protected</span>
  367. <span class="phpdocumentor-signature__type">int</span>
  368. <span class="phpdocumentor-signature__name">$moduleCount</span>
  369. </code>
  370. <section class="phpdocumentor-description"></section>
  371. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  372. Tags
  373. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  374. </h5>
  375. <dl class="phpdocumentor-tag-list">
  376. <dt class="phpdocumentor-tag-list__entry">
  377. <span class="phpdocumentor-tag__name">see</span>
  378. </dt>
  379. <dd class="phpdocumentor-tag-list__definition">
  380. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size"><abbr title="\chillerlan\QRCode\Data\QRMatrix::size()">QRMatrix::size()</abbr></a></span>
  381. </dd>
  382. </dl>
  383. </article>
  384. <article
  385. class="
  386. phpdocumentor-element
  387. -property
  388. -protected
  389. "
  390. >
  391. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  392. $moduleValues
  393. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  394. <span class="phpdocumentor-element__modifiers">
  395. </span>
  396. </h4>
  397. <aside class="phpdocumentor-element-found-in">
  398. <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>
  399. :
  400. <span class="phpdocumentor-element-found-in__line">44</span>
  401. </aside>
  402. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  403. <code class="phpdocumentor-code phpdocumentor-signature ">
  404. <span class="phpdocumentor-signature__visibility">protected</span>
  405. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  406. <span class="phpdocumentor-signature__name">$moduleValues</span>
  407. </code>
  408. <section class="phpdocumentor-description"></section>
  409. </article>
  410. <article
  411. class="
  412. phpdocumentor-element
  413. -property
  414. -protected
  415. "
  416. >
  417. <h4 class="phpdocumentor-element__name" id="property_options">
  418. $options
  419. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  420. <span class="phpdocumentor-element__modifiers">
  421. </span>
  422. </h4>
  423. <aside class="phpdocumentor-element-found-in">
  424. <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>
  425. :
  426. <span class="phpdocumentor-element-found-in__line">54</span>
  427. </aside>
  428. <code class="phpdocumentor-code phpdocumentor-signature ">
  429. <span class="phpdocumentor-signature__visibility">protected</span>
  430. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  431. <span class="phpdocumentor-signature__name">$options</span>
  432. </code>
  433. </article>
  434. <article
  435. class="
  436. phpdocumentor-element
  437. -property
  438. -protected
  439. "
  440. >
  441. <h4 class="phpdocumentor-element__name" id="property_scale">
  442. $scale
  443. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  444. <span class="phpdocumentor-element__modifiers">
  445. </span>
  446. </h4>
  447. <aside class="phpdocumentor-element-found-in">
  448. <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>
  449. :
  450. <span class="phpdocumentor-element-found-in__line">34</span>
  451. </aside>
  452. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  453. <code class="phpdocumentor-code phpdocumentor-signature ">
  454. <span class="phpdocumentor-signature__visibility">protected</span>
  455. <span class="phpdocumentor-signature__type">int</span>
  456. <span class="phpdocumentor-signature__name">$scale</span>
  457. </code>
  458. <section class="phpdocumentor-description"></section>
  459. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  460. Tags
  461. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  462. </h5>
  463. <dl class="phpdocumentor-tag-list">
  464. <dt class="phpdocumentor-tag-list__entry">
  465. <span class="phpdocumentor-tag__name">see</span>
  466. </dt>
  467. <dd class="phpdocumentor-tag-list__definition">
  468. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  469. </dd>
  470. </dl>
  471. </article>
  472. </section>
  473. <section class="phpdocumentor-methods">
  474. <h3 class="phpdocumentor-elements__header" id="methods">
  475. Methods
  476. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  477. </h3>
  478. <article
  479. class="phpdocumentor-element
  480. -method
  481. -public
  482. "
  483. >
  484. <h4 class="phpdocumentor-element__name" id="method___construct">
  485. __construct()
  486. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  487. </h4>
  488. <aside class="phpdocumentor-element-found-in">
  489. <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>
  490. :
  491. <span class="phpdocumentor-element-found-in__line">37</span>
  492. </aside>
  493. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  494. <code class="phpdocumentor-code phpdocumentor-signature ">
  495. <span class="phpdocumentor-signature__visibility">public</span>
  496. <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>
  497. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  498. <dl class="phpdocumentor-argument-list">
  499. <dt class="phpdocumentor-argument-list__entry">
  500. <span class="phpdocumentor-signature__argument__name">$options</span>
  501. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  502. </dt>
  503. <dd class="phpdocumentor-argument-list__definition">
  504. <section class="phpdocumentor-description"></section>
  505. </dd>
  506. <dt class="phpdocumentor-argument-list__entry">
  507. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  508. : <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>
  509. </dt>
  510. <dd class="phpdocumentor-argument-list__definition">
  511. <section class="phpdocumentor-description"></section>
  512. </dd>
  513. </dl>
  514. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  515. Tags
  516. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  517. </h5>
  518. <dl class="phpdocumentor-tag-list">
  519. <dt class="phpdocumentor-tag-list__entry">
  520. <span class="phpdocumentor-tag__name">inheritDoc</span>
  521. </dt>
  522. <dd class="phpdocumentor-tag-list__definition">
  523. </dd>
  524. <dt class="phpdocumentor-tag-list__entry">
  525. <span class="phpdocumentor-tag__name">throws</span>
  526. </dt>
  527. <dd class="phpdocumentor-tag-list__definition">
  528. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  529. </dd>
  530. </dl>
  531. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  532. <span class="phpdocumentor-signature__response_type">mixed</span>
  533. &mdash;
  534. </article>
  535. <article
  536. class="phpdocumentor-element
  537. -method
  538. -public
  539. "
  540. >
  541. <h4 class="phpdocumentor-element__name" id="method_dump">
  542. dump()
  543. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  544. </h4>
  545. <aside class="phpdocumentor-element-found-in">
  546. <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>
  547. :
  548. <span class="phpdocumentor-element-found-in__line">72</span>
  549. </aside>
  550. <code class="phpdocumentor-code phpdocumentor-signature ">
  551. <span class="phpdocumentor-signature__visibility">public</span>
  552. <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>
  553. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  554. <dl class="phpdocumentor-argument-list">
  555. <dt class="phpdocumentor-argument-list__entry">
  556. <span class="phpdocumentor-signature__argument__name">$file</span>
  557. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  558. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  559. <dd class="phpdocumentor-argument-list__definition">
  560. <section class="phpdocumentor-description"></section>
  561. </dd>
  562. </dl>
  563. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  564. Tags
  565. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  566. </h5>
  567. <dl class="phpdocumentor-tag-list">
  568. <dt class="phpdocumentor-tag-list__entry">
  569. <span class="phpdocumentor-tag__name">inheritDoc</span>
  570. </dt>
  571. <dd class="phpdocumentor-tag-list__definition">
  572. </dd>
  573. </dl>
  574. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  575. <span class="phpdocumentor-signature__response_type">string|<abbr title="\Imagick">Imagick</abbr></span>
  576. &mdash;
  577. </article>
  578. <article
  579. class="phpdocumentor-element
  580. -method
  581. -protected
  582. "
  583. >
  584. <h4 class="phpdocumentor-element__name" id="method_base64encode">
  585. base64encode()
  586. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode" class="headerlink"><i class="fas fa-link"></i></a>
  587. </h4>
  588. <aside class="phpdocumentor-element-found-in">
  589. <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>
  590. :
  591. <span class="phpdocumentor-element-found-in__line">110</span>
  592. </aside>
  593. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  594. <code class="phpdocumentor-code phpdocumentor-signature ">
  595. <span class="phpdocumentor-signature__visibility">protected</span>
  596. <span class="phpdocumentor-signature__name">base64encode</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>
  597. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  598. <dl class="phpdocumentor-argument-list">
  599. <dt class="phpdocumentor-argument-list__entry">
  600. <span class="phpdocumentor-signature__argument__name">$data</span>
  601. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  602. </dt>
  603. <dd class="phpdocumentor-argument-list__definition">
  604. <section class="phpdocumentor-description"></section>
  605. </dd>
  606. <dt class="phpdocumentor-argument-list__entry">
  607. <span class="phpdocumentor-signature__argument__name">$mime</span>
  608. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  609. </dt>
  610. <dd class="phpdocumentor-argument-list__definition">
  611. <section class="phpdocumentor-description"></section>
  612. </dd>
  613. </dl>
  614. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  615. <span class="phpdocumentor-signature__response_type">string</span>
  616. &mdash;
  617. </article>
  618. <article
  619. class="phpdocumentor-element
  620. -method
  621. -protected
  622. "
  623. >
  624. <h4 class="phpdocumentor-element__name" id="method_drawImage">
  625. drawImage()
  626. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage" class="headerlink"><i class="fas fa-link"></i></a>
  627. </h4>
  628. <aside class="phpdocumentor-element-found-in">
  629. <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>
  630. :
  631. <span class="phpdocumentor-element-found-in__line">105</span>
  632. </aside>
  633. <p class="phpdocumentor-summary">Creates the QR image via ImagickDraw</p>
  634. <code class="phpdocumentor-code phpdocumentor-signature ">
  635. <span class="phpdocumentor-signature__visibility">protected</span>
  636. <span class="phpdocumentor-signature__name">drawImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  637. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  638. <span class="phpdocumentor-signature__response_type">void</span>
  639. &mdash;
  640. </article>
  641. <article
  642. class="phpdocumentor-element
  643. -method
  644. -protected
  645. "
  646. >
  647. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  648. getDefaultModuleValue()
  649. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  650. </h4>
  651. <aside class="phpdocumentor-element-found-in">
  652. <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>
  653. :
  654. <span class="phpdocumentor-element-found-in__line">63</span>
  655. </aside>
  656. <p class="phpdocumentor-summary">Returns a defualt value for either dark or light modules (return value depends on the output module)</p>
  657. <code class="phpdocumentor-code phpdocumentor-signature ">
  658. <span class="phpdocumentor-signature__visibility">protected</span>
  659. <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</span></code>
  660. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  661. <dl class="phpdocumentor-argument-list">
  662. <dt class="phpdocumentor-argument-list__entry">
  663. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  664. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  665. </dt>
  666. <dd class="phpdocumentor-argument-list__definition">
  667. <section class="phpdocumentor-description"></section>
  668. </dd>
  669. </dl>
  670. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  671. Tags
  672. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  673. </h5>
  674. <dl class="phpdocumentor-tag-list">
  675. <dt class="phpdocumentor-tag-list__entry">
  676. <span class="phpdocumentor-tag__name">inheritDoc</span>
  677. </dt>
  678. <dd class="phpdocumentor-tag-list__definition">
  679. </dd>
  680. </dl>
  681. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  682. <span class="phpdocumentor-signature__response_type">mixed</span>
  683. &mdash;
  684. </article>
  685. <article
  686. class="phpdocumentor-element
  687. -method
  688. -protected
  689. "
  690. >
  691. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  692. getModuleValue()
  693. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  694. </h4>
  695. <aside class="phpdocumentor-element-found-in">
  696. <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>
  697. :
  698. <span class="phpdocumentor-element-found-in__line">56</span>
  699. </aside>
  700. <p class="phpdocumentor-summary">Returns the final value for the given input (return value depends on the output module)</p>
  701. <code class="phpdocumentor-code phpdocumentor-signature ">
  702. <span class="phpdocumentor-signature__visibility">protected</span>
  703. <span class="phpdocumentor-signature__name">getModuleValue</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</span></code>
  704. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  705. <dl class="phpdocumentor-argument-list">
  706. <dt class="phpdocumentor-argument-list__entry">
  707. <span class="phpdocumentor-signature__argument__name">$value</span>
  708. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  709. </dt>
  710. <dd class="phpdocumentor-argument-list__definition">
  711. </dd>
  712. </dl>
  713. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  714. Tags
  715. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  716. </h5>
  717. <dl class="phpdocumentor-tag-list">
  718. <dt class="phpdocumentor-tag-list__entry">
  719. <span class="phpdocumentor-tag__name">inheritDoc</span>
  720. </dt>
  721. <dd class="phpdocumentor-tag-list__definition">
  722. </dd>
  723. </dl>
  724. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  725. <span class="phpdocumentor-signature__response_type">mixed</span>
  726. &mdash;
  727. </article>
  728. <article
  729. class="phpdocumentor-element
  730. -method
  731. -protected
  732. "
  733. >
  734. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  735. moduleValueIsValid()
  736. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  737. </h4>
  738. <aside class="phpdocumentor-element-found-in">
  739. <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>
  740. :
  741. <span class="phpdocumentor-element-found-in__line">49</span>
  742. </aside>
  743. <p class="phpdocumentor-summary">Determines whether the given value is valid</p>
  744. <code class="phpdocumentor-code phpdocumentor-signature ">
  745. <span class="phpdocumentor-signature__visibility">protected</span>
  746. <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>
  747. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  748. <dl class="phpdocumentor-argument-list">
  749. <dt class="phpdocumentor-argument-list__entry">
  750. <span class="phpdocumentor-signature__argument__name">$value</span>
  751. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  752. </dt>
  753. <dd class="phpdocumentor-argument-list__definition">
  754. </dd>
  755. </dl>
  756. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  757. Tags
  758. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  759. </h5>
  760. <dl class="phpdocumentor-tag-list">
  761. <dt class="phpdocumentor-tag-list__entry">
  762. <span class="phpdocumentor-tag__name">inheritDoc</span>
  763. </dt>
  764. <dd class="phpdocumentor-tag-list__definition">
  765. </dd>
  766. </dl>
  767. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  768. <span class="phpdocumentor-signature__response_type">bool</span>
  769. &mdash;
  770. </article>
  771. <article
  772. class="phpdocumentor-element
  773. -method
  774. -protected
  775. "
  776. >
  777. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  778. saveToFile()
  779. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  780. </h4>
  781. <aside class="phpdocumentor-element-found-in">
  782. <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>
  783. :
  784. <span class="phpdocumentor-element-found-in__line">122</span>
  785. </aside>
  786. <p class="phpdocumentor-summary">saves the qr data to a file</p>
  787. <code class="phpdocumentor-code phpdocumentor-signature ">
  788. <span class="phpdocumentor-signature__visibility">protected</span>
  789. <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 class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  790. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  791. <dl class="phpdocumentor-argument-list">
  792. <dt class="phpdocumentor-argument-list__entry">
  793. <span class="phpdocumentor-signature__argument__name">$data</span>
  794. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  795. </dt>
  796. <dd class="phpdocumentor-argument-list__definition">
  797. <section class="phpdocumentor-description"></section>
  798. </dd>
  799. <dt class="phpdocumentor-argument-list__entry">
  800. <span class="phpdocumentor-signature__argument__name">$file</span>
  801. : <span class="phpdocumentor-signature__argument__return-type">string</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">see</span>
  814. </dt>
  815. <dd class="phpdocumentor-tag-list__definition">
  816. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  817. </dd>
  818. <dt class="phpdocumentor-tag-list__entry">
  819. <span class="phpdocumentor-tag__name">see</span>
  820. </dt>
  821. <dd class="phpdocumentor-tag-list__definition">
  822. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::cachefile">QROptions::cachefile</abbr></span>
  823. </dd>
  824. <dt class="phpdocumentor-tag-list__entry">
  825. <span class="phpdocumentor-tag__name">throws</span>
  826. </dt>
  827. <dd class="phpdocumentor-tag-list__definition">
  828. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  829. </dd>
  830. </dl>
  831. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  832. <span class="phpdocumentor-signature__response_type">void</span>
  833. &mdash;
  834. </article>
  835. <article
  836. class="phpdocumentor-element
  837. -method
  838. -protected
  839. "
  840. >
  841. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  842. setModuleValues()
  843. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  844. </h4>
  845. <aside class="phpdocumentor-element-found-in">
  846. <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>
  847. :
  848. <span class="phpdocumentor-element-found-in__line">72</span>
  849. </aside>
  850. <p class="phpdocumentor-summary">Sets the initial module values</p>
  851. <code class="phpdocumentor-code phpdocumentor-signature ">
  852. <span class="phpdocumentor-signature__visibility">protected</span>
  853. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  854. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  855. <span class="phpdocumentor-signature__response_type">void</span>
  856. &mdash;
  857. </article>
  858. <article
  859. class="phpdocumentor-element
  860. -method
  861. -protected
  862. "
  863. >
  864. <h4 class="phpdocumentor-element__name" id="method_setPixel">
  865. setPixel()
  866. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setPixel" class="headerlink"><i class="fas fa-link"></i></a>
  867. </h4>
  868. <aside class="phpdocumentor-element-found-in">
  869. <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>
  870. :
  871. <span class="phpdocumentor-element-found-in__line">120</span>
  872. </aside>
  873. <p class="phpdocumentor-summary">draws a single pixel at the given position</p>
  874. <code class="phpdocumentor-code phpdocumentor-signature ">
  875. <span class="phpdocumentor-signature__visibility">protected</span>
  876. <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 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>
  877. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  878. <dl class="phpdocumentor-argument-list">
  879. <dt class="phpdocumentor-argument-list__entry">
  880. <span class="phpdocumentor-signature__argument__name">$x</span>
  881. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  882. </dt>
  883. <dd class="phpdocumentor-argument-list__definition">
  884. <section class="phpdocumentor-description"></section>
  885. </dd>
  886. <dt class="phpdocumentor-argument-list__entry">
  887. <span class="phpdocumentor-signature__argument__name">$y</span>
  888. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  889. </dt>
  890. <dd class="phpdocumentor-argument-list__definition">
  891. <section class="phpdocumentor-description"></section>
  892. </dd>
  893. <dt class="phpdocumentor-argument-list__entry">
  894. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  895. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  896. </dt>
  897. <dd class="phpdocumentor-argument-list__definition">
  898. <section class="phpdocumentor-description"></section>
  899. </dd>
  900. </dl>
  901. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  902. <span class="phpdocumentor-signature__response_type">void</span>
  903. &mdash;
  904. </article>
  905. </section>
  906. <script type="text/javascript">
  907. function loadExternalCodeSnippets(line) {
  908. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  909. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  910. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  911. var language = 'php';
  912. var code = document.createElement('code');
  913. code.className = 'language-' + language;
  914. pre.textContent = '';
  915. pre.setAttribute('data-line', line)
  916. code.textContent = 'Loading…';
  917. pre.appendChild(code);
  918. var xhr = new XMLHttpRequest();
  919. xhr.open('GET', src, true);
  920. xhr.onreadystatechange = function () {
  921. if (xhr.readyState == 4) {
  922. if (xhr.status < 400 && xhr.responseText) {
  923. code.textContent = xhr.responseText;
  924. Prism.highlightElement(code);
  925. }
  926. else if (xhr.status >= 400) {
  927. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  928. }
  929. else {
  930. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  931. }
  932. }
  933. };
  934. xhr.send(null);
  935. });
  936. }
  937. var modals = document.querySelectorAll("[data-modal]");
  938. modals.forEach(function (trigger) {
  939. trigger.addEventListener("click", function (event) {
  940. //event.preventDefault();
  941. const modal = document.getElementById(trigger.dataset.modal);
  942. modal.classList.add("phpdocumentor-modal__open");
  943. loadExternalCodeSnippets(trigger.dataset.line)
  944. const exits = modal.querySelectorAll("[data-exit-button]");
  945. exits.forEach(function (exit) {
  946. exit.addEventListener("click", function (event) {
  947. event.preventDefault();
  948. modal.classList.remove("phpdocumentor-modal__open");
  949. });
  950. });
  951. });
  952. });
  953. </script>
  954. </article>
  955. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  956. <section class="phpdocumentor-search-results__dialog">
  957. <header class="phpdocumentor-search-results__header">
  958. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  959. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  960. </header>
  961. <section class="phpdocumentor-search-results__body">
  962. <ul class="phpdocumentor-search-results__entries"></ul>
  963. </section>
  964. </section>
  965. </section>
  966. </div>
  967. </div>
  968. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  969. </main>
  970. <script>
  971. cssVars({});
  972. </script>
  973. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  974. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  975. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  976. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  977. </body>
  978. </html>