chillerlan-QRCode-Output-QRGdImage.html 129 KB

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