chillerlan-QRCode-Output-QRGdImage.html 60 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250
  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">29</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_image">$image</a>
  128. <span>
  129. &nbsp;: resource|<abbr title="\GdImage">GdImage</abbr> </span>
  130. </dt>
  131. <dd>The GD image resource</dd>
  132. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  133. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  134. <span>
  135. &nbsp;: int </span>
  136. </dt>
  137. <dd>the side length of the QR image (modules * scale)</dd>
  138. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  139. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  140. <span>
  141. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  142. </dt>
  143. <dd>the (filled) data matrix object</dd>
  144. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  145. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  146. <span>
  147. &nbsp;: int </span>
  148. </dt>
  149. <dd>the current size of the QR matrix</dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  151. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  152. <span>
  153. &nbsp;: array&lt;string|int, mixed&gt; </span>
  154. </dt>
  155. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  157. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  158. <span>
  159. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  160. </dt>
  161. <dd></dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  163. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  164. <span>
  165. &nbsp;: int </span>
  166. </dt>
  167. <dd>the current scaling for a QR pixel</dd>
  168. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  169. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method___construct">__construct()</a>
  170. <span>
  171. &nbsp;: mixed </span>
  172. </dt>
  173. <dd>QROutputAbstract constructor.</dd>
  174. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  175. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump">dump()</a>
  176. <span>
  177. &nbsp;: string|resource|<abbr title="\GdImage">GdImage</abbr> </span>
  178. </dt>
  179. <dd></dd>
  180. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  181. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode">base64encode()</a>
  182. <span>
  183. &nbsp;: string </span>
  184. </dt>
  185. <dd>Returns a base64 data URI for the given string and mime type</dd>
  186. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  187. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage">dumpImage()</a>
  188. <span>
  189. &nbsp;: string </span>
  190. </dt>
  191. <dd>Creates the final image by calling the desired GD output function</dd>
  192. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  193. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  194. <span>
  195. &nbsp;: mixed </span>
  196. </dt>
  197. <dd>Returns a defualt value for either dark or light modules (return value depends on the output module)</dd>
  198. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  199. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_getModuleValue">getModuleValue()</a>
  200. <span>
  201. &nbsp;: mixed </span>
  202. </dt>
  203. <dd>Returns the final value for the given input (return value depends on the output module)</dd>
  204. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  205. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  206. <span>
  207. &nbsp;: bool </span>
  208. </dt>
  209. <dd>Determines whether the given value is valid</dd>
  210. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  211. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  212. <span>
  213. &nbsp;: void </span>
  214. </dt>
  215. <dd>saves the qr data to a file</dd>
  216. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  217. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  218. <span>
  219. &nbsp;: void </span>
  220. </dt>
  221. <dd>Sets the initial module values</dd>
  222. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  223. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setPixel">setPixel()</a>
  224. <span>
  225. &nbsp;: void </span>
  226. </dt>
  227. <dd>Creates a single QR pixel with the given settings</dd>
  228. </dl>
  229. <section class="phpdocumentor-properties">
  230. <h3 class="phpdocumentor-elements__header" id="properties">
  231. Properties
  232. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  233. </h3>
  234. <article
  235. class="
  236. phpdocumentor-element
  237. -property
  238. -protected
  239. "
  240. >
  241. <h4 class="phpdocumentor-element__name" id="property_image">
  242. $image
  243. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image" class="headerlink"><i class="fas fa-link"></i></a>
  244. <span class="phpdocumentor-element__modifiers">
  245. </span>
  246. </h4>
  247. <aside class="phpdocumentor-element-found-in">
  248. <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>
  249. :
  250. <span class="phpdocumentor-element-found-in__line">37</span>
  251. </aside>
  252. <p class="phpdocumentor-summary">The GD image resource</p>
  253. <code class="phpdocumentor-code phpdocumentor-signature ">
  254. <span class="phpdocumentor-signature__visibility">protected</span>
  255. <span class="phpdocumentor-signature__type">resource|<abbr title="\GdImage">GdImage</abbr></span>
  256. <span class="phpdocumentor-signature__name">$image</span>
  257. </code>
  258. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  259. Tags
  260. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  261. </h5>
  262. <dl class="phpdocumentor-tag-list">
  263. <dt class="phpdocumentor-tag-list__entry">
  264. <span class="phpdocumentor-tag__name">see</span>
  265. </dt>
  266. <dd class="phpdocumentor-tag-list__definition">
  267. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\imagecreatetruecolor()">imagecreatetruecolor()</abbr></span>
  268. </dd>
  269. </dl>
  270. </article>
  271. <article
  272. class="
  273. phpdocumentor-element
  274. -property
  275. -protected
  276. "
  277. >
  278. <h4 class="phpdocumentor-element__name" id="property_length">
  279. $length
  280. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  281. <span class="phpdocumentor-element__modifiers">
  282. </span>
  283. </h4>
  284. <aside class="phpdocumentor-element-found-in">
  285. <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>
  286. :
  287. <span class="phpdocumentor-element-found-in__line">39</span>
  288. </aside>
  289. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  290. <code class="phpdocumentor-code phpdocumentor-signature ">
  291. <span class="phpdocumentor-signature__visibility">protected</span>
  292. <span class="phpdocumentor-signature__type">int</span>
  293. <span class="phpdocumentor-signature__name">$length</span>
  294. </code>
  295. <section class="phpdocumentor-description"></section>
  296. </article>
  297. <article
  298. class="
  299. phpdocumentor-element
  300. -property
  301. -protected
  302. "
  303. >
  304. <h4 class="phpdocumentor-element__name" id="property_matrix">
  305. $matrix
  306. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  312. :
  313. <span class="phpdocumentor-element-found-in__line">49</span>
  314. </aside>
  315. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  316. <code class="phpdocumentor-code phpdocumentor-signature ">
  317. <span class="phpdocumentor-signature__visibility">protected</span>
  318. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  319. <span class="phpdocumentor-signature__name">$matrix</span>
  320. </code>
  321. <section class="phpdocumentor-description"></section>
  322. </article>
  323. <article
  324. class="
  325. phpdocumentor-element
  326. -property
  327. -protected
  328. "
  329. >
  330. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  331. $moduleCount
  332. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  333. <span class="phpdocumentor-element__modifiers">
  334. </span>
  335. </h4>
  336. <aside class="phpdocumentor-element-found-in">
  337. <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>
  338. :
  339. <span class="phpdocumentor-element-found-in__line">27</span>
  340. </aside>
  341. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  342. <code class="phpdocumentor-code phpdocumentor-signature ">
  343. <span class="phpdocumentor-signature__visibility">protected</span>
  344. <span class="phpdocumentor-signature__type">int</span>
  345. <span class="phpdocumentor-signature__name">$moduleCount</span>
  346. </code>
  347. <section class="phpdocumentor-description"></section>
  348. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  349. Tags
  350. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  351. </h5>
  352. <dl class="phpdocumentor-tag-list">
  353. <dt class="phpdocumentor-tag-list__entry">
  354. <span class="phpdocumentor-tag__name">see</span>
  355. </dt>
  356. <dd class="phpdocumentor-tag-list__definition">
  357. <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>
  358. </dd>
  359. </dl>
  360. </article>
  361. <article
  362. class="
  363. phpdocumentor-element
  364. -property
  365. -protected
  366. "
  367. >
  368. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  369. $moduleValues
  370. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  371. <span class="phpdocumentor-element__modifiers">
  372. </span>
  373. </h4>
  374. <aside class="phpdocumentor-element-found-in">
  375. <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>
  376. :
  377. <span class="phpdocumentor-element-found-in__line">44</span>
  378. </aside>
  379. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  380. <code class="phpdocumentor-code phpdocumentor-signature ">
  381. <span class="phpdocumentor-signature__visibility">protected</span>
  382. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  383. <span class="phpdocumentor-signature__name">$moduleValues</span>
  384. </code>
  385. <section class="phpdocumentor-description"></section>
  386. </article>
  387. <article
  388. class="
  389. phpdocumentor-element
  390. -property
  391. -protected
  392. "
  393. >
  394. <h4 class="phpdocumentor-element__name" id="property_options">
  395. $options
  396. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  397. <span class="phpdocumentor-element__modifiers">
  398. </span>
  399. </h4>
  400. <aside class="phpdocumentor-element-found-in">
  401. <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>
  402. :
  403. <span class="phpdocumentor-element-found-in__line">54</span>
  404. </aside>
  405. <code class="phpdocumentor-code phpdocumentor-signature ">
  406. <span class="phpdocumentor-signature__visibility">protected</span>
  407. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  408. <span class="phpdocumentor-signature__name">$options</span>
  409. </code>
  410. </article>
  411. <article
  412. class="
  413. phpdocumentor-element
  414. -property
  415. -protected
  416. "
  417. >
  418. <h4 class="phpdocumentor-element__name" id="property_scale">
  419. $scale
  420. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  421. <span class="phpdocumentor-element__modifiers">
  422. </span>
  423. </h4>
  424. <aside class="phpdocumentor-element-found-in">
  425. <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>
  426. :
  427. <span class="phpdocumentor-element-found-in__line">34</span>
  428. </aside>
  429. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  430. <code class="phpdocumentor-code phpdocumentor-signature ">
  431. <span class="phpdocumentor-signature__visibility">protected</span>
  432. <span class="phpdocumentor-signature__type">int</span>
  433. <span class="phpdocumentor-signature__name">$scale</span>
  434. </code>
  435. <section class="phpdocumentor-description"></section>
  436. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  437. Tags
  438. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  439. </h5>
  440. <dl class="phpdocumentor-tag-list">
  441. <dt class="phpdocumentor-tag-list__entry">
  442. <span class="phpdocumentor-tag__name">see</span>
  443. </dt>
  444. <dd class="phpdocumentor-tag-list__definition">
  445. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  446. </dd>
  447. </dl>
  448. </article>
  449. </section>
  450. <section class="phpdocumentor-methods">
  451. <h3 class="phpdocumentor-elements__header" id="methods">
  452. Methods
  453. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  454. </h3>
  455. <article
  456. class="phpdocumentor-element
  457. -method
  458. -public
  459. "
  460. >
  461. <h4 class="phpdocumentor-element__name" id="method___construct">
  462. __construct()
  463. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  464. </h4>
  465. <aside class="phpdocumentor-element-found-in">
  466. <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>
  467. :
  468. <span class="phpdocumentor-element-found-in__line">44</span>
  469. </aside>
  470. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  471. <code class="phpdocumentor-code phpdocumentor-signature ">
  472. <span class="phpdocumentor-signature__visibility">public</span>
  473. <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>
  474. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  475. <dl class="phpdocumentor-argument-list">
  476. <dt class="phpdocumentor-argument-list__entry">
  477. <span class="phpdocumentor-signature__argument__name">$options</span>
  478. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  479. </dt>
  480. <dd class="phpdocumentor-argument-list__definition">
  481. <section class="phpdocumentor-description"></section>
  482. </dd>
  483. <dt class="phpdocumentor-argument-list__entry">
  484. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  485. : <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>
  486. </dt>
  487. <dd class="phpdocumentor-argument-list__definition">
  488. <section class="phpdocumentor-description"></section>
  489. </dd>
  490. </dl>
  491. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  492. Tags
  493. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  494. </h5>
  495. <dl class="phpdocumentor-tag-list">
  496. <dt class="phpdocumentor-tag-list__entry">
  497. <span class="phpdocumentor-tag__name">inheritDoc</span>
  498. </dt>
  499. <dd class="phpdocumentor-tag-list__definition">
  500. </dd>
  501. <dt class="phpdocumentor-tag-list__entry">
  502. <span class="phpdocumentor-tag__name">throws</span>
  503. </dt>
  504. <dd class="phpdocumentor-tag-list__definition">
  505. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  506. </dd>
  507. </dl>
  508. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  509. <span class="phpdocumentor-signature__response_type">mixed</span>
  510. &mdash;
  511. </article>
  512. <article
  513. class="phpdocumentor-element
  514. -method
  515. -public
  516. "
  517. >
  518. <h4 class="phpdocumentor-element__name" id="method_dump">
  519. dump()
  520. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  521. </h4>
  522. <aside class="phpdocumentor-element-found-in">
  523. <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>
  524. :
  525. <span class="phpdocumentor-element-found-in__line">82</span>
  526. </aside>
  527. <code class="phpdocumentor-code phpdocumentor-signature ">
  528. <span class="phpdocumentor-signature__visibility">public</span>
  529. <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>
  530. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  531. <dl class="phpdocumentor-argument-list">
  532. <dt class="phpdocumentor-argument-list__entry">
  533. <span class="phpdocumentor-signature__argument__name">$file</span>
  534. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  535. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  536. <dd class="phpdocumentor-argument-list__definition">
  537. <section class="phpdocumentor-description"></section>
  538. </dd>
  539. </dl>
  540. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  541. Tags
  542. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  543. </h5>
  544. <dl class="phpdocumentor-tag-list">
  545. <dt class="phpdocumentor-tag-list__entry">
  546. <span class="phpdocumentor-tag__name">inheritDoc</span>
  547. </dt>
  548. <dd class="phpdocumentor-tag-list__definition">
  549. </dd>
  550. <dt class="phpdocumentor-tag-list__entry">
  551. <span class="phpdocumentor-tag__name">phan-suppress</span>
  552. </dt>
  553. <dd class="phpdocumentor-tag-list__definition">
  554. <section class="phpdocumentor-description"><p>PhanUndeclaredTypeReturnType, PhanTypeMismatchReturn</p>
  555. </section>
  556. </dd>
  557. <dt class="phpdocumentor-tag-list__entry">
  558. <span class="phpdocumentor-tag__name">throws</span>
  559. </dt>
  560. <dd class="phpdocumentor-tag-list__definition">
  561. <span class="phpdocumentor-tag-link"><abbr title="\ErrorException">ErrorException</abbr></span>
  562. </dd>
  563. </dl>
  564. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  565. <span class="phpdocumentor-signature__response_type">string|resource|<abbr title="\GdImage">GdImage</abbr></span>
  566. &mdash;
  567. </article>
  568. <article
  569. class="phpdocumentor-element
  570. -method
  571. -protected
  572. "
  573. >
  574. <h4 class="phpdocumentor-element__name" id="method_base64encode">
  575. base64encode()
  576. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode" class="headerlink"><i class="fas fa-link"></i></a>
  577. </h4>
  578. <aside class="phpdocumentor-element-found-in">
  579. <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>
  580. :
  581. <span class="phpdocumentor-element-found-in__line">110</span>
  582. </aside>
  583. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  584. <code class="phpdocumentor-code phpdocumentor-signature ">
  585. <span class="phpdocumentor-signature__visibility">protected</span>
  586. <span class="phpdocumentor-signature__name">base64encode</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>
  587. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  588. <dl class="phpdocumentor-argument-list">
  589. <dt class="phpdocumentor-argument-list__entry">
  590. <span class="phpdocumentor-signature__argument__name">$data</span>
  591. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  592. </dt>
  593. <dd class="phpdocumentor-argument-list__definition">
  594. <section class="phpdocumentor-description"></section>
  595. </dd>
  596. <dt class="phpdocumentor-argument-list__entry">
  597. <span class="phpdocumentor-signature__argument__name">$mime</span>
  598. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  599. </dt>
  600. <dd class="phpdocumentor-argument-list__definition">
  601. <section class="phpdocumentor-description"></section>
  602. </dd>
  603. </dl>
  604. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  605. <span class="phpdocumentor-signature__response_type">string</span>
  606. &mdash;
  607. </article>
  608. <article
  609. class="phpdocumentor-element
  610. -method
  611. -protected
  612. "
  613. >
  614. <h4 class="phpdocumentor-element__name" id="method_dumpImage">
  615. dumpImage()
  616. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage" class="headerlink"><i class="fas fa-link"></i></a>
  617. </h4>
  618. <aside class="phpdocumentor-element-found-in">
  619. <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>
  620. :
  621. <span class="phpdocumentor-element-found-in__line">174</span>
  622. </aside>
  623. <p class="phpdocumentor-summary">Creates the final image by calling the desired GD output function</p>
  624. <code class="phpdocumentor-code phpdocumentor-signature ">
  625. <span class="phpdocumentor-signature__visibility">protected</span>
  626. <span class="phpdocumentor-signature__name">dumpImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  627. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  628. Tags
  629. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  630. </h5>
  631. <dl class="phpdocumentor-tag-list">
  632. <dt class="phpdocumentor-tag-list__entry">
  633. <span class="phpdocumentor-tag__name">throws</span>
  634. </dt>
  635. <dd class="phpdocumentor-tag-list__definition">
  636. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  637. </dd>
  638. </dl>
  639. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  640. <span class="phpdocumentor-signature__response_type">string</span>
  641. &mdash;
  642. </article>
  643. <article
  644. class="phpdocumentor-element
  645. -method
  646. -protected
  647. "
  648. >
  649. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  650. getDefaultModuleValue()
  651. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  652. </h4>
  653. <aside class="phpdocumentor-element-found-in">
  654. <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>
  655. :
  656. <span class="phpdocumentor-element-found-in__line">70</span>
  657. </aside>
  658. <p class="phpdocumentor-summary">Returns a defualt value for either dark or light modules (return value depends on the output module)</p>
  659. <code class="phpdocumentor-code phpdocumentor-signature ">
  660. <span class="phpdocumentor-signature__visibility">protected</span>
  661. <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>
  662. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  663. <dl class="phpdocumentor-argument-list">
  664. <dt class="phpdocumentor-argument-list__entry">
  665. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  666. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  667. </dt>
  668. <dd class="phpdocumentor-argument-list__definition">
  669. <section class="phpdocumentor-description"></section>
  670. </dd>
  671. </dl>
  672. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  673. Tags
  674. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  675. </h5>
  676. <dl class="phpdocumentor-tag-list">
  677. <dt class="phpdocumentor-tag-list__entry">
  678. <span class="phpdocumentor-tag__name">inheritDoc</span>
  679. </dt>
  680. <dd class="phpdocumentor-tag-list__definition">
  681. </dd>
  682. </dl>
  683. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  684. <span class="phpdocumentor-signature__response_type">mixed</span>
  685. &mdash;
  686. </article>
  687. <article
  688. class="phpdocumentor-element
  689. -method
  690. -protected
  691. "
  692. >
  693. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  694. getModuleValue()
  695. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  696. </h4>
  697. <aside class="phpdocumentor-element-found-in">
  698. <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>
  699. :
  700. <span class="phpdocumentor-element-found-in__line">63</span>
  701. </aside>
  702. <p class="phpdocumentor-summary">Returns the final value for the given input (return value depends on the output module)</p>
  703. <code class="phpdocumentor-code phpdocumentor-signature ">
  704. <span class="phpdocumentor-signature__visibility">protected</span>
  705. <span class="phpdocumentor-signature__name">getModuleValue</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</span></code>
  706. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  707. <dl class="phpdocumentor-argument-list">
  708. <dt class="phpdocumentor-argument-list__entry">
  709. <span class="phpdocumentor-signature__argument__name">$value</span>
  710. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  711. </dt>
  712. <dd class="phpdocumentor-argument-list__definition">
  713. </dd>
  714. </dl>
  715. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  716. Tags
  717. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  718. </h5>
  719. <dl class="phpdocumentor-tag-list">
  720. <dt class="phpdocumentor-tag-list__entry">
  721. <span class="phpdocumentor-tag__name">inheritDoc</span>
  722. </dt>
  723. <dd class="phpdocumentor-tag-list__definition">
  724. </dd>
  725. </dl>
  726. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  727. <span class="phpdocumentor-signature__response_type">mixed</span>
  728. &mdash;
  729. </article>
  730. <article
  731. class="phpdocumentor-element
  732. -method
  733. -protected
  734. "
  735. >
  736. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  737. moduleValueIsValid()
  738. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  739. </h4>
  740. <aside class="phpdocumentor-element-found-in">
  741. <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>
  742. :
  743. <span class="phpdocumentor-element-found-in__line">56</span>
  744. </aside>
  745. <p class="phpdocumentor-summary">Determines whether the given value is valid</p>
  746. <code class="phpdocumentor-code phpdocumentor-signature ">
  747. <span class="phpdocumentor-signature__visibility">protected</span>
  748. <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>
  749. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  750. <dl class="phpdocumentor-argument-list">
  751. <dt class="phpdocumentor-argument-list__entry">
  752. <span class="phpdocumentor-signature__argument__name">$value</span>
  753. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  754. </dt>
  755. <dd class="phpdocumentor-argument-list__definition">
  756. </dd>
  757. </dl>
  758. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  759. Tags
  760. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  761. </h5>
  762. <dl class="phpdocumentor-tag-list">
  763. <dt class="phpdocumentor-tag-list__entry">
  764. <span class="phpdocumentor-tag__name">inheritDoc</span>
  765. </dt>
  766. <dd class="phpdocumentor-tag-list__definition">
  767. </dd>
  768. </dl>
  769. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  770. <span class="phpdocumentor-signature__response_type">bool</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_saveToFile">
  780. saveToFile()
  781. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  785. :
  786. <span class="phpdocumentor-element-found-in__line">122</span>
  787. </aside>
  788. <p class="phpdocumentor-summary">saves the qr data to a file</p>
  789. <code class="phpdocumentor-code phpdocumentor-signature ">
  790. <span class="phpdocumentor-signature__visibility">protected</span>
  791. <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 class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  792. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  793. <dl class="phpdocumentor-argument-list">
  794. <dt class="phpdocumentor-argument-list__entry">
  795. <span class="phpdocumentor-signature__argument__name">$data</span>
  796. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  797. </dt>
  798. <dd class="phpdocumentor-argument-list__definition">
  799. <section class="phpdocumentor-description"></section>
  800. </dd>
  801. <dt class="phpdocumentor-argument-list__entry">
  802. <span class="phpdocumentor-signature__argument__name">$file</span>
  803. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  804. </dt>
  805. <dd class="phpdocumentor-argument-list__definition">
  806. <section class="phpdocumentor-description"></section>
  807. </dd>
  808. </dl>
  809. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  810. Tags
  811. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  812. </h5>
  813. <dl class="phpdocumentor-tag-list">
  814. <dt class="phpdocumentor-tag-list__entry">
  815. <span class="phpdocumentor-tag__name">see</span>
  816. </dt>
  817. <dd class="phpdocumentor-tag-list__definition">
  818. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  819. </dd>
  820. <dt class="phpdocumentor-tag-list__entry">
  821. <span class="phpdocumentor-tag__name">see</span>
  822. </dt>
  823. <dd class="phpdocumentor-tag-list__definition">
  824. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::cachefile">QROptions::cachefile</abbr></span>
  825. </dd>
  826. <dt class="phpdocumentor-tag-list__entry">
  827. <span class="phpdocumentor-tag__name">throws</span>
  828. </dt>
  829. <dd class="phpdocumentor-tag-list__definition">
  830. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  831. </dd>
  832. </dl>
  833. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  834. <span class="phpdocumentor-signature__response_type">void</span>
  835. &mdash;
  836. </article>
  837. <article
  838. class="phpdocumentor-element
  839. -method
  840. -protected
  841. "
  842. >
  843. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  844. setModuleValues()
  845. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  846. </h4>
  847. <aside class="phpdocumentor-element-found-in">
  848. <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>
  849. :
  850. <span class="phpdocumentor-element-found-in__line">72</span>
  851. </aside>
  852. <p class="phpdocumentor-summary">Sets the initial module values</p>
  853. <code class="phpdocumentor-code phpdocumentor-signature ">
  854. <span class="phpdocumentor-signature__visibility">protected</span>
  855. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  856. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  857. <span class="phpdocumentor-signature__response_type">void</span>
  858. &mdash;
  859. </article>
  860. <article
  861. class="phpdocumentor-element
  862. -method
  863. -protected
  864. "
  865. >
  866. <h4 class="phpdocumentor-element__name" id="method_setPixel">
  867. setPixel()
  868. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setPixel" class="headerlink"><i class="fas fa-link"></i></a>
  869. </h4>
  870. <aside class="phpdocumentor-element-found-in">
  871. <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>
  872. :
  873. <span class="phpdocumentor-element-found-in__line">146</span>
  874. </aside>
  875. <p class="phpdocumentor-summary">Creates a single QR pixel with the given settings</p>
  876. <code class="phpdocumentor-code phpdocumentor-signature ">
  877. <span class="phpdocumentor-signature__visibility">protected</span>
  878. <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>
  879. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  880. <dl class="phpdocumentor-argument-list">
  881. <dt class="phpdocumentor-argument-list__entry">
  882. <span class="phpdocumentor-signature__argument__name">$x</span>
  883. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  884. </dt>
  885. <dd class="phpdocumentor-argument-list__definition">
  886. <section class="phpdocumentor-description"></section>
  887. </dd>
  888. <dt class="phpdocumentor-argument-list__entry">
  889. <span class="phpdocumentor-signature__argument__name">$y</span>
  890. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  891. </dt>
  892. <dd class="phpdocumentor-argument-list__definition">
  893. <section class="phpdocumentor-description"></section>
  894. </dd>
  895. <dt class="phpdocumentor-argument-list__entry">
  896. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  897. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  898. </dt>
  899. <dd class="phpdocumentor-argument-list__definition">
  900. <section class="phpdocumentor-description"></section>
  901. </dd>
  902. </dl>
  903. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  904. <span class="phpdocumentor-signature__response_type">void</span>
  905. &mdash;
  906. </article>
  907. </section>
  908. <script type="text/javascript">
  909. function loadExternalCodeSnippets(line) {
  910. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  911. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  912. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  913. var language = 'php';
  914. var code = document.createElement('code');
  915. code.className = 'language-' + language;
  916. pre.textContent = '';
  917. pre.setAttribute('data-line', line)
  918. code.textContent = 'Loading…';
  919. pre.appendChild(code);
  920. var xhr = new XMLHttpRequest();
  921. xhr.open('GET', src, true);
  922. xhr.onreadystatechange = function () {
  923. if (xhr.readyState == 4) {
  924. if (xhr.status < 400 && xhr.responseText) {
  925. code.textContent = xhr.responseText;
  926. Prism.highlightElement(code);
  927. }
  928. else if (xhr.status >= 400) {
  929. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  930. }
  931. else {
  932. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  933. }
  934. }
  935. };
  936. xhr.send(null);
  937. });
  938. }
  939. var modals = document.querySelectorAll("[data-modal]");
  940. modals.forEach(function (trigger) {
  941. trigger.addEventListener("click", function (event) {
  942. //event.preventDefault();
  943. const modal = document.getElementById(trigger.dataset.modal);
  944. modal.classList.add("phpdocumentor-modal__open");
  945. loadExternalCodeSnippets(trigger.dataset.line)
  946. const exits = modal.querySelectorAll("[data-exit-button]");
  947. exits.forEach(function (exit) {
  948. exit.addEventListener("click", function (event) {
  949. event.preventDefault();
  950. modal.classList.remove("phpdocumentor-modal__open");
  951. });
  952. });
  953. });
  954. });
  955. </script>
  956. </article>
  957. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  958. <section class="phpdocumentor-search-results__dialog">
  959. <header class="phpdocumentor-search-results__header">
  960. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  961. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  962. </header>
  963. <section class="phpdocumentor-search-results__body">
  964. <ul class="phpdocumentor-search-results__entries"></ul>
  965. </section>
  966. </section>
  967. </section>
  968. </div>
  969. </div>
  970. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  971. </main>
  972. <script>
  973. cssVars({});
  974. </script>
  975. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  976. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  977. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  978. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  979. </body>
  980. </html>