chillerlan-QRCode-Output-QRString.html 57 KB

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