chillerlan-QRCode-Output-QRString.html 52 KB

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