chillerlan-QRCode-Output-QRGdImageJPEG.html 139 KB

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