chillerlan-QRCode-Output-QRImage.html 60 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. QRImage
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Output-QRGdImage.html"><abbr title="\chillerlan\QRCode\Output\QRGdImage">QRGdImage</abbr></a>
  95. </span>
  96. <div class="phpdocumentor-element__package">
  97. in package
  98. <ul class="phpdocumentor-breadcrumbs">
  99. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  100. </ul>
  101. </div>
  102. </h2>
  103. <aside class="phpdocumentor-element-found-in">
  104. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRImage.php"><a href="files/src-output-qrimage.html"><abbr title="src/Output/QRImage.php">QRImage.php</abbr></a></abbr>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">17</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">Converts the matrix into GD images, raw or base64 output (requires ext-gd)</p>
  109. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  110. Tags
  111. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  112. </h5>
  113. <dl class="phpdocumentor-tag-list">
  114. <dt class="phpdocumentor-tag-list__entry">
  115. <span class="phpdocumentor-tag__name">deprecated</span>
  116. </dt>
  117. <dd class="phpdocumentor-tag-list__definition">
  118. <span class="phpdocumentor-tag-link">5.0.0</span>
  119. <section class="phpdocumentor-description"><p>backward compatibility, use QRGdImage instead</p>
  120. </section>
  121. </dd>
  122. <dt class="phpdocumentor-tag-list__entry">
  123. <span class="phpdocumentor-tag__name">see</span>
  124. </dt>
  125. <dd class="phpdocumentor-tag-list__definition">
  126. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRGdImage.html"><abbr title="\chillerlan\QRCode\Output\QRGdImage">QRGdImage</abbr></a></span>
  127. </dd>
  128. </dl>
  129. <h3 id="toc">
  130. Table of Contents
  131. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  132. </h3>
  133. <dl class="phpdocumentor-table-of-contents">
  134. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  135. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image">$image</a>
  136. <span>
  137. &nbsp;: resource|<abbr title="\GdImage">GdImage</abbr> </span>
  138. </dt>
  139. <dd>The GD image resource</dd>
  140. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  141. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  142. <span>
  143. &nbsp;: int </span>
  144. </dt>
  145. <dd>the side length of the QR image (modules * scale)</dd>
  146. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  147. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  148. <span>
  149. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  150. </dt>
  151. <dd>the (filled) data matrix object</dd>
  152. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  153. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  154. <span>
  155. &nbsp;: int </span>
  156. </dt>
  157. <dd>the current size of the QR matrix</dd>
  158. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  159. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  160. <span>
  161. &nbsp;: array&lt;string|int, mixed&gt; </span>
  162. </dt>
  163. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  164. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  165. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  166. <span>
  167. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  168. </dt>
  169. <dd></dd>
  170. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  171. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  172. <span>
  173. &nbsp;: int </span>
  174. </dt>
  175. <dd>the current scaling for a QR pixel</dd>
  176. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  177. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  178. <span>
  179. &nbsp;: mixed </span>
  180. </dt>
  181. <dd>QROutputAbstract constructor.</dd>
  182. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  183. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump">dump()</a>
  184. <span>
  185. &nbsp;: string|resource|<abbr title="\GdImage">GdImage</abbr> </span>
  186. </dt>
  187. <dd></dd>
  188. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  189. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode">base64encode()</a>
  190. <span>
  191. &nbsp;: string </span>
  192. </dt>
  193. <dd>Returns a base64 data URI for the given string and mime type</dd>
  194. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  195. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  196. <span>
  197. &nbsp;: array&lt;string|int, mixed&gt; </span>
  198. </dt>
  199. <dd>collects the modules per QRMatrix::M_* type and runs a $transform functio on each module and
  200. returns an array with the transformed modules</dd>
  201. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  202. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage">dumpImage()</a>
  203. <span>
  204. &nbsp;: string </span>
  205. </dt>
  206. <dd>Creates the final image by calling the desired GD output function</dd>
  207. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  208. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  209. <span>
  210. &nbsp;: mixed </span>
  211. </dt>
  212. <dd>Returns a defualt value for either dark or light modules (return value depends on the output module)</dd>
  213. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  214. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  215. <span>
  216. &nbsp;: mixed </span>
  217. </dt>
  218. <dd>Returns the final value for the given input (return value depends on the output module)</dd>
  219. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  220. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  221. <span>
  222. &nbsp;: bool </span>
  223. </dt>
  224. <dd>Determines whether the given value is valid</dd>
  225. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  226. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  227. <span>
  228. &nbsp;: void </span>
  229. </dt>
  230. <dd>saves the qr data to a file</dd>
  231. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  232. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  233. <span>
  234. &nbsp;: void </span>
  235. </dt>
  236. <dd>Sets the initial module values</dd>
  237. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  238. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setPixel">setPixel()</a>
  239. <span>
  240. &nbsp;: void </span>
  241. </dt>
  242. <dd>Creates a single QR pixel with the given settings</dd>
  243. </dl>
  244. <section class="phpdocumentor-properties">
  245. <h3 class="phpdocumentor-elements__header" id="properties">
  246. Properties
  247. <a href="classes/chillerlan-QRCode-Output-QRImage.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  248. </h3>
  249. <article
  250. class="
  251. phpdocumentor-element
  252. -property
  253. -protected
  254. "
  255. >
  256. <h4 class="phpdocumentor-element__name" id="property_image">
  257. $image
  258. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#property_image" class="headerlink"><i class="fas fa-link"></i></a>
  259. <span class="phpdocumentor-element__modifiers">
  260. </span>
  261. </h4>
  262. <aside class="phpdocumentor-element-found-in">
  263. <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>
  264. :
  265. <span class="phpdocumentor-element-found-in__line">37</span>
  266. </aside>
  267. <p class="phpdocumentor-summary">The GD image resource</p>
  268. <code class="phpdocumentor-code phpdocumentor-signature ">
  269. <span class="phpdocumentor-signature__visibility">protected</span>
  270. <span class="phpdocumentor-signature__type">resource|<abbr title="\GdImage">GdImage</abbr></span>
  271. <span class="phpdocumentor-signature__name">$image</span>
  272. </code>
  273. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  274. Tags
  275. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  276. </h5>
  277. <dl class="phpdocumentor-tag-list">
  278. <dt class="phpdocumentor-tag-list__entry">
  279. <span class="phpdocumentor-tag__name">see</span>
  280. </dt>
  281. <dd class="phpdocumentor-tag-list__definition">
  282. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\imagecreatetruecolor()">imagecreatetruecolor()</abbr></span>
  283. </dd>
  284. </dl>
  285. </article>
  286. <article
  287. class="
  288. phpdocumentor-element
  289. -property
  290. -protected
  291. "
  292. >
  293. <h4 class="phpdocumentor-element__name" id="property_length">
  294. $length
  295. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  296. <span class="phpdocumentor-element__modifiers">
  297. </span>
  298. </h4>
  299. <aside class="phpdocumentor-element-found-in">
  300. <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>
  301. :
  302. <span class="phpdocumentor-element-found-in__line">40</span>
  303. </aside>
  304. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  305. <code class="phpdocumentor-code phpdocumentor-signature ">
  306. <span class="phpdocumentor-signature__visibility">protected</span>
  307. <span class="phpdocumentor-signature__type">int</span>
  308. <span class="phpdocumentor-signature__name">$length</span>
  309. </code>
  310. <section class="phpdocumentor-description"></section>
  311. </article>
  312. <article
  313. class="
  314. phpdocumentor-element
  315. -property
  316. -protected
  317. "
  318. >
  319. <h4 class="phpdocumentor-element__name" id="property_matrix">
  320. $matrix
  321. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  322. <span class="phpdocumentor-element__modifiers">
  323. </span>
  324. </h4>
  325. <aside class="phpdocumentor-element-found-in">
  326. <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>
  327. :
  328. <span class="phpdocumentor-element-found-in__line">50</span>
  329. </aside>
  330. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  331. <code class="phpdocumentor-code phpdocumentor-signature ">
  332. <span class="phpdocumentor-signature__visibility">protected</span>
  333. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  334. <span class="phpdocumentor-signature__name">$matrix</span>
  335. </code>
  336. <section class="phpdocumentor-description"></section>
  337. </article>
  338. <article
  339. class="
  340. phpdocumentor-element
  341. -property
  342. -protected
  343. "
  344. >
  345. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  346. $moduleCount
  347. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  348. <span class="phpdocumentor-element__modifiers">
  349. </span>
  350. </h4>
  351. <aside class="phpdocumentor-element-found-in">
  352. <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>
  353. :
  354. <span class="phpdocumentor-element-found-in__line">28</span>
  355. </aside>
  356. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  357. <code class="phpdocumentor-code phpdocumentor-signature ">
  358. <span class="phpdocumentor-signature__visibility">protected</span>
  359. <span class="phpdocumentor-signature__type">int</span>
  360. <span class="phpdocumentor-signature__name">$moduleCount</span>
  361. </code>
  362. <section class="phpdocumentor-description"></section>
  363. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  364. Tags
  365. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  366. </h5>
  367. <dl class="phpdocumentor-tag-list">
  368. <dt class="phpdocumentor-tag-list__entry">
  369. <span class="phpdocumentor-tag__name">see</span>
  370. </dt>
  371. <dd class="phpdocumentor-tag-list__definition">
  372. <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>
  373. </dd>
  374. </dl>
  375. </article>
  376. <article
  377. class="
  378. phpdocumentor-element
  379. -property
  380. -protected
  381. "
  382. >
  383. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  384. $moduleValues
  385. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  386. <span class="phpdocumentor-element__modifiers">
  387. </span>
  388. </h4>
  389. <aside class="phpdocumentor-element-found-in">
  390. <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>
  391. :
  392. <span class="phpdocumentor-element-found-in__line">45</span>
  393. </aside>
  394. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  395. <code class="phpdocumentor-code phpdocumentor-signature ">
  396. <span class="phpdocumentor-signature__visibility">protected</span>
  397. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  398. <span class="phpdocumentor-signature__name">$moduleValues</span>
  399. </code>
  400. <section class="phpdocumentor-description"></section>
  401. </article>
  402. <article
  403. class="
  404. phpdocumentor-element
  405. -property
  406. -protected
  407. "
  408. >
  409. <h4 class="phpdocumentor-element__name" id="property_options">
  410. $options
  411. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  412. <span class="phpdocumentor-element__modifiers">
  413. </span>
  414. </h4>
  415. <aside class="phpdocumentor-element-found-in">
  416. <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>
  417. :
  418. <span class="phpdocumentor-element-found-in__line">55</span>
  419. </aside>
  420. <code class="phpdocumentor-code phpdocumentor-signature ">
  421. <span class="phpdocumentor-signature__visibility">protected</span>
  422. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  423. <span class="phpdocumentor-signature__name">$options</span>
  424. </code>
  425. </article>
  426. <article
  427. class="
  428. phpdocumentor-element
  429. -property
  430. -protected
  431. "
  432. >
  433. <h4 class="phpdocumentor-element__name" id="property_scale">
  434. $scale
  435. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  436. <span class="phpdocumentor-element__modifiers">
  437. </span>
  438. </h4>
  439. <aside class="phpdocumentor-element-found-in">
  440. <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>
  441. :
  442. <span class="phpdocumentor-element-found-in__line">35</span>
  443. </aside>
  444. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  445. <code class="phpdocumentor-code phpdocumentor-signature ">
  446. <span class="phpdocumentor-signature__visibility">protected</span>
  447. <span class="phpdocumentor-signature__type">int</span>
  448. <span class="phpdocumentor-signature__name">$scale</span>
  449. </code>
  450. <section class="phpdocumentor-description"></section>
  451. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  452. Tags
  453. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  454. </h5>
  455. <dl class="phpdocumentor-tag-list">
  456. <dt class="phpdocumentor-tag-list__entry">
  457. <span class="phpdocumentor-tag__name">see</span>
  458. </dt>
  459. <dd class="phpdocumentor-tag-list__definition">
  460. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  461. </dd>
  462. </dl>
  463. </article>
  464. </section>
  465. <section class="phpdocumentor-methods">
  466. <h3 class="phpdocumentor-elements__header" id="methods">
  467. Methods
  468. <a href="classes/chillerlan-QRCode-Output-QRImage.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  469. </h3>
  470. <article
  471. class="phpdocumentor-element
  472. -method
  473. -public
  474. "
  475. >
  476. <h4 class="phpdocumentor-element__name" id="method___construct">
  477. __construct()
  478. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  479. </h4>
  480. <aside class="phpdocumentor-element-found-in">
  481. <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>
  482. :
  483. <span class="phpdocumentor-element-found-in__line">60</span>
  484. </aside>
  485. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  486. <code class="phpdocumentor-code phpdocumentor-signature ">
  487. <span class="phpdocumentor-signature__visibility">public</span>
  488. <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>
  489. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  490. <dl class="phpdocumentor-argument-list">
  491. <dt class="phpdocumentor-argument-list__entry">
  492. <span class="phpdocumentor-signature__argument__name">$options</span>
  493. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  494. </dt>
  495. <dd class="phpdocumentor-argument-list__definition">
  496. <section class="phpdocumentor-description"></section>
  497. </dd>
  498. <dt class="phpdocumentor-argument-list__entry">
  499. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  500. : <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>
  501. </dt>
  502. <dd class="phpdocumentor-argument-list__definition">
  503. <section class="phpdocumentor-description"></section>
  504. </dd>
  505. </dl>
  506. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  507. <span class="phpdocumentor-signature__response_type">mixed</span>
  508. &mdash;
  509. </article>
  510. <article
  511. class="phpdocumentor-element
  512. -method
  513. -public
  514. "
  515. >
  516. <h4 class="phpdocumentor-element__name" id="method_dump">
  517. dump()
  518. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  519. </h4>
  520. <aside class="phpdocumentor-element-found-in">
  521. <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>
  522. :
  523. <span class="phpdocumentor-element-found-in__line">82</span>
  524. </aside>
  525. <code class="phpdocumentor-code phpdocumentor-signature ">
  526. <span class="phpdocumentor-signature__visibility">public</span>
  527. <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>
  528. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  529. <dl class="phpdocumentor-argument-list">
  530. <dt class="phpdocumentor-argument-list__entry">
  531. <span class="phpdocumentor-signature__argument__name">$file</span>
  532. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  533. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  534. <dd class="phpdocumentor-argument-list__definition">
  535. <section class="phpdocumentor-description"></section>
  536. </dd>
  537. </dl>
  538. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  539. Tags
  540. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  541. </h5>
  542. <dl class="phpdocumentor-tag-list">
  543. <dt class="phpdocumentor-tag-list__entry">
  544. <span class="phpdocumentor-tag__name">inheritDoc</span>
  545. </dt>
  546. <dd class="phpdocumentor-tag-list__definition">
  547. </dd>
  548. <dt class="phpdocumentor-tag-list__entry">
  549. <span class="phpdocumentor-tag__name">phan-suppress</span>
  550. </dt>
  551. <dd class="phpdocumentor-tag-list__definition">
  552. <section class="phpdocumentor-description"><p>PhanUndeclaredTypeReturnType, PhanTypeMismatchReturn</p>
  553. </section>
  554. </dd>
  555. <dt class="phpdocumentor-tag-list__entry">
  556. <span class="phpdocumentor-tag__name">throws</span>
  557. </dt>
  558. <dd class="phpdocumentor-tag-list__definition">
  559. <span class="phpdocumentor-tag-link"><abbr title="\ErrorException">ErrorException</abbr></span>
  560. </dd>
  561. </dl>
  562. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  563. <span class="phpdocumentor-signature__response_type">string|resource|<abbr title="\GdImage">GdImage</abbr></span>
  564. &mdash;
  565. </article>
  566. <article
  567. class="phpdocumentor-element
  568. -method
  569. -protected
  570. "
  571. >
  572. <h4 class="phpdocumentor-element__name" id="method_base64encode">
  573. base64encode()
  574. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode" class="headerlink"><i class="fas fa-link"></i></a>
  575. </h4>
  576. <aside class="phpdocumentor-element-found-in">
  577. <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>
  578. :
  579. <span class="phpdocumentor-element-found-in__line">111</span>
  580. </aside>
  581. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  582. <code class="phpdocumentor-code phpdocumentor-signature ">
  583. <span class="phpdocumentor-signature__visibility">protected</span>
  584. <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>
  585. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  586. <dl class="phpdocumentor-argument-list">
  587. <dt class="phpdocumentor-argument-list__entry">
  588. <span class="phpdocumentor-signature__argument__name">$data</span>
  589. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  590. </dt>
  591. <dd class="phpdocumentor-argument-list__definition">
  592. <section class="phpdocumentor-description"></section>
  593. </dd>
  594. <dt class="phpdocumentor-argument-list__entry">
  595. <span class="phpdocumentor-signature__argument__name">$mime</span>
  596. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  597. </dt>
  598. <dd class="phpdocumentor-argument-list__definition">
  599. <section class="phpdocumentor-description"></section>
  600. </dd>
  601. </dl>
  602. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  603. <span class="phpdocumentor-signature__response_type">string</span>
  604. &mdash;
  605. </article>
  606. <article
  607. class="phpdocumentor-element
  608. -method
  609. -protected
  610. "
  611. >
  612. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  613. collectModules()
  614. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  615. </h4>
  616. <aside class="phpdocumentor-element-found-in">
  617. <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>
  618. :
  619. <span class="phpdocumentor-element-found-in__line">138</span>
  620. </aside>
  621. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform functio on each module and
  622. returns an array with the transformed modules</p>
  623. <code class="phpdocumentor-code phpdocumentor-signature ">
  624. <span class="phpdocumentor-signature__visibility">protected</span>
  625. <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>
  626. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  627. <dl class="phpdocumentor-argument-list">
  628. <dt class="phpdocumentor-argument-list__entry">
  629. <span class="phpdocumentor-signature__argument__name">$transform</span>
  630. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  631. </dt>
  632. <dd class="phpdocumentor-argument-list__definition">
  633. <section class="phpdocumentor-description"></section>
  634. </dd>
  635. </dl>
  636. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  637. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  638. &mdash;
  639. </article>
  640. <article
  641. class="phpdocumentor-element
  642. -method
  643. -protected
  644. "
  645. >
  646. <h4 class="phpdocumentor-element__name" id="method_dumpImage">
  647. dumpImage()
  648. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_dumpImage" class="headerlink"><i class="fas fa-link"></i></a>
  649. </h4>
  650. <aside class="phpdocumentor-element-found-in">
  651. <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>
  652. :
  653. <span class="phpdocumentor-element-found-in__line">174</span>
  654. </aside>
  655. <p class="phpdocumentor-summary">Creates the final image by calling the desired GD output function</p>
  656. <code class="phpdocumentor-code phpdocumentor-signature ">
  657. <span class="phpdocumentor-signature__visibility">protected</span>
  658. <span class="phpdocumentor-signature__name">dumpImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  659. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  660. Tags
  661. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  662. </h5>
  663. <dl class="phpdocumentor-tag-list">
  664. <dt class="phpdocumentor-tag-list__entry">
  665. <span class="phpdocumentor-tag__name">throws</span>
  666. </dt>
  667. <dd class="phpdocumentor-tag-list__definition">
  668. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  669. </dd>
  670. </dl>
  671. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  672. <span class="phpdocumentor-signature__response_type">string</span>
  673. &mdash;
  674. </article>
  675. <article
  676. class="phpdocumentor-element
  677. -method
  678. -protected
  679. -abstract "
  680. >
  681. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  682. getDefaultModuleValue()
  683. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  684. </h4>
  685. <aside class="phpdocumentor-element-found-in">
  686. <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>
  687. :
  688. <span class="phpdocumentor-element-found-in__line">106</span>
  689. </aside>
  690. <p class="phpdocumentor-summary">Returns a defualt value for either dark or light modules (return value depends on the output module)</p>
  691. <code class="phpdocumentor-code phpdocumentor-signature ">
  692. <span class="phpdocumentor-signature__visibility">protected</span>
  693. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getDefaultModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$isDark</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  694. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  695. <dl class="phpdocumentor-argument-list">
  696. <dt class="phpdocumentor-argument-list__entry">
  697. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  698. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  699. </dt>
  700. <dd class="phpdocumentor-argument-list__definition">
  701. <section class="phpdocumentor-description"></section>
  702. </dd>
  703. </dl>
  704. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  705. <span class="phpdocumentor-signature__response_type">mixed</span>
  706. &mdash;
  707. </article>
  708. <article
  709. class="phpdocumentor-element
  710. -method
  711. -protected
  712. -abstract "
  713. >
  714. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  715. getModuleValue()
  716. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  717. </h4>
  718. <aside class="phpdocumentor-element-found-in">
  719. <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>
  720. :
  721. <span class="phpdocumentor-element-found-in__line">99</span>
  722. </aside>
  723. <p class="phpdocumentor-summary">Returns the final value for the given input (return value depends on the output module)</p>
  724. <code class="phpdocumentor-code phpdocumentor-signature ">
  725. <span class="phpdocumentor-signature__visibility">protected</span>
  726. <span class="phpdocumentor-signature__abstract">abstract</span> <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>
  727. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  728. <dl class="phpdocumentor-argument-list">
  729. <dt class="phpdocumentor-argument-list__entry">
  730. <span class="phpdocumentor-signature__argument__name">$value</span>
  731. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  732. </dt>
  733. <dd class="phpdocumentor-argument-list__definition">
  734. </dd>
  735. </dl>
  736. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  737. <span class="phpdocumentor-signature__response_type">mixed</span>
  738. &mdash;
  739. </article>
  740. <article
  741. class="phpdocumentor-element
  742. -method
  743. -protected
  744. -abstract "
  745. >
  746. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  747. moduleValueIsValid()
  748. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  749. </h4>
  750. <aside class="phpdocumentor-element-found-in">
  751. <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>
  752. :
  753. <span class="phpdocumentor-element-found-in__line">90</span>
  754. </aside>
  755. <p class="phpdocumentor-summary">Determines whether the given value is valid</p>
  756. <code class="phpdocumentor-code phpdocumentor-signature ">
  757. <span class="phpdocumentor-signature__visibility">protected</span>
  758. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">moduleValueIsValid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  759. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  760. <dl class="phpdocumentor-argument-list">
  761. <dt class="phpdocumentor-argument-list__entry">
  762. <span class="phpdocumentor-signature__argument__name">$value</span>
  763. : <span class="phpdocumentor-signature__argument__return-type">mixed|null</span>
  764. </dt>
  765. <dd class="phpdocumentor-argument-list__definition">
  766. </dd>
  767. </dl>
  768. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  769. <span class="phpdocumentor-signature__response_type">bool</span>
  770. &mdash;
  771. </article>
  772. <article
  773. class="phpdocumentor-element
  774. -method
  775. -protected
  776. "
  777. >
  778. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  779. saveToFile()
  780. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  781. </h4>
  782. <aside class="phpdocumentor-element-found-in">
  783. <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>
  784. :
  785. <span class="phpdocumentor-element-found-in__line">123</span>
  786. </aside>
  787. <p class="phpdocumentor-summary">saves the qr data to a file</p>
  788. <code class="phpdocumentor-code phpdocumentor-signature ">
  789. <span class="phpdocumentor-signature__visibility">protected</span>
  790. <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>
  791. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  792. <dl class="phpdocumentor-argument-list">
  793. <dt class="phpdocumentor-argument-list__entry">
  794. <span class="phpdocumentor-signature__argument__name">$data</span>
  795. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  796. </dt>
  797. <dd class="phpdocumentor-argument-list__definition">
  798. <section class="phpdocumentor-description"></section>
  799. </dd>
  800. <dt class="phpdocumentor-argument-list__entry">
  801. <span class="phpdocumentor-signature__argument__name">$file</span>
  802. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  803. </dt>
  804. <dd class="phpdocumentor-argument-list__definition">
  805. <section class="phpdocumentor-description"></section>
  806. </dd>
  807. </dl>
  808. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  809. Tags
  810. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  811. </h5>
  812. <dl class="phpdocumentor-tag-list">
  813. <dt class="phpdocumentor-tag-list__entry">
  814. <span class="phpdocumentor-tag__name">see</span>
  815. </dt>
  816. <dd class="phpdocumentor-tag-list__definition">
  817. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  818. </dd>
  819. <dt class="phpdocumentor-tag-list__entry">
  820. <span class="phpdocumentor-tag__name">see</span>
  821. </dt>
  822. <dd class="phpdocumentor-tag-list__definition">
  823. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::cachefile">QROptions::cachefile</abbr></span>
  824. </dd>
  825. <dt class="phpdocumentor-tag-list__entry">
  826. <span class="phpdocumentor-tag__name">throws</span>
  827. </dt>
  828. <dd class="phpdocumentor-tag-list__definition">
  829. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  830. </dd>
  831. </dl>
  832. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  833. <span class="phpdocumentor-signature__response_type">void</span>
  834. &mdash;
  835. </article>
  836. <article
  837. class="phpdocumentor-element
  838. -method
  839. -protected
  840. "
  841. >
  842. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  843. setModuleValues()
  844. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  845. </h4>
  846. <aside class="phpdocumentor-element-found-in">
  847. <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>
  848. :
  849. <span class="phpdocumentor-element-found-in__line">73</span>
  850. </aside>
  851. <p class="phpdocumentor-summary">Sets the initial module values</p>
  852. <code class="phpdocumentor-code phpdocumentor-signature ">
  853. <span class="phpdocumentor-signature__visibility">protected</span>
  854. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  855. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  856. <span class="phpdocumentor-signature__response_type">void</span>
  857. &mdash;
  858. </article>
  859. <article
  860. class="phpdocumentor-element
  861. -method
  862. -protected
  863. "
  864. >
  865. <h4 class="phpdocumentor-element__name" id="method_setPixel">
  866. setPixel()
  867. <a href="classes/chillerlan-QRCode-Output-QRGdImage.html#method_setPixel" class="headerlink"><i class="fas fa-link"></i></a>
  868. </h4>
  869. <aside class="phpdocumentor-element-found-in">
  870. <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>
  871. :
  872. <span class="phpdocumentor-element-found-in__line">146</span>
  873. </aside>
  874. <p class="phpdocumentor-summary">Creates a single QR pixel with the given settings</p>
  875. <code class="phpdocumentor-code phpdocumentor-signature ">
  876. <span class="phpdocumentor-signature__visibility">protected</span>
  877. <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>
  878. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  879. <dl class="phpdocumentor-argument-list">
  880. <dt class="phpdocumentor-argument-list__entry">
  881. <span class="phpdocumentor-signature__argument__name">$x</span>
  882. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  883. </dt>
  884. <dd class="phpdocumentor-argument-list__definition">
  885. <section class="phpdocumentor-description"></section>
  886. </dd>
  887. <dt class="phpdocumentor-argument-list__entry">
  888. <span class="phpdocumentor-signature__argument__name">$y</span>
  889. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  890. </dt>
  891. <dd class="phpdocumentor-argument-list__definition">
  892. <section class="phpdocumentor-description"></section>
  893. </dd>
  894. <dt class="phpdocumentor-argument-list__entry">
  895. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  896. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  897. </dt>
  898. <dd class="phpdocumentor-argument-list__definition">
  899. <section class="phpdocumentor-description"></section>
  900. </dd>
  901. </dl>
  902. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  903. <span class="phpdocumentor-signature__response_type">void</span>
  904. &mdash;
  905. </article>
  906. </section>
  907. <script type="text/javascript">
  908. function loadExternalCodeSnippets(line) {
  909. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  910. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  911. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  912. var language = 'php';
  913. var code = document.createElement('code');
  914. code.className = 'language-' + language;
  915. pre.textContent = '';
  916. pre.setAttribute('data-line', line)
  917. code.textContent = 'Loading…';
  918. pre.appendChild(code);
  919. var xhr = new XMLHttpRequest();
  920. xhr.open('GET', src, true);
  921. xhr.onreadystatechange = function () {
  922. if (xhr.readyState == 4) {
  923. if (xhr.status < 400 && xhr.responseText) {
  924. code.textContent = xhr.responseText;
  925. Prism.highlightElement(code);
  926. }
  927. else if (xhr.status >= 400) {
  928. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  929. }
  930. else {
  931. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  932. }
  933. }
  934. };
  935. xhr.send(null);
  936. });
  937. }
  938. var modals = document.querySelectorAll("[data-modal]");
  939. modals.forEach(function (trigger) {
  940. trigger.addEventListener("click", function (event) {
  941. //event.preventDefault();
  942. const modal = document.getElementById(trigger.dataset.modal);
  943. modal.classList.add("phpdocumentor-modal__open");
  944. loadExternalCodeSnippets(trigger.dataset.line)
  945. const exits = modal.querySelectorAll("[data-exit-button]");
  946. exits.forEach(function (exit) {
  947. exit.addEventListener("click", function (event) {
  948. event.preventDefault();
  949. modal.classList.remove("phpdocumentor-modal__open");
  950. });
  951. });
  952. });
  953. });
  954. </script>
  955. </article>
  956. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  957. <section class="phpdocumentor-search-results__dialog">
  958. <header class="phpdocumentor-search-results__header">
  959. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  960. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  961. </header>
  962. <section class="phpdocumentor-search-results__body">
  963. <ul class="phpdocumentor-search-results__entries"></ul>
  964. </section>
  965. </section>
  966. </section>
  967. </div>
  968. </div>
  969. <a href="classes/chillerlan-QRCode-Output-QRImage.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  970. </main>
  971. <script>
  972. cssVars({});
  973. </script>
  974. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  975. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  976. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  977. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  978. </body>
  979. </html>