chillerlan-QRCode-Output-QRGdImageBMP.html 132 KB

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