chillerlan-QRCode-Output-QRGdImage.html 82 KB

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