chillerlan-QRCode-Output-QRGdImageBMP.html 129 KB

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