chillerlan-QRCode-Output-QRGdImage.html 83 KB

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