chillerlan-QRCode-Output-QRImage.html 61 KB

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