chillerlan-QRCode-Output-QRImage.html 57 KB

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