chillerlan-QRCode-Output-QRGdImage.html 132 KB

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