chillerlan-QRCode-Output-QRGdImage.html 65 KB

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