chillerlan-QRCode-Output-QRImagick.html 59 KB

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