chillerlan-QRCode-Output-QRGdImage.html 137 KB

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