chillerlan-QRCode-Output-QRGdImage.html 76 KB

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