chillerlan-QRCode-Output-QRImage.html 80 KB

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