chillerlan-QRCode-Output-QROutputAbstract.html 60 KB

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