chillerlan-QRCode-Output-QRImage.html 116 KB

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