chillerlan-QRCode-Output-QRImage.html 78 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652
  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=Source+Sans+Pro:wght@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/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. QRImage
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Output-QRGdImage.html"><abbr title="\chillerlan\QRCode\Output\QRGdImage">QRGdImage</abbr></a>
  95. </span>
  96. <div class="phpdocumentor-element__package">
  97. in package
  98. <ul class="phpdocumentor-breadcrumbs">
  99. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  100. </ul>
  101. </div>
  102. </h2>
  103. <aside class="phpdocumentor-element-found-in">
  104. <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>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">17</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">Converts the matrix into GD images, raw or base64 output (requires ext-gd)</p>
  109. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  110. Tags
  111. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  112. </h5>
  113. <dl class="phpdocumentor-tag-list">
  114. <dt class="phpdocumentor-tag-list__entry">
  115. <span class="phpdocumentor-tag__name">deprecated</span>
  116. </dt>
  117. <dd class="phpdocumentor-tag-list__definition">
  118. <span class="phpdocumentor-tag-link">5.0.0</span>
  119. <section class="phpdocumentor-description"><p>backward compatibility, use QRGdImage instead</p>
  120. </section>
  121. </dd>
  122. <dt class="phpdocumentor-tag-list__entry">
  123. <span class="phpdocumentor-tag__name">see</span>
  124. </dt>
  125. <dd class="phpdocumentor-tag-list__definition">
  126. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRGdImage.html"><abbr title="\chillerlan\QRCode\Output\QRGdImage">QRGdImage</abbr></a></span>
  127. </dd>
  128. </dl>
  129. <h3 id="toc">
  130. Table of Contents
  131. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  132. </h3>
  133. <dl class="phpdocumentor-table-of-contents">
  134. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  135. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_background">$background</a>
  136. <span>
  137. &nbsp;: int </span>
  138. </dt>
  139. <dd>The allocated background color</dd>
  140. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  141. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image">$image</a>
  142. <span>
  143. &nbsp;: resource|<abbr title="\GdImage">GdImage</abbr> </span>
  144. </dt>
  145. <dd>The GD image resource</dd>
  146. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  147. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  148. <span>
  149. &nbsp;: int </span>
  150. </dt>
  151. <dd>the side length of the QR image (modules * scale)</dd>
  152. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  153. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  154. <span>
  155. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  156. </dt>
  157. <dd>the (filled) data matrix object</dd>
  158. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  159. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  160. <span>
  161. &nbsp;: int </span>
  162. </dt>
  163. <dd>the current size of the QR matrix</dd>
  164. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  165. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  166. <span>
  167. &nbsp;: array&lt;string|int, mixed&gt; </span>
  168. </dt>
  169. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  170. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  171. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  172. <span>
  173. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  174. </dt>
  175. <dd></dd>
  176. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  177. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  178. <span>
  179. &nbsp;: int </span>
  180. </dt>
  181. <dd>the current scaling for a QR pixel</dd>
  182. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  183. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_upscaled">$upscaled</a>
  184. <span>
  185. &nbsp;: bool </span>
  186. </dt>
  187. <dd>Whether we&#039;re running in upscale mode (scale &lt; 20)</dd>
  188. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  189. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  190. <span>
  191. &nbsp;: mixed </span>
  192. </dt>
  193. <dd>QROutputAbstract constructor.</dd>
  194. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  195. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump">dump()</a>
  196. <span>
  197. &nbsp;: string|resource|<abbr title="\GdImage">GdImage</abbr> </span>
  198. </dt>
  199. <dd></dd>
  200. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  201. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  202. <span>
  203. &nbsp;: bool </span>
  204. </dt>
  205. <dd></dd>
  206. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  207. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  208. <span>
  209. &nbsp;: array&lt;string|int, mixed&gt; </span>
  210. </dt>
  211. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  212. returns an array with the transformed modules</dd>
  213. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  214. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_drawImage">drawImage()</a>
  215. <span>
  216. &nbsp;: void </span>
  217. </dt>
  218. <dd>Creates the QR image</dd>
  219. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  220. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage">dumpImage()</a>
  221. <span>
  222. &nbsp;: string </span>
  223. </dt>
  224. <dd>Creates the final image by calling the desired GD output function</dd>
  225. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  226. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  227. <span>
  228. &nbsp;: mixed|null </span>
  229. </dt>
  230. <dd>Returns a default value for either dark or light modules</dd>
  231. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  232. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  233. <span>
  234. &nbsp;: mixed|null </span>
  235. </dt>
  236. <dd>Returns the prepared value for the given $M_TYPE</dd>
  237. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  238. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  239. <span>
  240. &nbsp;: mixed|null </span>
  241. </dt>
  242. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  243. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  244. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a>
  245. <span>
  246. &nbsp;: mixed|null </span>
  247. </dt>
  248. <dd>Prepares the value for the given input ()</dd>
  249. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  250. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  251. <span>
  252. &nbsp;: void </span>
  253. </dt>
  254. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  255. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  256. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setBgColor">setBgColor()</a>
  257. <span>
  258. &nbsp;: void </span>
  259. </dt>
  260. <dd>Sets the background color</dd>
  261. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  262. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  263. <span>
  264. &nbsp;: void </span>
  265. </dt>
  266. <dd>Sets/updates the matrix dimensions</dd>
  267. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  268. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  269. <span>
  270. &nbsp;: void </span>
  271. </dt>
  272. <dd>Sets the initial module values</dd>
  273. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  274. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setPixel">setPixel()</a>
  275. <span>
  276. &nbsp;: void </span>
  277. </dt>
  278. <dd>Creates a single QR pixel with the given settings</dd>
  279. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  280. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setTransparencyColor">setTransparencyColor()</a>
  281. <span>
  282. &nbsp;: void </span>
  283. </dt>
  284. <dd>Sets the transparency color</dd>
  285. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  286. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  287. <span>
  288. &nbsp;: string </span>
  289. </dt>
  290. <dd>Returns a base64 data URI for the given string and mime type</dd>
  291. </dl>
  292. <section class="phpdocumentor-properties">
  293. <h3 class="phpdocumentor-elements__header" id="properties">
  294. Properties
  295. <a href="classes/chillerlan-QRCode-Output-QRImage.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  296. </h3>
  297. <article
  298. class="
  299. phpdocumentor-element
  300. -property
  301. -protected
  302. "
  303. >
  304. <h4 class="phpdocumentor-element__name" id="property_background">
  305. $background
  306. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_background" class="headerlink"><i class="fas fa-link"></i></a>
  307. <span class="phpdocumentor-element__modifiers">
  308. </span>
  309. </h4>
  310. <aside class="phpdocumentor-element-found-in">
  311. <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>
  312. :
  313. <span class="phpdocumentor-element-found-in__line">42</span>
  314. </aside>
  315. <p class="phpdocumentor-summary">The allocated background color</p>
  316. <code class="phpdocumentor-code phpdocumentor-signature ">
  317. <span class="phpdocumentor-signature__visibility">protected</span>
  318. <span class="phpdocumentor-signature__type">int</span>
  319. <span class="phpdocumentor-signature__name">$background</span>
  320. </code>
  321. <section class="phpdocumentor-description"></section>
  322. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  323. Tags
  324. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  325. </h5>
  326. <dl class="phpdocumentor-tag-list">
  327. <dt class="phpdocumentor-tag-list__entry">
  328. <span class="phpdocumentor-tag__name">see</span>
  329. </dt>
  330. <dd class="phpdocumentor-tag-list__definition">
  331. <span class="phpdocumentor-tag-link"><abbr title="\imagecolorallocate()">imagecolorallocate()</abbr></span>
  332. </dd>
  333. </dl>
  334. </article>
  335. <article
  336. class="
  337. phpdocumentor-element
  338. -property
  339. -protected
  340. "
  341. >
  342. <h4 class="phpdocumentor-element__name" id="property_image">
  343. $image
  344. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image" class="headerlink"><i class="fas fa-link"></i></a>
  345. <span class="phpdocumentor-element__modifiers">
  346. </span>
  347. </h4>
  348. <aside class="phpdocumentor-element-found-in">
  349. <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>
  350. :
  351. <span class="phpdocumentor-element-found-in__line">35</span>
  352. </aside>
  353. <p class="phpdocumentor-summary">The GD image resource</p>
  354. <code class="phpdocumentor-code phpdocumentor-signature ">
  355. <span class="phpdocumentor-signature__visibility">protected</span>
  356. <span class="phpdocumentor-signature__type">resource|<abbr title="\GdImage">GdImage</abbr></span>
  357. <span class="phpdocumentor-signature__name">$image</span>
  358. </code>
  359. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  360. Tags
  361. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  362. </h5>
  363. <dl class="phpdocumentor-tag-list">
  364. <dt class="phpdocumentor-tag-list__entry">
  365. <span class="phpdocumentor-tag__name">see</span>
  366. </dt>
  367. <dd class="phpdocumentor-tag-list__definition">
  368. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\imagecreatetruecolor()">imagecreatetruecolor()</abbr></span>
  369. </dd>
  370. </dl>
  371. </article>
  372. <article
  373. class="
  374. phpdocumentor-element
  375. -property
  376. -protected
  377. "
  378. >
  379. <h4 class="phpdocumentor-element__name" id="property_length">
  380. $length
  381. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  382. <span class="phpdocumentor-element__modifiers">
  383. </span>
  384. </h4>
  385. <aside class="phpdocumentor-element-found-in">
  386. <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>
  387. :
  388. <span class="phpdocumentor-element-found-in__line">40</span>
  389. </aside>
  390. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  391. <code class="phpdocumentor-code phpdocumentor-signature ">
  392. <span class="phpdocumentor-signature__visibility">protected</span>
  393. <span class="phpdocumentor-signature__type">int</span>
  394. <span class="phpdocumentor-signature__name">$length</span>
  395. </code>
  396. <section class="phpdocumentor-description"></section>
  397. </article>
  398. <article
  399. class="
  400. phpdocumentor-element
  401. -property
  402. -protected
  403. "
  404. >
  405. <h4 class="phpdocumentor-element__name" id="property_matrix">
  406. $matrix
  407. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  408. <span class="phpdocumentor-element__modifiers">
  409. </span>
  410. </h4>
  411. <aside class="phpdocumentor-element-found-in">
  412. <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>
  413. :
  414. <span class="phpdocumentor-element-found-in__line">50</span>
  415. </aside>
  416. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  417. <code class="phpdocumentor-code phpdocumentor-signature ">
  418. <span class="phpdocumentor-signature__visibility">protected</span>
  419. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  420. <span class="phpdocumentor-signature__name">$matrix</span>
  421. </code>
  422. <section class="phpdocumentor-description"></section>
  423. </article>
  424. <article
  425. class="
  426. phpdocumentor-element
  427. -property
  428. -protected
  429. "
  430. >
  431. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  432. $moduleCount
  433. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  434. <span class="phpdocumentor-element__modifiers">
  435. </span>
  436. </h4>
  437. <aside class="phpdocumentor-element-found-in">
  438. <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>
  439. :
  440. <span class="phpdocumentor-element-found-in__line">28</span>
  441. </aside>
  442. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  443. <code class="phpdocumentor-code phpdocumentor-signature ">
  444. <span class="phpdocumentor-signature__visibility">protected</span>
  445. <span class="phpdocumentor-signature__type">int</span>
  446. <span class="phpdocumentor-signature__name">$moduleCount</span>
  447. </code>
  448. <section class="phpdocumentor-description"></section>
  449. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  450. Tags
  451. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  452. </h5>
  453. <dl class="phpdocumentor-tag-list">
  454. <dt class="phpdocumentor-tag-list__entry">
  455. <span class="phpdocumentor-tag__name">see</span>
  456. </dt>
  457. <dd class="phpdocumentor-tag-list__definition">
  458. <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>
  459. </dd>
  460. </dl>
  461. </article>
  462. <article
  463. class="
  464. phpdocumentor-element
  465. -property
  466. -protected
  467. "
  468. >
  469. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  470. $moduleValues
  471. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  472. <span class="phpdocumentor-element__modifiers">
  473. </span>
  474. </h4>
  475. <aside class="phpdocumentor-element-found-in">
  476. <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>
  477. :
  478. <span class="phpdocumentor-element-found-in__line">45</span>
  479. </aside>
  480. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  481. <code class="phpdocumentor-code phpdocumentor-signature ">
  482. <span class="phpdocumentor-signature__visibility">protected</span>
  483. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  484. <span class="phpdocumentor-signature__name">$moduleValues</span>
  485. </code>
  486. <section class="phpdocumentor-description"></section>
  487. </article>
  488. <article
  489. class="
  490. phpdocumentor-element
  491. -property
  492. -protected
  493. "
  494. >
  495. <h4 class="phpdocumentor-element__name" id="property_options">
  496. $options
  497. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  498. <span class="phpdocumentor-element__modifiers">
  499. </span>
  500. </h4>
  501. <aside class="phpdocumentor-element-found-in">
  502. <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>
  503. :
  504. <span class="phpdocumentor-element-found-in__line">55</span>
  505. </aside>
  506. <code class="phpdocumentor-code phpdocumentor-signature ">
  507. <span class="phpdocumentor-signature__visibility">protected</span>
  508. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  509. <span class="phpdocumentor-signature__name">$options</span>
  510. </code>
  511. </article>
  512. <article
  513. class="
  514. phpdocumentor-element
  515. -property
  516. -protected
  517. "
  518. >
  519. <h4 class="phpdocumentor-element__name" id="property_scale">
  520. $scale
  521. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  522. <span class="phpdocumentor-element__modifiers">
  523. </span>
  524. </h4>
  525. <aside class="phpdocumentor-element-found-in">
  526. <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>
  527. :
  528. <span class="phpdocumentor-element-found-in__line">35</span>
  529. </aside>
  530. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  531. <code class="phpdocumentor-code phpdocumentor-signature ">
  532. <span class="phpdocumentor-signature__visibility">protected</span>
  533. <span class="phpdocumentor-signature__type">int</span>
  534. <span class="phpdocumentor-signature__name">$scale</span>
  535. </code>
  536. <section class="phpdocumentor-description"></section>
  537. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  538. Tags
  539. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  540. </h5>
  541. <dl class="phpdocumentor-tag-list">
  542. <dt class="phpdocumentor-tag-list__entry">
  543. <span class="phpdocumentor-tag__name">see</span>
  544. </dt>
  545. <dd class="phpdocumentor-tag-list__definition">
  546. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  547. </dd>
  548. </dl>
  549. </article>
  550. <article
  551. class="
  552. phpdocumentor-element
  553. -property
  554. -protected
  555. "
  556. >
  557. <h4 class="phpdocumentor-element__name" id="property_upscaled">
  558. $upscaled
  559. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_upscaled" class="headerlink"><i class="fas fa-link"></i></a>
  560. <span class="phpdocumentor-element__modifiers">
  561. </span>
  562. </h4>
  563. <aside class="phpdocumentor-element-found-in">
  564. <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>
  565. :
  566. <span class="phpdocumentor-element-found-in__line">49</span>
  567. </aside>
  568. <p class="phpdocumentor-summary">Whether we&#039;re running in upscale mode (scale &lt; 20)</p>
  569. <code class="phpdocumentor-code phpdocumentor-signature ">
  570. <span class="phpdocumentor-signature__visibility">protected</span>
  571. <span class="phpdocumentor-signature__type">bool</span>
  572. <span class="phpdocumentor-signature__name">$upscaled</span>
  573. = <span class="phpdocumentor-signature__default-value">false</span></code>
  574. <section class="phpdocumentor-description"></section>
  575. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  576. Tags
  577. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  578. </h5>
  579. <dl class="phpdocumentor-tag-list">
  580. <dt class="phpdocumentor-tag-list__entry">
  581. <span class="phpdocumentor-tag__name">see</span>
  582. </dt>
  583. <dd class="phpdocumentor-tag-list__definition">
  584. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawCircularModules">QROptions::$drawCircularModules</abbr></span>
  585. </dd>
  586. </dl>
  587. </article>
  588. </section>
  589. <section class="phpdocumentor-methods">
  590. <h3 class="phpdocumentor-elements__header" id="methods">
  591. Methods
  592. <a href="classes/chillerlan-QRCode-Output-QRImage.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  593. </h3>
  594. <article
  595. class="phpdocumentor-element
  596. -method
  597. -public
  598. "
  599. >
  600. <h4 class="phpdocumentor-element__name" id="method___construct">
  601. __construct()
  602. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  603. </h4>
  604. <aside class="phpdocumentor-element-found-in">
  605. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  606. :
  607. <span class="phpdocumentor-element-found-in__line">60</span>
  608. </aside>
  609. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  610. <code class="phpdocumentor-code phpdocumentor-signature ">
  611. <span class="phpdocumentor-signature__visibility">public</span>
  612. <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>
  613. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  614. <dl class="phpdocumentor-argument-list">
  615. <dt class="phpdocumentor-argument-list__entry">
  616. <span class="phpdocumentor-signature__argument__name">$options</span>
  617. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  618. </dt>
  619. <dd class="phpdocumentor-argument-list__definition">
  620. <section class="phpdocumentor-description"></section>
  621. </dd>
  622. <dt class="phpdocumentor-argument-list__entry">
  623. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  624. : <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>
  625. </dt>
  626. <dd class="phpdocumentor-argument-list__definition">
  627. <section class="phpdocumentor-description"></section>
  628. </dd>
  629. </dl>
  630. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  631. <span class="phpdocumentor-signature__response_type">mixed</span>
  632. &mdash;
  633. </article>
  634. <article
  635. class="phpdocumentor-element
  636. -method
  637. -public
  638. "
  639. >
  640. <h4 class="phpdocumentor-element__name" id="method_dump">
  641. dump()
  642. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  643. </h4>
  644. <aside class="phpdocumentor-element-found-in">
  645. <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>
  646. :
  647. <span class="phpdocumentor-element-found-in__line">150</span>
  648. </aside>
  649. <code class="phpdocumentor-code phpdocumentor-signature ">
  650. <span class="phpdocumentor-signature__visibility">public</span>
  651. <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>
  652. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  653. <dl class="phpdocumentor-argument-list">
  654. <dt class="phpdocumentor-argument-list__entry">
  655. <span class="phpdocumentor-signature__argument__name">$file</span>
  656. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  657. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  658. <dd class="phpdocumentor-argument-list__definition">
  659. <section class="phpdocumentor-description"></section>
  660. </dd>
  661. </dl>
  662. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  663. Tags
  664. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  665. </h5>
  666. <dl class="phpdocumentor-tag-list">
  667. <dt class="phpdocumentor-tag-list__entry">
  668. <span class="phpdocumentor-tag__name">inheritDoc</span>
  669. </dt>
  670. <dd class="phpdocumentor-tag-list__definition">
  671. </dd>
  672. <dt class="phpdocumentor-tag-list__entry">
  673. <span class="phpdocumentor-tag__name">phan-suppress</span>
  674. </dt>
  675. <dd class="phpdocumentor-tag-list__definition">
  676. <section class="phpdocumentor-description"><p>PhanUndeclaredTypeReturnType, PhanTypeMismatchReturn</p>
  677. </section>
  678. </dd>
  679. <dt class="phpdocumentor-tag-list__entry">
  680. <span class="phpdocumentor-tag__name">throws</span>
  681. </dt>
  682. <dd class="phpdocumentor-tag-list__definition">
  683. <span class="phpdocumentor-tag-link"><abbr title="\ErrorException">ErrorException</abbr></span>
  684. </dd>
  685. </dl>
  686. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  687. <span class="phpdocumentor-signature__response_type">string|resource|<abbr title="\GdImage">GdImage</abbr></span>
  688. &mdash;
  689. </article>
  690. <article
  691. class="phpdocumentor-element
  692. -method
  693. -public
  694. -static "
  695. >
  696. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  697. moduleValueIsValid()
  698. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  699. </h4>
  700. <aside class="phpdocumentor-element-found-in">
  701. <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>
  702. :
  703. <span class="phpdocumentor-element-found-in__line">85</span>
  704. </aside>
  705. <code class="phpdocumentor-code phpdocumentor-signature ">
  706. <span class="phpdocumentor-signature__visibility">public</span>
  707. <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>
  708. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  709. <dl class="phpdocumentor-argument-list">
  710. <dt class="phpdocumentor-argument-list__entry">
  711. <span class="phpdocumentor-signature__argument__name">$value</span>
  712. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  713. </dt>
  714. <dd class="phpdocumentor-argument-list__definition">
  715. <section class="phpdocumentor-description"></section>
  716. </dd>
  717. </dl>
  718. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  719. Tags
  720. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  721. </h5>
  722. <dl class="phpdocumentor-tag-list">
  723. <dt class="phpdocumentor-tag-list__entry">
  724. <span class="phpdocumentor-tag__name">inheritDoc</span>
  725. </dt>
  726. <dd class="phpdocumentor-tag-list__definition">
  727. </dd>
  728. </dl>
  729. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  730. <span class="phpdocumentor-signature__response_type">bool</span>
  731. &mdash;
  732. </article>
  733. <article
  734. class="phpdocumentor-element
  735. -method
  736. -protected
  737. "
  738. >
  739. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  740. collectModules()
  741. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  742. </h4>
  743. <aside class="phpdocumentor-element-found-in">
  744. <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>
  745. :
  746. <span class="phpdocumentor-element-found-in__line">169</span>
  747. </aside>
  748. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  749. returns an array with the transformed modules</p>
  750. <code class="phpdocumentor-code phpdocumentor-signature ">
  751. <span class="phpdocumentor-signature__visibility">protected</span>
  752. <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>
  753. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  754. <p>$x - current column
  755. $y - current row
  756. $M_TYPE - field value
  757. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  758. </section>
  759. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  760. <dl class="phpdocumentor-argument-list">
  761. <dt class="phpdocumentor-argument-list__entry">
  762. <span class="phpdocumentor-signature__argument__name">$transform</span>
  763. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  764. </dt>
  765. <dd class="phpdocumentor-argument-list__definition">
  766. <section class="phpdocumentor-description"></section>
  767. </dd>
  768. </dl>
  769. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  770. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  771. &mdash;
  772. </article>
  773. <article
  774. class="phpdocumentor-element
  775. -method
  776. -protected
  777. "
  778. >
  779. <h4 class="phpdocumentor-element__name" id="method_drawImage">
  780. drawImage()
  781. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_drawImage" class="headerlink"><i class="fas fa-link"></i></a>
  782. </h4>
  783. <aside class="phpdocumentor-element-found-in">
  784. <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>
  785. :
  786. <span class="phpdocumentor-element-found-in__line">231</span>
  787. </aside>
  788. <p class="phpdocumentor-summary">Creates the QR image</p>
  789. <code class="phpdocumentor-code phpdocumentor-signature ">
  790. <span class="phpdocumentor-signature__visibility">protected</span>
  791. <span class="phpdocumentor-signature__name">drawImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  792. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  793. <span class="phpdocumentor-signature__response_type">void</span>
  794. &mdash;
  795. </article>
  796. <article
  797. class="phpdocumentor-element
  798. -method
  799. -protected
  800. "
  801. >
  802. <h4 class="phpdocumentor-element__name" id="method_dumpImage">
  803. dumpImage()
  804. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage" class="headerlink"><i class="fas fa-link"></i></a>
  805. </h4>
  806. <aside class="phpdocumentor-element-found-in">
  807. <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>
  808. :
  809. <span class="phpdocumentor-element-found-in__line">274</span>
  810. </aside>
  811. <p class="phpdocumentor-summary">Creates the final image by calling the desired GD output function</p>
  812. <code class="phpdocumentor-code phpdocumentor-signature ">
  813. <span class="phpdocumentor-signature__visibility">protected</span>
  814. <span class="phpdocumentor-signature__name">dumpImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  815. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  816. Tags
  817. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  818. </h5>
  819. <dl class="phpdocumentor-tag-list">
  820. <dt class="phpdocumentor-tag-list__entry">
  821. <span class="phpdocumentor-tag__name">throws</span>
  822. </dt>
  823. <dd class="phpdocumentor-tag-list__definition">
  824. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  825. </dd>
  826. </dl>
  827. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  828. <span class="phpdocumentor-signature__response_type">string</span>
  829. &mdash;
  830. </article>
  831. <article
  832. class="phpdocumentor-element
  833. -method
  834. -protected
  835. -abstract "
  836. >
  837. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  838. getDefaultModuleValue()
  839. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  840. </h4>
  841. <aside class="phpdocumentor-element-found-in">
  842. <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>
  843. :
  844. <span class="phpdocumentor-element-found-in__line">126</span>
  845. </aside>
  846. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
  847. <code class="phpdocumentor-code phpdocumentor-signature ">
  848. <span class="phpdocumentor-signature__visibility">protected</span>
  849. <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>
  850. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  851. <dl class="phpdocumentor-argument-list">
  852. <dt class="phpdocumentor-argument-list__entry">
  853. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  854. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  855. </dt>
  856. <dd class="phpdocumentor-argument-list__definition">
  857. <section class="phpdocumentor-description"></section>
  858. </dd>
  859. </dl>
  860. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  861. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  862. &mdash;
  863. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  864. </section>
  865. </article>
  866. <article
  867. class="phpdocumentor-element
  868. -method
  869. -protected
  870. "
  871. >
  872. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  873. getModuleValue()
  874. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  875. </h4>
  876. <aside class="phpdocumentor-element-found-in">
  877. <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>
  878. :
  879. <span class="phpdocumentor-element-found-in__line">99</span>
  880. </aside>
  881. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  882. <code class="phpdocumentor-code phpdocumentor-signature ">
  883. <span class="phpdocumentor-signature__visibility">protected</span>
  884. <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|null</span></code>
  885. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  886. <dl class="phpdocumentor-argument-list">
  887. <dt class="phpdocumentor-argument-list__entry">
  888. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  889. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  890. </dt>
  891. <dd class="phpdocumentor-argument-list__definition">
  892. <section class="phpdocumentor-description"></section>
  893. </dd>
  894. </dl>
  895. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  896. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  897. &mdash;
  898. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  899. </section>
  900. </article>
  901. <article
  902. class="phpdocumentor-element
  903. -method
  904. -protected
  905. "
  906. >
  907. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  908. getModuleValueAt()
  909. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  910. </h4>
  911. <aside class="phpdocumentor-element-found-in">
  912. <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>
  913. :
  914. <span class="phpdocumentor-element-found-in__line">108</span>
  915. </aside>
  916. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  917. <code class="phpdocumentor-code phpdocumentor-signature ">
  918. <span class="phpdocumentor-signature__visibility">protected</span>
  919. <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>
  920. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  921. <dl class="phpdocumentor-argument-list">
  922. <dt class="phpdocumentor-argument-list__entry">
  923. <span class="phpdocumentor-signature__argument__name">$x</span>
  924. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  925. </dt>
  926. <dd class="phpdocumentor-argument-list__definition">
  927. <section class="phpdocumentor-description"></section>
  928. </dd>
  929. <dt class="phpdocumentor-argument-list__entry">
  930. <span class="phpdocumentor-signature__argument__name">$y</span>
  931. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  932. </dt>
  933. <dd class="phpdocumentor-argument-list__definition">
  934. <section class="phpdocumentor-description"></section>
  935. </dd>
  936. </dl>
  937. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  938. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  939. &mdash;
  940. </article>
  941. <article
  942. class="phpdocumentor-element
  943. -method
  944. -protected
  945. -abstract "
  946. >
  947. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  948. prepareModuleValue()
  949. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  950. </h4>
  951. <aside class="phpdocumentor-element-found-in">
  952. <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>
  953. :
  954. <span class="phpdocumentor-element-found-in__line">119</span>
  955. </aside>
  956. <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
  957. <code class="phpdocumentor-code phpdocumentor-signature ">
  958. <span class="phpdocumentor-signature__visibility">protected</span>
  959. <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>
  960. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  961. <dl class="phpdocumentor-argument-list">
  962. <dt class="phpdocumentor-argument-list__entry">
  963. <span class="phpdocumentor-signature__argument__name">$value</span>
  964. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  965. </dt>
  966. <dd class="phpdocumentor-argument-list__definition">
  967. </dd>
  968. </dl>
  969. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  970. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  971. &mdash;
  972. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  973. </section>
  974. </article>
  975. <article
  976. class="phpdocumentor-element
  977. -method
  978. -protected
  979. "
  980. >
  981. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  982. saveToFile()
  983. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  984. </h4>
  985. <aside class="phpdocumentor-element-found-in">
  986. <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>
  987. :
  988. <span class="phpdocumentor-element-found-in__line">143</span>
  989. </aside>
  990. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  991. <code class="phpdocumentor-code phpdocumentor-signature ">
  992. <span class="phpdocumentor-signature__visibility">protected</span>
  993. <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>
  994. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  995. <dl class="phpdocumentor-argument-list">
  996. <dt class="phpdocumentor-argument-list__entry">
  997. <span class="phpdocumentor-signature__argument__name">$data</span>
  998. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  999. </dt>
  1000. <dd class="phpdocumentor-argument-list__definition">
  1001. <section class="phpdocumentor-description"></section>
  1002. </dd>
  1003. <dt class="phpdocumentor-argument-list__entry">
  1004. <span class="phpdocumentor-signature__argument__name">$file</span>
  1005. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1006. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1007. <dd class="phpdocumentor-argument-list__definition">
  1008. <section class="phpdocumentor-description"></section>
  1009. </dd>
  1010. </dl>
  1011. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1012. Tags
  1013. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1014. </h5>
  1015. <dl class="phpdocumentor-tag-list">
  1016. <dt class="phpdocumentor-tag-list__entry">
  1017. <span class="phpdocumentor-tag__name">see</span>
  1018. </dt>
  1019. <dd class="phpdocumentor-tag-list__definition">
  1020. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1021. </dd>
  1022. <dt class="phpdocumentor-tag-list__entry">
  1023. <span class="phpdocumentor-tag__name">see</span>
  1024. </dt>
  1025. <dd class="phpdocumentor-tag-list__definition">
  1026. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1027. </dd>
  1028. <dt class="phpdocumentor-tag-list__entry">
  1029. <span class="phpdocumentor-tag__name">throws</span>
  1030. </dt>
  1031. <dd class="phpdocumentor-tag-list__definition">
  1032. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1033. </dd>
  1034. </dl>
  1035. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1036. <span class="phpdocumentor-signature__response_type">void</span>
  1037. &mdash;
  1038. </article>
  1039. <article
  1040. class="phpdocumentor-element
  1041. -method
  1042. -protected
  1043. "
  1044. >
  1045. <h4 class="phpdocumentor-element__name" id="method_setBgColor">
  1046. setBgColor()
  1047. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setBgColor" class="headerlink"><i class="fas fa-link"></i></a>
  1048. </h4>
  1049. <aside class="phpdocumentor-element-found-in">
  1050. <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>
  1051. :
  1052. <span class="phpdocumentor-element-found-in__line">195</span>
  1053. </aside>
  1054. <p class="phpdocumentor-summary">Sets the background color</p>
  1055. <code class="phpdocumentor-code phpdocumentor-signature ">
  1056. <span class="phpdocumentor-signature__visibility">protected</span>
  1057. <span class="phpdocumentor-signature__name">setBgColor</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1058. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1059. <span class="phpdocumentor-signature__response_type">void</span>
  1060. &mdash;
  1061. </article>
  1062. <article
  1063. class="phpdocumentor-element
  1064. -method
  1065. -protected
  1066. "
  1067. >
  1068. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1069. setMatrixDimensions()
  1070. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1074. :
  1075. <span class="phpdocumentor-element-found-in__line">73</span>
  1076. </aside>
  1077. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1078. <code class="phpdocumentor-code phpdocumentor-signature ">
  1079. <span class="phpdocumentor-signature__visibility">protected</span>
  1080. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1081. <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>
  1082. </section>
  1083. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1084. <span class="phpdocumentor-signature__response_type">void</span>
  1085. &mdash;
  1086. </article>
  1087. <article
  1088. class="phpdocumentor-element
  1089. -method
  1090. -protected
  1091. "
  1092. >
  1093. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1094. setModuleValues()
  1095. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1096. </h4>
  1097. <aside class="phpdocumentor-element-found-in">
  1098. <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>
  1099. :
  1100. <span class="phpdocumentor-element-found-in__line">82</span>
  1101. </aside>
  1102. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1103. <code class="phpdocumentor-code phpdocumentor-signature ">
  1104. <span class="phpdocumentor-signature__visibility">protected</span>
  1105. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1106. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1107. <span class="phpdocumentor-signature__response_type">void</span>
  1108. &mdash;
  1109. </article>
  1110. <article
  1111. class="phpdocumentor-element
  1112. -method
  1113. -protected
  1114. "
  1115. >
  1116. <h4 class="phpdocumentor-element__name" id="method_setPixel">
  1117. setPixel()
  1118. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setPixel" class="headerlink"><i class="fas fa-link"></i></a>
  1119. </h4>
  1120. <aside class="phpdocumentor-element-found-in">
  1121. <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>
  1122. :
  1123. <span class="phpdocumentor-element-found-in__line">242</span>
  1124. </aside>
  1125. <p class="phpdocumentor-summary">Creates a single QR pixel with the given settings</p>
  1126. <code class="phpdocumentor-code phpdocumentor-signature ">
  1127. <span class="phpdocumentor-signature__visibility">protected</span>
  1128. <span class="phpdocumentor-signature__name">setPixel</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">void</span></code>
  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">$x</span>
  1133. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1134. </dt>
  1135. <dd class="phpdocumentor-argument-list__definition">
  1136. <section class="phpdocumentor-description"></section>
  1137. </dd>
  1138. <dt class="phpdocumentor-argument-list__entry">
  1139. <span class="phpdocumentor-signature__argument__name">$y</span>
  1140. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1141. </dt>
  1142. <dd class="phpdocumentor-argument-list__definition">
  1143. <section class="phpdocumentor-description"></section>
  1144. </dd>
  1145. </dl>
  1146. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1147. <span class="phpdocumentor-signature__response_type">void</span>
  1148. &mdash;
  1149. </article>
  1150. <article
  1151. class="phpdocumentor-element
  1152. -method
  1153. -protected
  1154. "
  1155. >
  1156. <h4 class="phpdocumentor-element__name" id="method_setTransparencyColor">
  1157. setTransparencyColor()
  1158. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setTransparencyColor" class="headerlink"><i class="fas fa-link"></i></a>
  1159. </h4>
  1160. <aside class="phpdocumentor-element-found-in">
  1161. <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>
  1162. :
  1163. <span class="phpdocumentor-element-found-in__line">213</span>
  1164. </aside>
  1165. <p class="phpdocumentor-summary">Sets the transparency color</p>
  1166. <code class="phpdocumentor-code phpdocumentor-signature ">
  1167. <span class="phpdocumentor-signature__visibility">protected</span>
  1168. <span class="phpdocumentor-signature__name">setTransparencyColor</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1169. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1170. <span class="phpdocumentor-signature__response_type">void</span>
  1171. &mdash;
  1172. </article>
  1173. <article
  1174. class="phpdocumentor-element
  1175. -method
  1176. -protected
  1177. "
  1178. >
  1179. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1180. toBase64DataURI()
  1181. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1182. </h4>
  1183. <aside class="phpdocumentor-element-found-in">
  1184. <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>
  1185. :
  1186. <span class="phpdocumentor-element-found-in__line">131</span>
  1187. </aside>
  1188. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1189. <code class="phpdocumentor-code phpdocumentor-signature ">
  1190. <span class="phpdocumentor-signature__visibility">protected</span>
  1191. <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>
  1192. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1193. <dl class="phpdocumentor-argument-list">
  1194. <dt class="phpdocumentor-argument-list__entry">
  1195. <span class="phpdocumentor-signature__argument__name">$data</span>
  1196. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1197. </dt>
  1198. <dd class="phpdocumentor-argument-list__definition">
  1199. <section class="phpdocumentor-description"></section>
  1200. </dd>
  1201. <dt class="phpdocumentor-argument-list__entry">
  1202. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1203. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1204. </dt>
  1205. <dd class="phpdocumentor-argument-list__definition">
  1206. <section class="phpdocumentor-description"></section>
  1207. </dd>
  1208. </dl>
  1209. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1210. <span class="phpdocumentor-signature__response_type">string</span>
  1211. &mdash;
  1212. </article>
  1213. </section>
  1214. <script type="text/javascript">
  1215. function loadExternalCodeSnippets(line) {
  1216. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1217. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  1218. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  1219. var language = 'php';
  1220. var code = document.createElement('code');
  1221. code.className = 'language-' + language;
  1222. pre.textContent = '';
  1223. pre.setAttribute('data-line', line)
  1224. code.textContent = 'Loading…';
  1225. pre.appendChild(code);
  1226. var xhr = new XMLHttpRequest();
  1227. xhr.open('GET', src, true);
  1228. xhr.onreadystatechange = function () {
  1229. if (xhr.readyState == 4) {
  1230. if (xhr.status < 400 && xhr.responseText) {
  1231. code.textContent = xhr.responseText;
  1232. Prism.highlightElement(code);
  1233. }
  1234. else if (xhr.status >= 400) {
  1235. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1236. }
  1237. else {
  1238. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  1239. }
  1240. }
  1241. };
  1242. xhr.send(null);
  1243. });
  1244. }
  1245. var modals = document.querySelectorAll("[data-modal]");
  1246. modals.forEach(function (trigger) {
  1247. trigger.addEventListener("click", function (event) {
  1248. //event.preventDefault();
  1249. const modal = document.getElementById(trigger.dataset.modal);
  1250. modal.classList.add("phpdocumentor-modal__open");
  1251. loadExternalCodeSnippets(trigger.dataset.line)
  1252. const exits = modal.querySelectorAll("[data-exit-button]");
  1253. exits.forEach(function (exit) {
  1254. exit.addEventListener("click", function (event) {
  1255. event.preventDefault();
  1256. modal.classList.remove("phpdocumentor-modal__open");
  1257. });
  1258. });
  1259. });
  1260. });
  1261. </script>
  1262. </article>
  1263. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1264. <section class="phpdocumentor-search-results__dialog">
  1265. <header class="phpdocumentor-search-results__header">
  1266. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1267. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1268. </header>
  1269. <section class="phpdocumentor-search-results__body">
  1270. <ul class="phpdocumentor-search-results__entries"></ul>
  1271. </section>
  1272. </section>
  1273. </section>
  1274. </div>
  1275. </div>
  1276. <a href="classes/chillerlan-QRCode-Output-QRImage.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1277. </main>
  1278. <script>
  1279. cssVars({});
  1280. </script>
  1281. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1282. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1283. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1284. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1285. </body>
  1286. </html>