chillerlan-QRCode-Output-QRGdImage.html 128 KB

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