chillerlan-QRCode-Data-QRDataModeInterface.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564
  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">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -interface">
  91. <h2 class="phpdocumentor-content__title">
  92. QRDataModeInterface
  93. <div class="phpdocumentor-element__package">
  94. in
  95. <ul class="phpdocumentor-breadcrumbs">
  96. <li><a href="packages/Application.html">Application</a></li>
  97. </ul>
  98. </div>
  99. </h2>
  100. <aside class="phpdocumentor-element-found-in">
  101. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeInterface.php"><a href="files/src-data-qrdatamodeinterface.html"><abbr title="src/Data/QRDataModeInterface.php">QRDataModeInterface.php</abbr></a></abbr>
  102. :
  103. <span class="phpdocumentor-element-found-in__line">18</span>
  104. </aside>
  105. <p class="phpdocumentor-summary">Specifies the methods reqired for the data modules (Number, Alphanum, Byte and Kanji)</p>
  106. <h3 id="toc">
  107. Table of Contents
  108. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  109. </h3>
  110. <dl class="phpdocumentor-table-of-contents">
  111. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  112. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#method_convertEncoding">convertEncoding()</a>
  113. <span>
  114. &nbsp;: string </span>
  115. </dt>
  116. <dd>encoding conversion helper</dd>
  117. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  118. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#method_decodeSegment">decodeSegment()</a>
  119. <span>
  120. &nbsp;: string </span>
  121. </dt>
  122. <dd>reads a segment from the BitBuffer and decodes in the current data mode</dd>
  123. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  124. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#method_getDataMode">getDataMode()</a>
  125. <span>
  126. &nbsp;: int </span>
  127. </dt>
  128. <dd>returns the current data mode constant</dd>
  129. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  130. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#method_getLengthInBits">getLengthInBits()</a>
  131. <span>
  132. &nbsp;: int </span>
  133. </dt>
  134. <dd>retruns the length in bits of the data string</dd>
  135. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  136. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#method_validateString">validateString()</a>
  137. <span>
  138. &nbsp;: bool </span>
  139. </dt>
  140. <dd>checks if the given string qualifies for the encoder module</dd>
  141. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  142. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#method_write">write()</a>
  143. <span>
  144. &nbsp;: void </span>
  145. </dt>
  146. <dd>writes the actual data string to the BitBuffer, uses the given version to determine the length bits</dd>
  147. </dl>
  148. <section class="phpdocumentor-methods">
  149. <h3 class="phpdocumentor-elements__header" id="methods">
  150. Methods
  151. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  152. </h3>
  153. <article
  154. class="phpdocumentor-element
  155. -method
  156. -public
  157. -static "
  158. >
  159. <h4 class="phpdocumentor-element__name" id="method_convertEncoding">
  160. convertEncoding()
  161. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#method_convertEncoding" class="headerlink"><i class="fas fa-link"></i></a>
  162. </h4>
  163. <aside class="phpdocumentor-element-found-in">
  164. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeInterface.php"><a href="files/src-data-qrdatamodeinterface.html"><abbr title="src/Data/QRDataModeInterface.php">QRDataModeInterface.php</abbr></a></abbr>
  165. :
  166. <span class="phpdocumentor-element-found-in__line">35</span>
  167. </aside>
  168. <p class="phpdocumentor-summary">encoding conversion helper</p>
  169. <code class="phpdocumentor-code phpdocumentor-signature ">
  170. <span class="phpdocumentor-signature__visibility">public</span>
  171. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">convertEncoding</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  172. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  173. <dl class="phpdocumentor-argument-list">
  174. <dt class="phpdocumentor-argument-list__entry">
  175. <span class="phpdocumentor-signature__argument__name">$string</span>
  176. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  177. </dt>
  178. <dd class="phpdocumentor-argument-list__definition">
  179. <section class="phpdocumentor-description"></section>
  180. </dd>
  181. </dl>
  182. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  183. Tags
  184. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  185. </h5>
  186. <dl class="phpdocumentor-tag-list">
  187. <dt class="phpdocumentor-tag-list__entry">
  188. <span class="phpdocumentor-tag__name">throws</span>
  189. </dt>
  190. <dd class="phpdocumentor-tag-list__definition">
  191. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  192. </dd>
  193. </dl>
  194. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  195. <span class="phpdocumentor-signature__response_type">string</span>
  196. &mdash;
  197. </article>
  198. <article
  199. class="phpdocumentor-element
  200. -method
  201. -public
  202. -static "
  203. >
  204. <h4 class="phpdocumentor-element__name" id="method_decodeSegment">
  205. decodeSegment()
  206. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#method_decodeSegment" class="headerlink"><i class="fas fa-link"></i></a>
  207. </h4>
  208. <aside class="phpdocumentor-element-found-in">
  209. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeInterface.php"><a href="files/src-data-qrdatamodeinterface.html"><abbr title="src/Data/QRDataModeInterface.php">QRDataModeInterface.php</abbr></a></abbr>
  210. :
  211. <span class="phpdocumentor-element-found-in__line">52</span>
  212. </aside>
  213. <p class="phpdocumentor-summary">reads a segment from the BitBuffer and decodes in the current data mode</p>
  214. <code class="phpdocumentor-code phpdocumentor-signature ">
  215. <span class="phpdocumentor-signature__visibility">public</span>
  216. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">decodeSegment</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bitBuffer</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$versionNumber</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  217. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  218. <dl class="phpdocumentor-argument-list">
  219. <dt class="phpdocumentor-argument-list__entry">
  220. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  221. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></span>
  222. </dt>
  223. <dd class="phpdocumentor-argument-list__definition">
  224. <section class="phpdocumentor-description"></section>
  225. </dd>
  226. <dt class="phpdocumentor-argument-list__entry">
  227. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  228. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  229. </dt>
  230. <dd class="phpdocumentor-argument-list__definition">
  231. <section class="phpdocumentor-description"></section>
  232. </dd>
  233. </dl>
  234. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  235. <span class="phpdocumentor-signature__response_type">string</span>
  236. &mdash;
  237. </article>
  238. <article
  239. class="phpdocumentor-element
  240. -method
  241. -public
  242. "
  243. >
  244. <h4 class="phpdocumentor-element__name" id="method_getDataMode">
  245. getDataMode()
  246. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#method_getDataMode" class="headerlink"><i class="fas fa-link"></i></a>
  247. </h4>
  248. <aside class="phpdocumentor-element-found-in">
  249. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeInterface.php"><a href="files/src-data-qrdatamodeinterface.html"><abbr title="src/Data/QRDataModeInterface.php">QRDataModeInterface.php</abbr></a></abbr>
  250. :
  251. <span class="phpdocumentor-element-found-in__line">23</span>
  252. </aside>
  253. <p class="phpdocumentor-summary">returns the current data mode constant</p>
  254. <code class="phpdocumentor-code phpdocumentor-signature ">
  255. <span class="phpdocumentor-signature__visibility">public</span>
  256. <span class="phpdocumentor-signature__name">getDataMode</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  257. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  258. <span class="phpdocumentor-signature__response_type">int</span>
  259. &mdash;
  260. </article>
  261. <article
  262. class="phpdocumentor-element
  263. -method
  264. -public
  265. "
  266. >
  267. <h4 class="phpdocumentor-element__name" id="method_getLengthInBits">
  268. getLengthInBits()
  269. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#method_getLengthInBits" class="headerlink"><i class="fas fa-link"></i></a>
  270. </h4>
  271. <aside class="phpdocumentor-element-found-in">
  272. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeInterface.php"><a href="files/src-data-qrdatamodeinterface.html"><abbr title="src/Data/QRDataModeInterface.php">QRDataModeInterface.php</abbr></a></abbr>
  273. :
  274. <span class="phpdocumentor-element-found-in__line">28</span>
  275. </aside>
  276. <p class="phpdocumentor-summary">retruns the length in bits of the data string</p>
  277. <code class="phpdocumentor-code phpdocumentor-signature ">
  278. <span class="phpdocumentor-signature__visibility">public</span>
  279. <span class="phpdocumentor-signature__name">getLengthInBits</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  280. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  281. <span class="phpdocumentor-signature__response_type">int</span>
  282. &mdash;
  283. </article>
  284. <article
  285. class="phpdocumentor-element
  286. -method
  287. -public
  288. -static "
  289. >
  290. <h4 class="phpdocumentor-element__name" id="method_validateString">
  291. validateString()
  292. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#method_validateString" class="headerlink"><i class="fas fa-link"></i></a>
  293. </h4>
  294. <aside class="phpdocumentor-element-found-in">
  295. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeInterface.php"><a href="files/src-data-qrdatamodeinterface.html"><abbr title="src/Data/QRDataModeInterface.php">QRDataModeInterface.php</abbr></a></abbr>
  296. :
  297. <span class="phpdocumentor-element-found-in__line">40</span>
  298. </aside>
  299. <p class="phpdocumentor-summary">checks if the given string qualifies for the encoder module</p>
  300. <code class="phpdocumentor-code phpdocumentor-signature ">
  301. <span class="phpdocumentor-signature__visibility">public</span>
  302. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">validateString</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  303. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  304. <dl class="phpdocumentor-argument-list">
  305. <dt class="phpdocumentor-argument-list__entry">
  306. <span class="phpdocumentor-signature__argument__name">$string</span>
  307. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  308. </dt>
  309. <dd class="phpdocumentor-argument-list__definition">
  310. <section class="phpdocumentor-description"></section>
  311. </dd>
  312. </dl>
  313. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  314. <span class="phpdocumentor-signature__response_type">bool</span>
  315. &mdash;
  316. </article>
  317. <article
  318. class="phpdocumentor-element
  319. -method
  320. -public
  321. "
  322. >
  323. <h4 class="phpdocumentor-element__name" id="method_write">
  324. write()
  325. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#method_write" class="headerlink"><i class="fas fa-link"></i></a>
  326. </h4>
  327. <aside class="phpdocumentor-element-found-in">
  328. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeInterface.php"><a href="files/src-data-qrdatamodeinterface.html"><abbr title="src/Data/QRDataModeInterface.php">QRDataModeInterface.php</abbr></a></abbr>
  329. :
  330. <span class="phpdocumentor-element-found-in__line">47</span>
  331. </aside>
  332. <p class="phpdocumentor-summary">writes the actual data string to the BitBuffer, uses the given version to determine the length bits</p>
  333. <code class="phpdocumentor-code phpdocumentor-signature ">
  334. <span class="phpdocumentor-signature__visibility">public</span>
  335. <span class="phpdocumentor-signature__name">write</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$bitBuffer</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$versionNumber</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  336. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  337. <dl class="phpdocumentor-argument-list">
  338. <dt class="phpdocumentor-argument-list__entry">
  339. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  340. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-BitBuffer.html"><abbr title="\chillerlan\QRCode\Common\BitBuffer">BitBuffer</abbr></a></span>
  341. </dt>
  342. <dd class="phpdocumentor-argument-list__definition">
  343. <section class="phpdocumentor-description"></section>
  344. </dd>
  345. <dt class="phpdocumentor-argument-list__entry">
  346. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  347. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  348. </dt>
  349. <dd class="phpdocumentor-argument-list__definition">
  350. <section class="phpdocumentor-description"></section>
  351. </dd>
  352. </dl>
  353. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  354. Tags
  355. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  356. </h5>
  357. <dl class="phpdocumentor-tag-list">
  358. <dt class="phpdocumentor-tag-list__entry">
  359. <span class="phpdocumentor-tag__name">see</span>
  360. </dt>
  361. <dd class="phpdocumentor-tag-list__definition">
  362. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRData.html#method_writeBitBuffer"><abbr title="\chillerlan\QRCode\Data\QRData::writeBitBuffer()">QRData::writeBitBuffer()</abbr></a></span>
  363. </dd>
  364. </dl>
  365. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  366. <span class="phpdocumentor-signature__response_type">void</span>
  367. &mdash;
  368. </article>
  369. </section>
  370. <script type="text/javascript">
  371. function loadExternalCodeSnippets(line) {
  372. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  373. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  374. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  375. var language = 'php';
  376. var code = document.createElement('code');
  377. code.className = 'language-' + language;
  378. pre.textContent = '';
  379. pre.setAttribute('data-line', line)
  380. code.textContent = 'Loading…';
  381. pre.appendChild(code);
  382. var xhr = new XMLHttpRequest();
  383. xhr.open('GET', src, true);
  384. xhr.onreadystatechange = function () {
  385. if (xhr.readyState == 4) {
  386. if (xhr.status < 400 && xhr.responseText) {
  387. code.textContent = xhr.responseText;
  388. Prism.highlightElement(code);
  389. }
  390. else if (xhr.status >= 400) {
  391. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  392. }
  393. else {
  394. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  395. }
  396. }
  397. };
  398. xhr.send(null);
  399. });
  400. }
  401. var modals = document.querySelectorAll("[data-modal]");
  402. modals.forEach(function (trigger) {
  403. trigger.addEventListener("click", function (event) {
  404. //event.preventDefault();
  405. const modal = document.getElementById(trigger.dataset.modal);
  406. modal.classList.add("phpdocumentor-modal__open");
  407. loadExternalCodeSnippets(trigger.dataset.line)
  408. const exits = modal.querySelectorAll("[data-exit-button]");
  409. exits.forEach(function (exit) {
  410. exit.addEventListener("click", function (event) {
  411. event.preventDefault();
  412. modal.classList.remove("phpdocumentor-modal__open");
  413. });
  414. });
  415. });
  416. });
  417. </script>
  418. </article>
  419. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  420. <section class="phpdocumentor-search-results__dialog">
  421. <header class="phpdocumentor-search-results__header">
  422. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  423. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  424. </header>
  425. <section class="phpdocumentor-search-results__body">
  426. <ul class="phpdocumentor-search-results__entries"></ul>
  427. </section>
  428. </section>
  429. </section>
  430. </div>
  431. </div>
  432. <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  433. </main>
  434. <script>
  435. cssVars({});
  436. </script>
  437. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  438. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  439. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  440. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  441. </body>
  442. </html>