chillerlan-QRCode-Output-QRImage.html 79 KB

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