chillerlan-QRCode-Output-QRGdImageGIF.html 127 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704
  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=Open+Sans:wght@100;200;300;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/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. <h4 class="phpdocumentor-sidebar__root-namespace">
  89. <a href="namespaces/output.html" class="">Output</a>
  90. </h4>
  91. </section>
  92. <section class="phpdocumentor-sidebar__category -packages">
  93. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  94. <h4 class="phpdocumentor-sidebar__root-namespace">
  95. <a href="packages/Application.html" class="">Application</a>
  96. </h4>
  97. </section>
  98. <section class="phpdocumentor-sidebar__category -reports">
  99. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  100. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  101. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  102. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  103. </section>
  104. <section class="phpdocumentor-sidebar__category -indices">
  105. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  106. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  107. </section>
  108. </aside>
  109. <div class="phpdocumentor-column -nine phpdocumentor-content">
  110. <section>
  111. <ul class="phpdocumentor-breadcrumbs">
  112. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  113. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  114. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  115. </ul>
  116. <article class="phpdocumentor-element -class">
  117. <h2 class="phpdocumentor-content__title">
  118. QRGdImageGIF
  119. <span class="phpdocumentor-element__extends">
  120. extends <a href="classes/chillerlan-QRCode-Output-QRGdImage.html"><abbr title="\chillerlan\QRCode\Output\QRGdImage">QRGdImage</abbr></a>
  121. </span>
  122. <div class="phpdocumentor-element__package">
  123. in package
  124. <ul class="phpdocumentor-breadcrumbs">
  125. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  126. </ul>
  127. </div>
  128. </h2>
  129. <div class="phpdocumentor-label-line">
  130. </div>
  131. <aside class="phpdocumentor-element-found-in">
  132. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImageGIF.php"><a href="files/src-output-qrgdimagegif.html"><abbr title="src/Output/QRGdImageGIF.php">QRGdImageGIF.php</abbr></a></abbr>
  133. :
  134. <span class="phpdocumentor-element-found-in__line">22</span>
  135. </aside>
  136. <p class="phpdocumentor-summary">GdImage gif output</p>
  137. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  138. Tags
  139. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  140. </h5>
  141. <dl class="phpdocumentor-tag-list">
  142. <dt class="phpdocumentor-tag-list__entry">
  143. <span class="phpdocumentor-tag__name">see</span>
  144. </dt>
  145. <dd class="phpdocumentor-tag-list__definition">
  146. <span class="phpdocumentor-tag-link"><abbr title="\imagegif()">imagegif()</abbr></span>
  147. </dd>
  148. </dl>
  149. <h3 id="toc">
  150. Table of Contents
  151. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  152. </h3>
  153. <h4 id="toc-constants">
  154. Constants
  155. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  156. </h4>
  157. <dl class="phpdocumentor-table-of-contents">
  158. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  159. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#constant_MIME_TYPE">MIME_TYPE</a>
  160. <span>
  161. &nbsp;= &#039;image/gif&#039; </span>
  162. </dt>
  163. </dl>
  164. <h4 id="toc-properties">
  165. Properties
  166. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  167. </h4>
  168. <dl class="phpdocumentor-table-of-contents">
  169. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  170. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_background">$background</a>
  171. <span>
  172. &nbsp;: int </span>
  173. </dt>
  174. <dd>The allocated background color</dd>
  175. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  176. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter</a>
  177. <span>
  178. &nbsp;: float </span>
  179. </dt>
  180. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  181. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius</a>
  182. <span>
  183. &nbsp;: float </span>
  184. </dt>
  185. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  186. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths</a>
  187. <span>
  188. &nbsp;: bool </span>
  189. </dt>
  190. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  191. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules</a>
  192. <span>
  193. &nbsp;: bool </span>
  194. </dt>
  195. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  196. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules</a>
  197. <span>
  198. &nbsp;: bool </span>
  199. </dt>
  200. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  201. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol</a>
  202. <span>
  203. &nbsp;: string </span>
  204. </dt>
  205. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  206. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect</a>
  207. <span>
  208. &nbsp;: array&lt;string|int, mixed&gt; </span>
  209. </dt>
  210. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  211. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image">$image</a>
  212. <span>
  213. &nbsp;: <abbr title="\GdImage">GdImage</abbr> </span>
  214. </dt>
  215. <dd>The GD image resource</dd>
  216. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  217. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare</a>
  218. <span>
  219. &nbsp;: array&lt;string|int, mixed&gt; </span>
  220. </dt>
  221. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  222. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  223. <span>
  224. &nbsp;: int </span>
  225. </dt>
  226. <dd>the side length of the QR image (modules * scale)</dd>
  227. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  228. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  229. <span>
  230. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  231. </dt>
  232. <dd>the (filled) data matrix object</dd>
  233. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  234. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  235. <span>
  236. &nbsp;: int </span>
  237. </dt>
  238. <dd>the current size of the QR matrix</dd>
  239. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  240. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  241. <span>
  242. &nbsp;: array&lt;string|int, mixed&gt; </span>
  243. </dt>
  244. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  245. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  246. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  247. <span>
  248. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  249. </dt>
  250. <dd>the options instance</dd>
  251. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  252. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  253. <span>
  254. &nbsp;: int </span>
  255. </dt>
  256. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  257. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_upscaled">$upscaled</a>
  258. <span>
  259. &nbsp;: bool </span>
  260. </dt>
  261. <dd>Whether we&#039;re running in upscale mode (scale &lt; 20)</dd>
  262. </dl>
  263. <h4 id="toc-methods">
  264. Methods
  265. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  266. </h4>
  267. <dl class="phpdocumentor-table-of-contents">
  268. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  269. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method___construct">__construct()</a>
  270. <span>
  271. &nbsp;: mixed </span>
  272. </dt>
  273. <dd>QROutputAbstract constructor.</dd>
  274. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  275. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump">dump()</a>
  276. <span>
  277. &nbsp;: string|<abbr title="\GdImage">GdImage</abbr> </span>
  278. </dt>
  279. <dd>Generates the output, optionally dumps it to a file, and returns it</dd>
  280. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  281. <a href="classes/chillerlan-QRCode-Output-RGBArrayModuleValueTrait.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  282. <span>
  283. &nbsp;: bool </span>
  284. </dt>
  285. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  286. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_checkGD">checkGD()</a>
  287. <span>
  288. &nbsp;: void </span>
  289. </dt>
  290. <dd>Checks whether GD is installed and if the given mode is supported</dd>
  291. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  292. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  293. <span>
  294. &nbsp;: array&lt;string|int, mixed&gt; </span>
  295. </dt>
  296. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  297. returns an array with the transformed modules</dd>
  298. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  299. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a>
  300. <span>
  301. &nbsp;: void </span>
  302. </dt>
  303. <dd>Creates copies of several QROptions values to avoid calling the magic getters
  304. in long loops for a significant performance increase.</dd>
  305. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  306. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_createImage">createImage()</a>
  307. <span>
  308. &nbsp;: <abbr title="\GdImage">GdImage</abbr> </span>
  309. </dt>
  310. <dd>Creates a new GdImage resource and scales it if necessary</dd>
  311. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  312. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_drawImage">drawImage()</a>
  313. <span>
  314. &nbsp;: void </span>
  315. </dt>
  316. <dd>Draws the QR image</dd>
  317. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  318. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage">dumpImage()</a>
  319. <span>
  320. &nbsp;: string </span>
  321. </dt>
  322. <dd>Creates the final image by calling the desired GD output function</dd>
  323. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  324. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  325. <span>
  326. &nbsp;: int </span>
  327. </dt>
  328. <dd>Returns a default value for either dark or light modules (return value depends on the output class)</dd>
  329. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  330. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  331. <span>
  332. &nbsp;: mixed </span>
  333. </dt>
  334. <dd>Returns the prepared value for the given $M_TYPE</dd>
  335. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  336. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  337. <span>
  338. &nbsp;: mixed </span>
  339. </dt>
  340. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  341. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  342. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a>
  343. <span>
  344. &nbsp;: array&lt;string|int, mixed&gt; </span>
  345. </dt>
  346. <dd>Returns a 2 element array with the current output width and height</dd>
  347. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  348. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_module">module()</a>
  349. <span>
  350. &nbsp;: void </span>
  351. </dt>
  352. <dd>Creates a single QR pixel with the given settings</dd>
  353. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  354. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_prepareModuleValue">prepareModuleValue()</a>
  355. <span>
  356. &nbsp;: int </span>
  357. </dt>
  358. <dd>Prepares the value for the given input (return value depends on the output class)</dd>
  359. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  360. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#method_renderImage">renderImage()</a>
  361. <span>
  362. &nbsp;: void </span>
  363. </dt>
  364. <dd>Renders the image with the gdimage function for the desired output</dd>
  365. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  366. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  367. <span>
  368. &nbsp;: void </span>
  369. </dt>
  370. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  371. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  372. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setBgColor">setBgColor()</a>
  373. <span>
  374. &nbsp;: void </span>
  375. </dt>
  376. <dd>Sets the background color</dd>
  377. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  378. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  379. <span>
  380. &nbsp;: void </span>
  381. </dt>
  382. <dd>Sets/updates the matrix dimensions</dd>
  383. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  384. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  385. <span>
  386. &nbsp;: void </span>
  387. </dt>
  388. <dd>Sets the initial module values</dd>
  389. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  390. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setTransparencyColor">setTransparencyColor()</a>
  391. <span>
  392. &nbsp;: void </span>
  393. </dt>
  394. <dd>Sets the transparency color</dd>
  395. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  396. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  397. <span>
  398. &nbsp;: string </span>
  399. </dt>
  400. <dd>Returns a base64 data URI for the given string and mime type</dd>
  401. </dl>
  402. <section class="phpdocumentor-constants">
  403. <h3 class="phpdocumentor-elements__header" id="constants">
  404. Constants
  405. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  406. </h3>
  407. <article class="phpdocumentor-element -constant -public ">
  408. <h4 class="phpdocumentor-element__name" id="constant_MIME_TYPE">
  409. MIME_TYPE
  410. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#constant_MIME_TYPE" class="headerlink"><i class="fas fa-link"></i></a>
  411. </h4>
  412. <aside class="phpdocumentor-element-found-in">
  413. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImageGIF.php"><a href="files/src-output-qrgdimagegif.html"><abbr title="src/Output/QRGdImageGIF.php">QRGdImageGIF.php</abbr></a></abbr>
  414. :
  415. <span class="phpdocumentor-element-found-in__line">24</span>
  416. </aside>
  417. <code class="phpdocumentor-signature phpdocumentor-code ">
  418. <span class="phpdocumentor-signature__visibility">public</span>
  419. <span class="phpdocumentor-signature__final">final</span> <span class="phpdocumentor-signature__type">mixed</span>
  420. <span class="phpdocumentor-signature__name">MIME_TYPE</span>
  421. = <span class="phpdocumentor-signature__default-value">&#039;image/gif&#039;</span>
  422. </code>
  423. </article>
  424. </section>
  425. <section class="phpdocumentor-properties">
  426. <h3 class="phpdocumentor-elements__header" id="properties">
  427. Properties
  428. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  429. </h3>
  430. <article
  431. class="
  432. phpdocumentor-element
  433. -property
  434. -protected
  435. "
  436. >
  437. <h4 class="phpdocumentor-element__name" id="property_background">
  438. $background
  439. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_background" class="headerlink"><i class="fas fa-link"></i></a>
  440. <span class="phpdocumentor-element__modifiers">
  441. </span>
  442. </h4>
  443. <aside class="phpdocumentor-element-found-in">
  444. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImage.php"><a href="files/src-output-qrgdimage.html"><abbr title="src/Output/QRGdImage.php">QRGdImage.php</abbr></a></abbr>
  445. :
  446. <span class="phpdocumentor-element-found-in__line">46</span>
  447. </aside>
  448. <p class="phpdocumentor-summary">The allocated background color</p>
  449. <code class="phpdocumentor-code phpdocumentor-signature ">
  450. <span class="phpdocumentor-signature__visibility">protected</span>
  451. <span class="phpdocumentor-signature__type">int</span>
  452. <span class="phpdocumentor-signature__name">$background</span>
  453. </code>
  454. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  455. Tags
  456. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_background#tags" class="headerlink"><i class="fas fa-link"></i></a>
  457. </h5>
  458. <dl class="phpdocumentor-tag-list">
  459. <dt class="phpdocumentor-tag-list__entry">
  460. <span class="phpdocumentor-tag__name">see</span>
  461. </dt>
  462. <dd class="phpdocumentor-tag-list__definition">
  463. <span class="phpdocumentor-tag-link"><abbr title="\imagecolorallocate()">imagecolorallocate()</abbr></span>
  464. </dd>
  465. </dl>
  466. </article>
  467. <article
  468. class="
  469. phpdocumentor-element
  470. -property
  471. -protected
  472. "
  473. >
  474. <h4 class="phpdocumentor-element__name" id="property_circleDiameter">
  475. $circleDiameter
  476. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter" class="headerlink"><i class="fas fa-link"></i></a>
  477. <span class="phpdocumentor-element__modifiers">
  478. </span>
  479. </h4>
  480. <aside class="phpdocumentor-element-found-in">
  481. <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>
  482. :
  483. <span class="phpdocumentor-element-found-in__line">67</span>
  484. </aside>
  485. <code class="phpdocumentor-code phpdocumentor-signature ">
  486. <span class="phpdocumentor-signature__visibility">protected</span>
  487. <span class="phpdocumentor-signature__type">float</span>
  488. <span class="phpdocumentor-signature__name">$circleDiameter</span>
  489. </code>
  490. </article>
  491. <article
  492. class="
  493. phpdocumentor-element
  494. -property
  495. -protected
  496. "
  497. >
  498. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  499. $circleRadius
  500. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  501. <span class="phpdocumentor-element__modifiers">
  502. </span>
  503. </h4>
  504. <aside class="phpdocumentor-element-found-in">
  505. <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>
  506. :
  507. <span class="phpdocumentor-element-found-in__line">66</span>
  508. </aside>
  509. <code class="phpdocumentor-code phpdocumentor-signature ">
  510. <span class="phpdocumentor-signature__visibility">protected</span>
  511. <span class="phpdocumentor-signature__type">float</span>
  512. <span class="phpdocumentor-signature__name">$circleRadius</span>
  513. </code>
  514. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  515. Tags
  516. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius#tags" class="headerlink"><i class="fas fa-link"></i></a>
  517. </h5>
  518. <dl class="phpdocumentor-tag-list">
  519. <dt class="phpdocumentor-tag-list__entry">
  520. <span class="phpdocumentor-tag__name">see</span>
  521. </dt>
  522. <dd class="phpdocumentor-tag-list__definition">
  523. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$circleRadius">QROptions::$circleRadius</abbr></span>
  524. </dd>
  525. </dl>
  526. </article>
  527. <article
  528. class="
  529. phpdocumentor-element
  530. -property
  531. -protected
  532. "
  533. >
  534. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  535. $connectPaths
  536. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  537. <span class="phpdocumentor-element__modifiers">
  538. </span>
  539. </h4>
  540. <aside class="phpdocumentor-element-found-in">
  541. <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>
  542. :
  543. <span class="phpdocumentor-element-found-in__line">54</span>
  544. </aside>
  545. <code class="phpdocumentor-code phpdocumentor-signature ">
  546. <span class="phpdocumentor-signature__visibility">protected</span>
  547. <span class="phpdocumentor-signature__type">bool</span>
  548. <span class="phpdocumentor-signature__name">$connectPaths</span>
  549. </code>
  550. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  551. Tags
  552. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  553. </h5>
  554. <dl class="phpdocumentor-tag-list">
  555. <dt class="phpdocumentor-tag-list__entry">
  556. <span class="phpdocumentor-tag__name">see</span>
  557. </dt>
  558. <dd class="phpdocumentor-tag-list__definition">
  559. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$connectPaths">QROptions::$connectPaths</abbr></span>
  560. </dd>
  561. </dl>
  562. </article>
  563. <article
  564. class="
  565. phpdocumentor-element
  566. -property
  567. -protected
  568. "
  569. >
  570. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  571. $drawCircularModules
  572. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  573. <span class="phpdocumentor-element__modifiers">
  574. </span>
  575. </h4>
  576. <aside class="phpdocumentor-element-found-in">
  577. <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>
  578. :
  579. <span class="phpdocumentor-element-found-in__line">62</span>
  580. </aside>
  581. <code class="phpdocumentor-code phpdocumentor-signature ">
  582. <span class="phpdocumentor-signature__visibility">protected</span>
  583. <span class="phpdocumentor-signature__type">bool</span>
  584. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  585. </code>
  586. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  587. Tags
  588. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  589. </h5>
  590. <dl class="phpdocumentor-tag-list">
  591. <dt class="phpdocumentor-tag-list__entry">
  592. <span class="phpdocumentor-tag__name">see</span>
  593. </dt>
  594. <dd class="phpdocumentor-tag-list__definition">
  595. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawCircularModules">QROptions::$drawCircularModules</abbr></span>
  596. </dd>
  597. </dl>
  598. </article>
  599. <article
  600. class="
  601. phpdocumentor-element
  602. -property
  603. -protected
  604. "
  605. >
  606. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  607. $drawLightModules
  608. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  609. <span class="phpdocumentor-element__modifiers">
  610. </span>
  611. </h4>
  612. <aside class="phpdocumentor-element-found-in">
  613. <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>
  614. :
  615. <span class="phpdocumentor-element-found-in__line">60</span>
  616. </aside>
  617. <code class="phpdocumentor-code phpdocumentor-signature ">
  618. <span class="phpdocumentor-signature__visibility">protected</span>
  619. <span class="phpdocumentor-signature__type">bool</span>
  620. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  621. </code>
  622. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  623. Tags
  624. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  625. </h5>
  626. <dl class="phpdocumentor-tag-list">
  627. <dt class="phpdocumentor-tag-list__entry">
  628. <span class="phpdocumentor-tag__name">see</span>
  629. </dt>
  630. <dd class="phpdocumentor-tag-list__definition">
  631. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawLightModules">QROptions::$drawLightModules</abbr></span>
  632. </dd>
  633. </dl>
  634. </article>
  635. <article
  636. class="
  637. phpdocumentor-element
  638. -property
  639. -protected
  640. "
  641. >
  642. <h4 class="phpdocumentor-element__name" id="property_eol">
  643. $eol
  644. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  645. <span class="phpdocumentor-element__modifiers">
  646. </span>
  647. </h4>
  648. <aside class="phpdocumentor-element-found-in">
  649. <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>
  650. :
  651. <span class="phpdocumentor-element-found-in__line">58</span>
  652. </aside>
  653. <code class="phpdocumentor-code phpdocumentor-signature ">
  654. <span class="phpdocumentor-signature__visibility">protected</span>
  655. <span class="phpdocumentor-signature__type">string</span>
  656. <span class="phpdocumentor-signature__name">$eol</span>
  657. </code>
  658. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  659. Tags
  660. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol#tags" class="headerlink"><i class="fas fa-link"></i></a>
  661. </h5>
  662. <dl class="phpdocumentor-tag-list">
  663. <dt class="phpdocumentor-tag-list__entry">
  664. <span class="phpdocumentor-tag__name">see</span>
  665. </dt>
  666. <dd class="phpdocumentor-tag-list__definition">
  667. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$eol">QROptions::$eol</abbr></span>
  668. </dd>
  669. </dl>
  670. </article>
  671. <article
  672. class="
  673. phpdocumentor-element
  674. -property
  675. -protected
  676. "
  677. >
  678. <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
  679. $excludeFromConnect
  680. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  681. <span class="phpdocumentor-element__modifiers">
  682. </span>
  683. </h4>
  684. <aside class="phpdocumentor-element-found-in">
  685. <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>
  686. :
  687. <span class="phpdocumentor-element-found-in__line">56</span>
  688. </aside>
  689. <code class="phpdocumentor-code phpdocumentor-signature ">
  690. <span class="phpdocumentor-signature__visibility">protected</span>
  691. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  692. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  693. </code>
  694. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  695. Tags
  696. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect#tags" class="headerlink"><i class="fas fa-link"></i></a>
  697. </h5>
  698. <dl class="phpdocumentor-tag-list">
  699. <dt class="phpdocumentor-tag-list__entry">
  700. <span class="phpdocumentor-tag__name">see</span>
  701. </dt>
  702. <dd class="phpdocumentor-tag-list__definition">
  703. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$excludeFromConnect">QROptions::$excludeFromConnect</abbr></span>
  704. </dd>
  705. </dl>
  706. </article>
  707. <article
  708. class="
  709. phpdocumentor-element
  710. -property
  711. -protected
  712. "
  713. >
  714. <h4 class="phpdocumentor-element__name" id="property_image">
  715. $image
  716. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image" class="headerlink"><i class="fas fa-link"></i></a>
  717. <span class="phpdocumentor-element__modifiers">
  718. </span>
  719. </h4>
  720. <aside class="phpdocumentor-element-found-in">
  721. <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>
  722. :
  723. <span class="phpdocumentor-element-found-in__line">39</span>
  724. </aside>
  725. <p class="phpdocumentor-summary">The GD image resource</p>
  726. <code class="phpdocumentor-code phpdocumentor-signature ">
  727. <span class="phpdocumentor-signature__visibility">protected</span>
  728. <span class="phpdocumentor-signature__type"><abbr title="\GdImage">GdImage</abbr></span>
  729. <span class="phpdocumentor-signature__name">$image</span>
  730. </code>
  731. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  732. Tags
  733. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image#tags" class="headerlink"><i class="fas fa-link"></i></a>
  734. </h5>
  735. <dl class="phpdocumentor-tag-list">
  736. <dt class="phpdocumentor-tag-list__entry">
  737. <span class="phpdocumentor-tag__name">see</span>
  738. </dt>
  739. <dd class="phpdocumentor-tag-list__definition">
  740. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\imagecreatetruecolor()">imagecreatetruecolor()</abbr></span>
  741. </dd>
  742. </dl>
  743. </article>
  744. <article
  745. class="
  746. phpdocumentor-element
  747. -property
  748. -protected
  749. "
  750. >
  751. <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
  752. $keepAsSquare
  753. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  754. <span class="phpdocumentor-element__modifiers">
  755. </span>
  756. </h4>
  757. <aside class="phpdocumentor-element-found-in">
  758. <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>
  759. :
  760. <span class="phpdocumentor-element-found-in__line">64</span>
  761. </aside>
  762. <code class="phpdocumentor-code phpdocumentor-signature ">
  763. <span class="phpdocumentor-signature__visibility">protected</span>
  764. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  765. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  766. </code>
  767. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  768. Tags
  769. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare#tags" class="headerlink"><i class="fas fa-link"></i></a>
  770. </h5>
  771. <dl class="phpdocumentor-tag-list">
  772. <dt class="phpdocumentor-tag-list__entry">
  773. <span class="phpdocumentor-tag__name">see</span>
  774. </dt>
  775. <dd class="phpdocumentor-tag-list__definition">
  776. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$keepAsSquare">QROptions::$keepAsSquare</abbr></span>
  777. </dd>
  778. </dl>
  779. </article>
  780. <article
  781. class="
  782. phpdocumentor-element
  783. -property
  784. -protected
  785. "
  786. >
  787. <h4 class="phpdocumentor-element__name" id="property_length">
  788. $length
  789. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  790. <span class="phpdocumentor-element__modifiers">
  791. </span>
  792. </h4>
  793. <aside class="phpdocumentor-element-found-in">
  794. <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>
  795. :
  796. <span class="phpdocumentor-element-found-in__line">34</span>
  797. </aside>
  798. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  799. <code class="phpdocumentor-code phpdocumentor-signature ">
  800. <span class="phpdocumentor-signature__visibility">protected</span>
  801. <span class="phpdocumentor-signature__type">int</span>
  802. <span class="phpdocumentor-signature__name">$length</span>
  803. </code>
  804. </article>
  805. <article
  806. class="
  807. phpdocumentor-element
  808. -property
  809. -protected
  810. "
  811. >
  812. <h4 class="phpdocumentor-element__name" id="property_matrix">
  813. $matrix
  814. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  815. <span class="phpdocumentor-element__modifiers">
  816. </span>
  817. </h4>
  818. <aside class="phpdocumentor-element-found-in">
  819. <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>
  820. :
  821. <span class="phpdocumentor-element-found-in__line">44</span>
  822. </aside>
  823. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  824. <code class="phpdocumentor-code phpdocumentor-signature ">
  825. <span class="phpdocumentor-signature__visibility">protected</span>
  826. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  827. <span class="phpdocumentor-signature__name">$matrix</span>
  828. </code>
  829. </article>
  830. <article
  831. class="
  832. phpdocumentor-element
  833. -property
  834. -protected
  835. "
  836. >
  837. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  838. $moduleCount
  839. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  840. <span class="phpdocumentor-element__modifiers">
  841. </span>
  842. </h4>
  843. <aside class="phpdocumentor-element-found-in">
  844. <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>
  845. :
  846. <span class="phpdocumentor-element-found-in__line">29</span>
  847. </aside>
  848. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  849. <code class="phpdocumentor-code phpdocumentor-signature ">
  850. <span class="phpdocumentor-signature__visibility">protected</span>
  851. <span class="phpdocumentor-signature__type">int</span>
  852. <span class="phpdocumentor-signature__name">$moduleCount</span>
  853. </code>
  854. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  855. Tags
  856. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  857. </h5>
  858. <dl class="phpdocumentor-tag-list">
  859. <dt class="phpdocumentor-tag-list__entry">
  860. <span class="phpdocumentor-tag__name">see</span>
  861. </dt>
  862. <dd class="phpdocumentor-tag-list__definition">
  863. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getSize()">QRMatrix::getSize()</abbr></a></span>
  864. </dd>
  865. </dl>
  866. </article>
  867. <article
  868. class="
  869. phpdocumentor-element
  870. -property
  871. -protected
  872. "
  873. >
  874. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  875. $moduleValues
  876. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  877. <span class="phpdocumentor-element__modifiers">
  878. </span>
  879. </h4>
  880. <aside class="phpdocumentor-element-found-in">
  881. <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>
  882. :
  883. <span class="phpdocumentor-element-found-in__line">39</span>
  884. </aside>
  885. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  886. <code class="phpdocumentor-code phpdocumentor-signature ">
  887. <span class="phpdocumentor-signature__visibility">protected</span>
  888. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  889. <span class="phpdocumentor-signature__name">$moduleValues</span>
  890. </code>
  891. </article>
  892. <article
  893. class="
  894. phpdocumentor-element
  895. -property
  896. -protected
  897. "
  898. >
  899. <h4 class="phpdocumentor-element__name" id="property_options">
  900. $options
  901. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  902. <span class="phpdocumentor-element__modifiers">
  903. </span>
  904. </h4>
  905. <aside class="phpdocumentor-element-found-in">
  906. <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>
  907. :
  908. <span class="phpdocumentor-element-found-in__line">49</span>
  909. </aside>
  910. <p class="phpdocumentor-summary">the options instance</p>
  911. <code class="phpdocumentor-code phpdocumentor-signature ">
  912. <span class="phpdocumentor-signature__visibility">protected</span>
  913. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  914. <span class="phpdocumentor-signature__name">$options</span>
  915. </code>
  916. </article>
  917. <article
  918. class="
  919. phpdocumentor-element
  920. -property
  921. -protected
  922. "
  923. >
  924. <h4 class="phpdocumentor-element__name" id="property_scale">
  925. $scale
  926. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  927. <span class="phpdocumentor-element__modifiers">
  928. </span>
  929. </h4>
  930. <aside class="phpdocumentor-element-found-in">
  931. <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>
  932. :
  933. <span class="phpdocumentor-element-found-in__line">52</span>
  934. </aside>
  935. <code class="phpdocumentor-code phpdocumentor-signature ">
  936. <span class="phpdocumentor-signature__visibility">protected</span>
  937. <span class="phpdocumentor-signature__type">int</span>
  938. <span class="phpdocumentor-signature__name">$scale</span>
  939. </code>
  940. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  941. Tags
  942. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  943. </h5>
  944. <dl class="phpdocumentor-tag-list">
  945. <dt class="phpdocumentor-tag-list__entry">
  946. <span class="phpdocumentor-tag__name">see</span>
  947. </dt>
  948. <dd class="phpdocumentor-tag-list__definition">
  949. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  950. </dd>
  951. </dl>
  952. </article>
  953. <article
  954. class="
  955. phpdocumentor-element
  956. -property
  957. -protected
  958. "
  959. >
  960. <h4 class="phpdocumentor-element__name" id="property_upscaled">
  961. $upscaled
  962. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_upscaled" class="headerlink"><i class="fas fa-link"></i></a>
  963. <span class="phpdocumentor-element__modifiers">
  964. </span>
  965. </h4>
  966. <aside class="phpdocumentor-element-found-in">
  967. <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>
  968. :
  969. <span class="phpdocumentor-element-found-in__line">53</span>
  970. </aside>
  971. <p class="phpdocumentor-summary">Whether we&#039;re running in upscale mode (scale &lt; 20)</p>
  972. <code class="phpdocumentor-code phpdocumentor-signature ">
  973. <span class="phpdocumentor-signature__visibility">protected</span>
  974. <span class="phpdocumentor-signature__type">bool</span>
  975. <span class="phpdocumentor-signature__name">$upscaled</span>
  976. = <span class="phpdocumentor-signature__default-value">false</span></code>
  977. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  978. Tags
  979. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_upscaled#tags" class="headerlink"><i class="fas fa-link"></i></a>
  980. </h5>
  981. <dl class="phpdocumentor-tag-list">
  982. <dt class="phpdocumentor-tag-list__entry">
  983. <span class="phpdocumentor-tag__name">see</span>
  984. </dt>
  985. <dd class="phpdocumentor-tag-list__definition">
  986. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawCircularModules">QROptions::$drawCircularModules</abbr></span>
  987. </dd>
  988. </dl>
  989. </article>
  990. </section>
  991. <section class="phpdocumentor-methods">
  992. <h3 class="phpdocumentor-elements__header" id="methods">
  993. Methods
  994. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  995. </h3>
  996. <article
  997. class="phpdocumentor-element
  998. -method
  999. -public
  1000. "
  1001. >
  1002. <h4 class="phpdocumentor-element__name" id="method___construct">
  1003. __construct()
  1004. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  1005. </h4>
  1006. <aside class="phpdocumentor-element-found-in">
  1007. <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>
  1008. :
  1009. <span class="phpdocumentor-element-found-in__line">61</span>
  1010. </aside>
  1011. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  1012. <code class="phpdocumentor-code phpdocumentor-signature ">
  1013. <span class="phpdocumentor-signature__visibility">public</span>
  1014. <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>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a>&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>
  1015. <div class="phpdocumentor-label-line">
  1016. </div>
  1017. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1018. <dl class="phpdocumentor-argument-list">
  1019. <dt class="phpdocumentor-argument-list__entry">
  1020. <span class="phpdocumentor-signature__argument__name">$options</span>
  1021. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  1022. </dt>
  1023. <dd class="phpdocumentor-argument-list__definition">
  1024. </dd>
  1025. <dt class="phpdocumentor-argument-list__entry">
  1026. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  1027. : <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>
  1028. </dt>
  1029. <dd class="phpdocumentor-argument-list__definition">
  1030. </dd>
  1031. </dl>
  1032. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1033. Tags
  1034. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1035. </h5>
  1036. <dl class="phpdocumentor-tag-list">
  1037. <dt class="phpdocumentor-tag-list__entry">
  1038. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1039. </dt>
  1040. <dd class="phpdocumentor-tag-list__definition">
  1041. </dd>
  1042. <dt class="phpdocumentor-tag-list__entry">
  1043. <span class="phpdocumentor-tag__name">throws</span>
  1044. </dt>
  1045. <dd class="phpdocumentor-tag-list__definition">
  1046. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1047. </dd>
  1048. <dt class="phpdocumentor-tag-list__entry">
  1049. <span class="phpdocumentor-tag__name">noinspection</span>
  1050. </dt>
  1051. <dd class="phpdocumentor-tag-list__definition">
  1052. <section class="phpdocumentor-description"><p>PhpMissingParentConstructorInspection</p>
  1053. </section>
  1054. </dd>
  1055. </dl>
  1056. </article>
  1057. <article
  1058. class="phpdocumentor-element
  1059. -method
  1060. -public
  1061. "
  1062. >
  1063. <h4 class="phpdocumentor-element__name" id="method_dump">
  1064. dump()
  1065. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  1066. </h4>
  1067. <aside class="phpdocumentor-element-found-in">
  1068. <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>
  1069. :
  1070. <span class="phpdocumentor-element-found-in__line">147</span>
  1071. </aside>
  1072. <p class="phpdocumentor-summary">Generates the output, optionally dumps it to a file, and returns it</p>
  1073. <code class="phpdocumentor-code phpdocumentor-signature ">
  1074. <span class="phpdocumentor-signature__visibility">public</span>
  1075. <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|<abbr title="\GdImage">GdImage</abbr></span></code>
  1076. <div class="phpdocumentor-label-line">
  1077. </div>
  1078. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1079. <dl class="phpdocumentor-argument-list">
  1080. <dt class="phpdocumentor-argument-list__entry">
  1081. <span class="phpdocumentor-signature__argument__name">$file</span>
  1082. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1083. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1084. <dd class="phpdocumentor-argument-list__definition">
  1085. </dd>
  1086. </dl>
  1087. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1088. Tags
  1089. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1090. </h5>
  1091. <dl class="phpdocumentor-tag-list">
  1092. <dt class="phpdocumentor-tag-list__entry">
  1093. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1094. </dt>
  1095. <dd class="phpdocumentor-tag-list__definition">
  1096. </dd>
  1097. <dt class="phpdocumentor-tag-list__entry">
  1098. <span class="phpdocumentor-tag__name">throws</span>
  1099. </dt>
  1100. <dd class="phpdocumentor-tag-list__definition">
  1101. <span class="phpdocumentor-tag-link"><abbr title="\ErrorException">ErrorException</abbr></span>
  1102. </dd>
  1103. </dl>
  1104. <section>
  1105. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1106. <span class="phpdocumentor-signature__response_type">string|<abbr title="\GdImage">GdImage</abbr></span>
  1107. </section>
  1108. </article>
  1109. <article
  1110. class="phpdocumentor-element
  1111. -method
  1112. -public
  1113. -static "
  1114. >
  1115. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  1116. moduleValueIsValid()
  1117. <a href="classes/chillerlan-QRCode-Output-RGBArrayModuleValueTrait.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  1118. </h4>
  1119. <aside class="phpdocumentor-element-found-in">
  1120. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/RGBArrayModuleValueTrait.php"><a href="files/src-output-rgbarraymodulevaluetrait.html"><abbr title="src/Output/RGBArrayModuleValueTrait.php">RGBArrayModuleValueTrait.php</abbr></a></abbr>
  1121. :
  1122. <span class="phpdocumentor-element-found-in__line">24</span>
  1123. </aside>
  1124. <code class="phpdocumentor-code phpdocumentor-signature ">
  1125. <span class="phpdocumentor-signature__visibility">public</span>
  1126. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">moduleValueIsValid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1127. <div class="phpdocumentor-label-line">
  1128. </div>
  1129. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1130. <dl class="phpdocumentor-argument-list">
  1131. <dt class="phpdocumentor-argument-list__entry">
  1132. <span class="phpdocumentor-signature__argument__name">$value</span>
  1133. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1134. </dt>
  1135. <dd class="phpdocumentor-argument-list__definition">
  1136. </dd>
  1137. </dl>
  1138. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1139. Tags
  1140. <a href="classes/chillerlan-QRCode-Output-RGBArrayModuleValueTrait.html#method_moduleValueIsValid#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1141. </h5>
  1142. <dl class="phpdocumentor-tag-list">
  1143. <dt class="phpdocumentor-tag-list__entry">
  1144. <span class="phpdocumentor-tag__name">implements</span>
  1145. </dt>
  1146. <dd class="phpdocumentor-tag-list__definition">
  1147. <section class="phpdocumentor-description"><p>\chillerlan\QRCode\Output\QROutputInterface::moduleValueIsValid()</p>
  1148. </section>
  1149. </dd>
  1150. <dt class="phpdocumentor-tag-list__entry">
  1151. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1152. </dt>
  1153. <dd class="phpdocumentor-tag-list__definition">
  1154. </dd>
  1155. </dl>
  1156. <section>
  1157. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1158. <span class="phpdocumentor-signature__response_type">bool</span>
  1159. </section>
  1160. </article>
  1161. <article
  1162. class="phpdocumentor-element
  1163. -method
  1164. -protected
  1165. "
  1166. >
  1167. <h4 class="phpdocumentor-element__name" id="method_checkGD">
  1168. checkGD()
  1169. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_checkGD" class="headerlink"><i class="fas fa-link"></i></a>
  1170. </h4>
  1171. <aside class="phpdocumentor-element-found-in">
  1172. <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>
  1173. :
  1174. <span class="phpdocumentor-element-found-in__line">81</span>
  1175. </aside>
  1176. <p class="phpdocumentor-summary">Checks whether GD is installed and if the given mode is supported</p>
  1177. <code class="phpdocumentor-code phpdocumentor-signature ">
  1178. <span class="phpdocumentor-signature__visibility">protected</span>
  1179. <span class="phpdocumentor-signature__name">checkGD</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1180. <div class="phpdocumentor-label-line">
  1181. </div>
  1182. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1183. Tags
  1184. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_checkGD#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1185. </h5>
  1186. <dl class="phpdocumentor-tag-list">
  1187. <dt class="phpdocumentor-tag-list__entry">
  1188. <span class="phpdocumentor-tag__name">throws</span>
  1189. </dt>
  1190. <dd class="phpdocumentor-tag-list__definition">
  1191. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1192. </dd>
  1193. <dt class="phpdocumentor-tag-list__entry">
  1194. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1195. </dt>
  1196. <dd class="phpdocumentor-tag-list__definition">
  1197. </dd>
  1198. </dl>
  1199. </article>
  1200. <article
  1201. class="phpdocumentor-element
  1202. -method
  1203. -protected
  1204. "
  1205. >
  1206. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  1207. collectModules()
  1208. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  1209. </h4>
  1210. <aside class="phpdocumentor-element-found-in">
  1211. <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>
  1212. :
  1213. <span class="phpdocumentor-element-found-in__line">221</span>
  1214. </aside>
  1215. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  1216. returns an array with the transformed modules</p>
  1217. <code class="phpdocumentor-code phpdocumentor-signature ">
  1218. <span class="phpdocumentor-signature__visibility">protected</span>
  1219. <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>
  1220. <div class="phpdocumentor-label-line">
  1221. </div>
  1222. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  1223. <p>$x - current column
  1224. $y - current row
  1225. $M_TYPE - field value
  1226. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  1227. </section>
  1228. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1229. <dl class="phpdocumentor-argument-list">
  1230. <dt class="phpdocumentor-argument-list__entry">
  1231. <span class="phpdocumentor-signature__argument__name">$transform</span>
  1232. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  1233. </dt>
  1234. <dd class="phpdocumentor-argument-list__definition">
  1235. </dd>
  1236. </dl>
  1237. <section>
  1238. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1239. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1240. </section>
  1241. </article>
  1242. <article
  1243. class="phpdocumentor-element
  1244. -method
  1245. -protected
  1246. "
  1247. >
  1248. <h4 class="phpdocumentor-element__name" id="method_copyVars">
  1249. copyVars()
  1250. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars" class="headerlink"><i class="fas fa-link"></i></a>
  1251. </h4>
  1252. <aside class="phpdocumentor-element-found-in">
  1253. <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>
  1254. :
  1255. <span class="phpdocumentor-element-found-in__line">91</span>
  1256. </aside>
  1257. <p class="phpdocumentor-summary">Creates copies of several QROptions values to avoid calling the magic getters
  1258. in long loops for a significant performance increase.</p>
  1259. <code class="phpdocumentor-code phpdocumentor-signature ">
  1260. <span class="phpdocumentor-signature__visibility">protected</span>
  1261. <span class="phpdocumentor-signature__name">copyVars</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1262. <div class="phpdocumentor-label-line">
  1263. </div>
  1264. <section class="phpdocumentor-description"><p>These variables are usually used in the &quot;module&quot; methods and are called up to 31329 times (at version 40).</p>
  1265. </section>
  1266. </article>
  1267. <article
  1268. class="phpdocumentor-element
  1269. -method
  1270. -protected
  1271. "
  1272. >
  1273. <h4 class="phpdocumentor-element__name" id="method_createImage">
  1274. createImage()
  1275. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_createImage" class="headerlink"><i class="fas fa-link"></i></a>
  1276. </h4>
  1277. <aside class="phpdocumentor-element-found-in">
  1278. <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>
  1279. :
  1280. <span class="phpdocumentor-element-found-in__line">198</span>
  1281. </aside>
  1282. <p class="phpdocumentor-summary">Creates a new GdImage resource and scales it if necessary</p>
  1283. <code class="phpdocumentor-code phpdocumentor-signature ">
  1284. <span class="phpdocumentor-signature__visibility">protected</span>
  1285. <span class="phpdocumentor-signature__name">createImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\GdImage">GdImage</abbr></span></code>
  1286. <div class="phpdocumentor-label-line">
  1287. </div>
  1288. <section class="phpdocumentor-description"><p>we're scaling the image up in order to draw crisp round circles, otherwise they appear square-y on small scales</p>
  1289. </section>
  1290. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1291. Tags
  1292. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_createImage#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1293. </h5>
  1294. <dl class="phpdocumentor-tag-list">
  1295. <dt class="phpdocumentor-tag-list__entry">
  1296. <span class="phpdocumentor-tag__name">see</span>
  1297. </dt>
  1298. <dd class="phpdocumentor-tag-list__definition">
  1299. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/23">https://github.com/chillerlan/php-qrcode/issues/23</a></span>
  1300. </dd>
  1301. </dl>
  1302. <section>
  1303. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1304. <span class="phpdocumentor-signature__response_type"><abbr title="\GdImage">GdImage</abbr></span>
  1305. </section>
  1306. </article>
  1307. <article
  1308. class="phpdocumentor-element
  1309. -method
  1310. -protected
  1311. "
  1312. >
  1313. <h4 class="phpdocumentor-element__name" id="method_drawImage">
  1314. drawImage()
  1315. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_drawImage" class="headerlink"><i class="fas fa-link"></i></a>
  1316. </h4>
  1317. <aside class="phpdocumentor-element-found-in">
  1318. <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>
  1319. :
  1320. <span class="phpdocumentor-element-found-in__line">249</span>
  1321. </aside>
  1322. <p class="phpdocumentor-summary">Draws the QR image</p>
  1323. <code class="phpdocumentor-code phpdocumentor-signature ">
  1324. <span class="phpdocumentor-signature__visibility">protected</span>
  1325. <span class="phpdocumentor-signature__name">drawImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1326. <div class="phpdocumentor-label-line">
  1327. </div>
  1328. </article>
  1329. <article
  1330. class="phpdocumentor-element
  1331. -method
  1332. -protected
  1333. "
  1334. >
  1335. <h4 class="phpdocumentor-element__name" id="method_dumpImage">
  1336. dumpImage()
  1337. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage" class="headerlink"><i class="fas fa-link"></i></a>
  1338. </h4>
  1339. <aside class="phpdocumentor-element-found-in">
  1340. <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>
  1341. :
  1342. <span class="phpdocumentor-element-found-in__line">303</span>
  1343. </aside>
  1344. <p class="phpdocumentor-summary">Creates the final image by calling the desired GD output function</p>
  1345. <code class="phpdocumentor-code phpdocumentor-signature ">
  1346. <span class="phpdocumentor-signature__visibility">protected</span>
  1347. <span class="phpdocumentor-signature__name">dumpImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1348. <div class="phpdocumentor-label-line">
  1349. </div>
  1350. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1351. Tags
  1352. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1353. </h5>
  1354. <dl class="phpdocumentor-tag-list">
  1355. <dt class="phpdocumentor-tag-list__entry">
  1356. <span class="phpdocumentor-tag__name">throws</span>
  1357. </dt>
  1358. <dd class="phpdocumentor-tag-list__definition">
  1359. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1360. </dd>
  1361. </dl>
  1362. <section>
  1363. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1364. <span class="phpdocumentor-signature__response_type">string</span>
  1365. </section>
  1366. </article>
  1367. <article
  1368. class="phpdocumentor-element
  1369. -method
  1370. -protected
  1371. "
  1372. >
  1373. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  1374. getDefaultModuleValue()
  1375. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1376. </h4>
  1377. <aside class="phpdocumentor-element-found-in">
  1378. <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>
  1379. :
  1380. <span class="phpdocumentor-element-found-in__line">138</span>
  1381. </aside>
  1382. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output class)</p>
  1383. <code class="phpdocumentor-code phpdocumentor-signature ">
  1384. <span class="phpdocumentor-signature__visibility">protected</span>
  1385. <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">int</span></code>
  1386. <div class="phpdocumentor-label-line">
  1387. </div>
  1388. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1389. <dl class="phpdocumentor-argument-list">
  1390. <dt class="phpdocumentor-argument-list__entry">
  1391. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  1392. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1393. </dt>
  1394. <dd class="phpdocumentor-argument-list__definition">
  1395. </dd>
  1396. </dl>
  1397. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1398. Tags
  1399. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_getDefaultModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1400. </h5>
  1401. <dl class="phpdocumentor-tag-list">
  1402. <dt class="phpdocumentor-tag-list__entry">
  1403. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1404. </dt>
  1405. <dd class="phpdocumentor-tag-list__definition">
  1406. </dd>
  1407. </dl>
  1408. <section>
  1409. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1410. <span class="phpdocumentor-signature__response_type">int</span>
  1411. </section>
  1412. </article>
  1413. <article
  1414. class="phpdocumentor-element
  1415. -method
  1416. -protected
  1417. "
  1418. >
  1419. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  1420. getModuleValue()
  1421. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1422. </h4>
  1423. <aside class="phpdocumentor-element-found-in">
  1424. <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>
  1425. :
  1426. <span class="phpdocumentor-element-found-in__line">164</span>
  1427. </aside>
  1428. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  1429. <code class="phpdocumentor-code phpdocumentor-signature ">
  1430. <span class="phpdocumentor-signature__visibility">protected</span>
  1431. <span class="phpdocumentor-signature__name">getModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  1432. <div class="phpdocumentor-label-line">
  1433. </div>
  1434. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1435. <dl class="phpdocumentor-argument-list">
  1436. <dt class="phpdocumentor-argument-list__entry">
  1437. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1438. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1439. </dt>
  1440. <dd class="phpdocumentor-argument-list__definition">
  1441. </dd>
  1442. </dl>
  1443. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1444. Tags
  1445. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1446. </h5>
  1447. <dl class="phpdocumentor-tag-list">
  1448. <dt class="phpdocumentor-tag-list__entry">
  1449. <span class="phpdocumentor-tag__name">throws</span>
  1450. </dt>
  1451. <dd class="phpdocumentor-tag-list__definition">
  1452. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1453. <section class="phpdocumentor-description"><p>if $moduleValues[$M_TYPE] doesn't exist</p>
  1454. </section>
  1455. </dd>
  1456. </dl>
  1457. </article>
  1458. <article
  1459. class="phpdocumentor-element
  1460. -method
  1461. -protected
  1462. "
  1463. >
  1464. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  1465. getModuleValueAt()
  1466. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  1467. </h4>
  1468. <aside class="phpdocumentor-element-found-in">
  1469. <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>
  1470. :
  1471. <span class="phpdocumentor-element-found-in__line">176</span>
  1472. </aside>
  1473. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  1474. <code class="phpdocumentor-code phpdocumentor-signature ">
  1475. <span class="phpdocumentor-signature__visibility">protected</span>
  1476. <span class="phpdocumentor-signature__name">getModuleValueAt</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  1477. <div class="phpdocumentor-label-line">
  1478. </div>
  1479. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1480. <dl class="phpdocumentor-argument-list">
  1481. <dt class="phpdocumentor-argument-list__entry">
  1482. <span class="phpdocumentor-signature__argument__name">$x</span>
  1483. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1484. </dt>
  1485. <dd class="phpdocumentor-argument-list__definition">
  1486. </dd>
  1487. <dt class="phpdocumentor-argument-list__entry">
  1488. <span class="phpdocumentor-signature__argument__name">$y</span>
  1489. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1490. </dt>
  1491. <dd class="phpdocumentor-argument-list__definition">
  1492. </dd>
  1493. </dl>
  1494. </article>
  1495. <article
  1496. class="phpdocumentor-element
  1497. -method
  1498. -protected
  1499. "
  1500. >
  1501. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  1502. getOutputDimensions()
  1503. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1504. </h4>
  1505. <aside class="phpdocumentor-element-found-in">
  1506. <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>
  1507. :
  1508. <span class="phpdocumentor-element-found-in__line">126</span>
  1509. </aside>
  1510. <p class="phpdocumentor-summary">Returns a 2 element array with the current output width and height</p>
  1511. <code class="phpdocumentor-code phpdocumentor-signature ">
  1512. <span class="phpdocumentor-signature__visibility">protected</span>
  1513. <span class="phpdocumentor-signature__name">getOutputDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1514. <div class="phpdocumentor-label-line">
  1515. </div>
  1516. <section class="phpdocumentor-description"><p>The type and units of the values depend on the output class. The default value is the current module count * scale.</p>
  1517. </section>
  1518. <section>
  1519. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1520. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1521. </section>
  1522. </article>
  1523. <article
  1524. class="phpdocumentor-element
  1525. -method
  1526. -protected
  1527. "
  1528. >
  1529. <h4 class="phpdocumentor-element__name" id="method_module">
  1530. module()
  1531. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  1532. </h4>
  1533. <aside class="phpdocumentor-element-found-in">
  1534. <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>
  1535. :
  1536. <span class="phpdocumentor-element-found-in__line">260</span>
  1537. </aside>
  1538. <p class="phpdocumentor-summary">Creates a single QR pixel with the given settings</p>
  1539. <code class="phpdocumentor-code phpdocumentor-signature ">
  1540. <span class="phpdocumentor-signature__visibility">protected</span>
  1541. <span class="phpdocumentor-signature__name">module</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>
  1542. <div class="phpdocumentor-label-line">
  1543. </div>
  1544. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1545. <dl class="phpdocumentor-argument-list">
  1546. <dt class="phpdocumentor-argument-list__entry">
  1547. <span class="phpdocumentor-signature__argument__name">$x</span>
  1548. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1549. </dt>
  1550. <dd class="phpdocumentor-argument-list__definition">
  1551. </dd>
  1552. <dt class="phpdocumentor-argument-list__entry">
  1553. <span class="phpdocumentor-signature__argument__name">$y</span>
  1554. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1555. </dt>
  1556. <dd class="phpdocumentor-argument-list__definition">
  1557. </dd>
  1558. <dt class="phpdocumentor-argument-list__entry">
  1559. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1560. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1561. </dt>
  1562. <dd class="phpdocumentor-argument-list__definition">
  1563. </dd>
  1564. </dl>
  1565. </article>
  1566. <article
  1567. class="phpdocumentor-element
  1568. -method
  1569. -protected
  1570. "
  1571. >
  1572. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  1573. prepareModuleValue()
  1574. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1575. </h4>
  1576. <aside class="phpdocumentor-element-found-in">
  1577. <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>
  1578. :
  1579. <span class="phpdocumentor-element-found-in__line">113</span>
  1580. </aside>
  1581. <p class="phpdocumentor-summary">Prepares the value for the given input (return value depends on the output class)</p>
  1582. <code class="phpdocumentor-code phpdocumentor-signature ">
  1583. <span class="phpdocumentor-signature__visibility">protected</span>
  1584. <span class="phpdocumentor-signature__name">prepareModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  1585. <div class="phpdocumentor-label-line">
  1586. </div>
  1587. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1588. <dl class="phpdocumentor-argument-list">
  1589. <dt class="phpdocumentor-argument-list__entry">
  1590. <span class="phpdocumentor-signature__argument__name">$value</span>
  1591. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1592. </dt>
  1593. <dd class="phpdocumentor-argument-list__definition">
  1594. </dd>
  1595. </dl>
  1596. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1597. Tags
  1598. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_prepareModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1599. </h5>
  1600. <dl class="phpdocumentor-tag-list">
  1601. <dt class="phpdocumentor-tag-list__entry">
  1602. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1603. </dt>
  1604. <dd class="phpdocumentor-tag-list__definition">
  1605. </dd>
  1606. <dt class="phpdocumentor-tag-list__entry">
  1607. <span class="phpdocumentor-tag__name">throws</span>
  1608. </dt>
  1609. <dd class="phpdocumentor-tag-list__definition">
  1610. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1611. </dd>
  1612. </dl>
  1613. <section>
  1614. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1615. <span class="phpdocumentor-signature__response_type">int</span>
  1616. </section>
  1617. </article>
  1618. <article
  1619. class="phpdocumentor-element
  1620. -method
  1621. -protected
  1622. "
  1623. >
  1624. <h4 class="phpdocumentor-element__name" id="method_renderImage">
  1625. renderImage()
  1626. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#method_renderImage" class="headerlink"><i class="fas fa-link"></i></a>
  1627. </h4>
  1628. <aside class="phpdocumentor-element-found-in">
  1629. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRGdImageGIF.php"><a href="files/src-output-qrgdimagegif.html"><abbr title="src/Output/QRGdImageGIF.php">QRGdImageGIF.php</abbr></a></abbr>
  1630. :
  1631. <span class="phpdocumentor-element-found-in__line">29</span>
  1632. </aside>
  1633. <p class="phpdocumentor-summary">Renders the image with the gdimage function for the desired output</p>
  1634. <code class="phpdocumentor-code phpdocumentor-signature ">
  1635. <span class="phpdocumentor-signature__visibility">protected</span>
  1636. <span class="phpdocumentor-signature__name">renderImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1637. <div class="phpdocumentor-label-line">
  1638. </div>
  1639. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1640. Tags
  1641. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#method_renderImage#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1642. </h5>
  1643. <dl class="phpdocumentor-tag-list">
  1644. <dt class="phpdocumentor-tag-list__entry">
  1645. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1646. </dt>
  1647. <dd class="phpdocumentor-tag-list__definition">
  1648. </dd>
  1649. </dl>
  1650. </article>
  1651. <article
  1652. class="phpdocumentor-element
  1653. -method
  1654. -protected
  1655. "
  1656. >
  1657. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1658. saveToFile()
  1659. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1660. </h4>
  1661. <aside class="phpdocumentor-element-found-in">
  1662. <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>
  1663. :
  1664. <span class="phpdocumentor-element-found-in__line">195</span>
  1665. </aside>
  1666. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1667. <code class="phpdocumentor-code phpdocumentor-signature ">
  1668. <span class="phpdocumentor-signature__visibility">protected</span>
  1669. <span class="phpdocumentor-signature__name">saveToFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1670. <div class="phpdocumentor-label-line">
  1671. </div>
  1672. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1673. <dl class="phpdocumentor-argument-list">
  1674. <dt class="phpdocumentor-argument-list__entry">
  1675. <span class="phpdocumentor-signature__argument__name">$data</span>
  1676. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1677. </dt>
  1678. <dd class="phpdocumentor-argument-list__definition">
  1679. </dd>
  1680. <dt class="phpdocumentor-argument-list__entry">
  1681. <span class="phpdocumentor-signature__argument__name">$file</span>
  1682. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1683. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1684. <dd class="phpdocumentor-argument-list__definition">
  1685. </dd>
  1686. </dl>
  1687. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1688. Tags
  1689. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1690. </h5>
  1691. <dl class="phpdocumentor-tag-list">
  1692. <dt class="phpdocumentor-tag-list__entry">
  1693. <span class="phpdocumentor-tag__name">see</span>
  1694. </dt>
  1695. <dd class="phpdocumentor-tag-list__definition">
  1696. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1697. </dd>
  1698. <dt class="phpdocumentor-tag-list__entry">
  1699. <span class="phpdocumentor-tag__name">see</span>
  1700. </dt>
  1701. <dd class="phpdocumentor-tag-list__definition">
  1702. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1703. </dd>
  1704. <dt class="phpdocumentor-tag-list__entry">
  1705. <span class="phpdocumentor-tag__name">throws</span>
  1706. </dt>
  1707. <dd class="phpdocumentor-tag-list__definition">
  1708. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1709. </dd>
  1710. </dl>
  1711. </article>
  1712. <article
  1713. class="phpdocumentor-element
  1714. -method
  1715. -protected
  1716. "
  1717. >
  1718. <h4 class="phpdocumentor-element__name" id="method_setBgColor">
  1719. setBgColor()
  1720. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setBgColor" class="headerlink"><i class="fas fa-link"></i></a>
  1721. </h4>
  1722. <aside class="phpdocumentor-element-found-in">
  1723. <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>
  1724. :
  1725. <span class="phpdocumentor-element-found-in__line">213</span>
  1726. </aside>
  1727. <p class="phpdocumentor-summary">Sets the background color</p>
  1728. <code class="phpdocumentor-code phpdocumentor-signature ">
  1729. <span class="phpdocumentor-signature__visibility">protected</span>
  1730. <span class="phpdocumentor-signature__name">setBgColor</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1731. <div class="phpdocumentor-label-line">
  1732. </div>
  1733. </article>
  1734. <article
  1735. class="phpdocumentor-element
  1736. -method
  1737. -protected
  1738. "
  1739. >
  1740. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1741. setMatrixDimensions()
  1742. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1743. </h4>
  1744. <aside class="phpdocumentor-element-found-in">
  1745. <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>
  1746. :
  1747. <span class="phpdocumentor-element-found-in__line">115</span>
  1748. </aside>
  1749. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1750. <code class="phpdocumentor-code phpdocumentor-signature ">
  1751. <span class="phpdocumentor-signature__visibility">protected</span>
  1752. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1753. <div class="phpdocumentor-label-line">
  1754. </div>
  1755. <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>
  1756. </section>
  1757. </article>
  1758. <article
  1759. class="phpdocumentor-element
  1760. -method
  1761. -protected
  1762. "
  1763. >
  1764. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1765. setModuleValues()
  1766. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1767. </h4>
  1768. <aside class="phpdocumentor-element-found-in">
  1769. <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>
  1770. :
  1771. <span class="phpdocumentor-element-found-in__line">133</span>
  1772. </aside>
  1773. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1774. <code class="phpdocumentor-code phpdocumentor-signature ">
  1775. <span class="phpdocumentor-signature__visibility">protected</span>
  1776. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1777. <div class="phpdocumentor-label-line">
  1778. </div>
  1779. </article>
  1780. <article
  1781. class="phpdocumentor-element
  1782. -method
  1783. -protected
  1784. "
  1785. >
  1786. <h4 class="phpdocumentor-element__name" id="method_setTransparencyColor">
  1787. setTransparencyColor()
  1788. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setTransparencyColor" class="headerlink"><i class="fas fa-link"></i></a>
  1789. </h4>
  1790. <aside class="phpdocumentor-element-found-in">
  1791. <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>
  1792. :
  1793. <span class="phpdocumentor-element-found-in__line">231</span>
  1794. </aside>
  1795. <p class="phpdocumentor-summary">Sets the transparency color</p>
  1796. <code class="phpdocumentor-code phpdocumentor-signature ">
  1797. <span class="phpdocumentor-signature__visibility">protected</span>
  1798. <span class="phpdocumentor-signature__name">setTransparencyColor</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1799. <div class="phpdocumentor-label-line">
  1800. </div>
  1801. </article>
  1802. <article
  1803. class="phpdocumentor-element
  1804. -method
  1805. -protected
  1806. "
  1807. >
  1808. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1809. toBase64DataURI()
  1810. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1811. </h4>
  1812. <aside class="phpdocumentor-element-found-in">
  1813. <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>
  1814. :
  1815. <span class="phpdocumentor-element-found-in__line">183</span>
  1816. </aside>
  1817. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1818. <code class="phpdocumentor-code phpdocumentor-signature ">
  1819. <span class="phpdocumentor-signature__visibility">protected</span>
  1820. <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>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</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</span></code>
  1821. <div class="phpdocumentor-label-line">
  1822. </div>
  1823. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1824. <dl class="phpdocumentor-argument-list">
  1825. <dt class="phpdocumentor-argument-list__entry">
  1826. <span class="phpdocumentor-signature__argument__name">$data</span>
  1827. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1828. </dt>
  1829. <dd class="phpdocumentor-argument-list__definition">
  1830. </dd>
  1831. <dt class="phpdocumentor-argument-list__entry">
  1832. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1833. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1834. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1835. <dd class="phpdocumentor-argument-list__definition">
  1836. </dd>
  1837. </dl>
  1838. <section>
  1839. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1840. <span class="phpdocumentor-signature__response_type">string</span>
  1841. </section>
  1842. </article>
  1843. </section>
  1844. <div class="phpdocumentor-modal" id="source-view">
  1845. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1846. <div class="phpdocumentor-modal-container">
  1847. <div class="phpdocumentor-modal-content">
  1848. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Output/QRGdImageGIF.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  1849. </div>
  1850. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1851. </div>
  1852. </div>
  1853. <script type="text/javascript">
  1854. (function () {
  1855. function loadExternalCodeSnippet(el, url, line) {
  1856. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1857. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1858. const language = 'php';
  1859. const code = document.createElement('code');
  1860. code.className = 'language-' + language;
  1861. pre.textContent = '';
  1862. pre.setAttribute('data-line', line)
  1863. code.textContent = 'Loading…';
  1864. pre.appendChild(code);
  1865. var xhr = new XMLHttpRequest();
  1866. xhr.open('GET', src, true);
  1867. xhr.onreadystatechange = function () {
  1868. if (xhr.readyState !== 4) {
  1869. return;
  1870. }
  1871. if (xhr.status < 400 && xhr.responseText) {
  1872. code.textContent = xhr.responseText;
  1873. Prism.highlightElement(code);
  1874. return;
  1875. }
  1876. if (xhr.status === 404) {
  1877. code.textContent = '✖ Error: File could not be found';
  1878. return;
  1879. }
  1880. if (xhr.status >= 400) {
  1881. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1882. return;
  1883. }
  1884. code.textContent = '✖ Error: An unknown error occurred';
  1885. };
  1886. xhr.send(null);
  1887. });
  1888. }
  1889. const modalButtons = document.querySelectorAll("[data-modal]");
  1890. const openedAsLocalFile = window.location.protocol === 'file:';
  1891. if (modalButtons.length > 0 && openedAsLocalFile) {
  1892. console.warn(
  1893. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1894. 'browsers block XHR requests when a page is opened this way'
  1895. );
  1896. }
  1897. modalButtons.forEach(function (trigger) {
  1898. if (openedAsLocalFile) {
  1899. trigger.setAttribute("hidden", "hidden");
  1900. }
  1901. trigger.addEventListener("click", function (event) {
  1902. event.preventDefault();
  1903. const modal = document.getElementById(trigger.dataset.modal);
  1904. if (!modal) {
  1905. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1906. return;
  1907. }
  1908. modal.classList.add("phpdocumentor-modal__open");
  1909. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1910. const exits = modal.querySelectorAll("[data-exit-button]");
  1911. exits.forEach(function (exit) {
  1912. exit.addEventListener("click", function (event) {
  1913. event.preventDefault();
  1914. modal.classList.remove("phpdocumentor-modal__open");
  1915. });
  1916. });
  1917. });
  1918. });
  1919. })();
  1920. </script>
  1921. </article>
  1922. </section>
  1923. <section class="phpdocumentor-on-this-page__sidebar">
  1924. <section class="phpdocumentor-on-this-page__content">
  1925. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1926. <ul class="phpdocumentor-list -clean">
  1927. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1928. <li>
  1929. <ul class="phpdocumentor-list -clean">
  1930. <li><a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#toc-constants">Constants</a></li>
  1931. <li><a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#toc-properties">Properties</a></li>
  1932. <li><a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#toc-methods">Methods</a></li>
  1933. </ul>
  1934. </li>
  1935. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  1936. <li>
  1937. <ul class="phpdocumentor-list -clean">
  1938. <li><a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#constant_MIME_TYPE">MIME_TYPE</a></li>
  1939. </ul>
  1940. </li>
  1941. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1942. <li>
  1943. <ul class="phpdocumentor-list -clean">
  1944. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_background">$background<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1945. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1946. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1947. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1948. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1949. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1950. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1951. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1952. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image">$image<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1953. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1954. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1955. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1956. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1957. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1958. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1959. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1960. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_upscaled">$upscaled<a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html"></li>
  1961. </ul>
  1962. </li>
  1963. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1964. <li>
  1965. <ul class="phpdocumentor-list -clean">
  1966. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method___construct">__construct()</a></li>
  1967. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump">dump()</a></li>
  1968. <li><a href="classes/chillerlan-QRCode-Output-RGBArrayModuleValueTrait.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  1969. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_checkGD">checkGD()</a></li>
  1970. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1971. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a></li>
  1972. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_createImage">createImage()</a></li>
  1973. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_drawImage">drawImage()</a></li>
  1974. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage">dumpImage()</a></li>
  1975. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1976. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1977. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1978. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1979. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_module">module()</a></li>
  1980. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1981. <li><a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#method_renderImage">renderImage()</a></li>
  1982. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1983. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setBgColor">setBgColor()</a></li>
  1984. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1985. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1986. <li><a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setTransparencyColor">setTransparencyColor()</a></li>
  1987. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1988. </ul>
  1989. </li>
  1990. </ul>
  1991. </section>
  1992. </section>
  1993. </div>
  1994. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1995. <section class="phpdocumentor-search-results__dialog">
  1996. <header class="phpdocumentor-search-results__header">
  1997. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1998. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1999. </header>
  2000. <section class="phpdocumentor-search-results__body">
  2001. <ul class="phpdocumentor-search-results__entries"></ul>
  2002. </section>
  2003. </section>
  2004. </section>
  2005. </div>
  2006. <a href="classes/chillerlan-QRCode-Output-QRGdImageGIF.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  2007. </main>
  2008. <script>
  2009. cssVars({});
  2010. </script>
  2011. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  2012. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  2013. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  2014. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  2015. </body>
  2016. </html>