chillerlan-QRCode-Output-QRMarkup.html 52 KB

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