chillerlan-QRCode-Data-Byte.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772
  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 -class">
  91. <h2 class="phpdocumentor-content__title">
  92. Byte
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeAbstract">QRDataModeAbstract</abbr></a>
  95. </span>
  96. <div class="phpdocumentor-element__package">
  97. in package
  98. <ul class="phpdocumentor-breadcrumbs">
  99. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  100. </ul>
  101. </div>
  102. </h2>
  103. <aside class="phpdocumentor-element-found-in">
  104. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/Byte.php"><a href="files/src-data-byte.html"><abbr title="src/Data/Byte.php">Byte.php</abbr></a></abbr>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">23</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">Byte mode, ISO-8859-1 or UTF-8</p>
  109. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 Section 8.3.4
  110. ISO/IEC 18004:2000 Section 8.4.4</p>
  111. </section>
  112. <h3 id="toc">
  113. Table of Contents
  114. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  115. </h3>
  116. <dl class="phpdocumentor-table-of-contents">
  117. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  118. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data">$data</a>
  119. <span>
  120. &nbsp;: string </span>
  121. </dt>
  122. <dd>The data to write</dd>
  123. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  124. <a href="classes/chillerlan-QRCode-Data-Byte.html#property_datamode">$datamode</a>
  125. <span>
  126. &nbsp;: int </span>
  127. </dt>
  128. <dd>the current data mode: Num, Alphanum, Kanji, Byte</dd>
  129. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  130. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct">__construct()</a>
  131. <span>
  132. &nbsp;: mixed </span>
  133. </dt>
  134. <dd>QRDataModeAbstract constructor.</dd>
  135. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  136. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_decodeSegment">decodeSegment()</a>
  137. <span>
  138. &nbsp;: string </span>
  139. </dt>
  140. <dd></dd>
  141. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  142. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getDataMode">getDataMode()</a>
  143. <span>
  144. &nbsp;: int </span>
  145. </dt>
  146. <dd>returns the current data mode constant</dd>
  147. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  148. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_getLengthInBits">getLengthInBits()</a>
  149. <span>
  150. &nbsp;: int </span>
  151. </dt>
  152. <dd></dd>
  153. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  154. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_validateString">validateString()</a>
  155. <span>
  156. &nbsp;: bool </span>
  157. </dt>
  158. <dd></dd>
  159. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  160. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_write">write()</a>
  161. <span>
  162. &nbsp;: void </span>
  163. </dt>
  164. <dd></dd>
  165. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  166. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount">getCharCount()</a>
  167. <span>
  168. &nbsp;: int </span>
  169. </dt>
  170. <dd>returns the character count of the $data string</dd>
  171. </dl>
  172. <section class="phpdocumentor-properties">
  173. <h3 class="phpdocumentor-elements__header" id="properties">
  174. Properties
  175. <a href="classes/chillerlan-QRCode-Data-Byte.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  176. </h3>
  177. <article
  178. class="
  179. phpdocumentor-element
  180. -property
  181. -protected
  182. "
  183. >
  184. <h4 class="phpdocumentor-element__name" id="property_data">
  185. $data
  186. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data" class="headerlink"><i class="fas fa-link"></i></a>
  187. <span class="phpdocumentor-element__modifiers">
  188. </span>
  189. </h4>
  190. <aside class="phpdocumentor-element-found-in">
  191. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeAbstract.php"><a href="files/src-data-qrdatamodeabstract.html"><abbr title="src/Data/QRDataModeAbstract.php">QRDataModeAbstract.php</abbr></a></abbr>
  192. :
  193. <span class="phpdocumentor-element-found-in__line">25</span>
  194. </aside>
  195. <p class="phpdocumentor-summary">The data to write</p>
  196. <code class="phpdocumentor-code phpdocumentor-signature ">
  197. <span class="phpdocumentor-signature__visibility">protected</span>
  198. <span class="phpdocumentor-signature__type">string</span>
  199. <span class="phpdocumentor-signature__name">$data</span>
  200. </code>
  201. <section class="phpdocumentor-description"></section>
  202. </article>
  203. <article
  204. class="
  205. phpdocumentor-element
  206. -property
  207. -protected
  208. -static "
  209. >
  210. <h4 class="phpdocumentor-element__name" id="property_datamode">
  211. $datamode
  212. <a href="classes/chillerlan-QRCode-Data-Byte.html#property_datamode" class="headerlink"><i class="fas fa-link"></i></a>
  213. <span class="phpdocumentor-element__modifiers">
  214. </span>
  215. </h4>
  216. <aside class="phpdocumentor-element-found-in">
  217. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/Byte.php"><a href="files/src-data-byte.html"><abbr title="src/Data/Byte.php">Byte.php</abbr></a></abbr>
  218. :
  219. <span class="phpdocumentor-element-found-in__line">28</span>
  220. </aside>
  221. <p class="phpdocumentor-summary">the current data mode: Num, Alphanum, Kanji, Byte</p>
  222. <code class="phpdocumentor-code phpdocumentor-signature ">
  223. <span class="phpdocumentor-signature__visibility">protected</span>
  224. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">int</span>
  225. <span class="phpdocumentor-signature__name">$datamode</span>
  226. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Mode::BYTE</span></code>
  227. <section class="phpdocumentor-description"></section>
  228. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  229. Tags
  230. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  231. </h5>
  232. <dl class="phpdocumentor-tag-list">
  233. <dt class="phpdocumentor-tag-list__entry">
  234. <span class="phpdocumentor-tag__name">inheritDoc</span>
  235. </dt>
  236. <dd class="phpdocumentor-tag-list__definition">
  237. </dd>
  238. </dl>
  239. </article>
  240. </section>
  241. <section class="phpdocumentor-methods">
  242. <h3 class="phpdocumentor-elements__header" id="methods">
  243. Methods
  244. <a href="classes/chillerlan-QRCode-Data-Byte.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  245. </h3>
  246. <article
  247. class="phpdocumentor-element
  248. -method
  249. -public
  250. "
  251. >
  252. <h4 class="phpdocumentor-element__name" id="method___construct">
  253. __construct()
  254. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  255. </h4>
  256. <aside class="phpdocumentor-element-found-in">
  257. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeAbstract.php"><a href="files/src-data-qrdatamodeabstract.html"><abbr title="src/Data/QRDataModeAbstract.php">QRDataModeAbstract.php</abbr></a></abbr>
  258. :
  259. <span class="phpdocumentor-element-found-in__line">32</span>
  260. </aside>
  261. <p class="phpdocumentor-summary">QRDataModeAbstract constructor.</p>
  262. <code class="phpdocumentor-code phpdocumentor-signature ">
  263. <span class="phpdocumentor-signature__visibility">public</span>
  264. <span class="phpdocumentor-signature__name">__construct</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>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  265. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  266. <dl class="phpdocumentor-argument-list">
  267. <dt class="phpdocumentor-argument-list__entry">
  268. <span class="phpdocumentor-signature__argument__name">$data</span>
  269. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  270. </dt>
  271. <dd class="phpdocumentor-argument-list__definition">
  272. <section class="phpdocumentor-description"></section>
  273. </dd>
  274. </dl>
  275. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  276. Tags
  277. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  278. </h5>
  279. <dl class="phpdocumentor-tag-list">
  280. <dt class="phpdocumentor-tag-list__entry">
  281. <span class="phpdocumentor-tag__name">throws</span>
  282. </dt>
  283. <dd class="phpdocumentor-tag-list__definition">
  284. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  285. </dd>
  286. </dl>
  287. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  288. <span class="phpdocumentor-signature__response_type">mixed</span>
  289. &mdash;
  290. </article>
  291. <article
  292. class="phpdocumentor-element
  293. -method
  294. -public
  295. -static "
  296. >
  297. <h4 class="phpdocumentor-element__name" id="method_decodeSegment">
  298. decodeSegment()
  299. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_decodeSegment" class="headerlink"><i class="fas fa-link"></i></a>
  300. </h4>
  301. <aside class="phpdocumentor-element-found-in">
  302. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/Byte.php"><a href="files/src-data-byte.html"><abbr title="src/Data/Byte.php">Byte.php</abbr></a></abbr>
  303. :
  304. <span class="phpdocumentor-element-found-in__line">69</span>
  305. </aside>
  306. <code class="phpdocumentor-code phpdocumentor-signature ">
  307. <span class="phpdocumentor-signature__visibility">public</span>
  308. <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>
  309. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  310. <dl class="phpdocumentor-argument-list">
  311. <dt class="phpdocumentor-argument-list__entry">
  312. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  313. : <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>
  314. </dt>
  315. <dd class="phpdocumentor-argument-list__definition">
  316. <section class="phpdocumentor-description"></section>
  317. </dd>
  318. <dt class="phpdocumentor-argument-list__entry">
  319. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  320. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  321. </dt>
  322. <dd class="phpdocumentor-argument-list__definition">
  323. <section class="phpdocumentor-description"></section>
  324. </dd>
  325. </dl>
  326. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  327. Tags
  328. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  329. </h5>
  330. <dl class="phpdocumentor-tag-list">
  331. <dt class="phpdocumentor-tag-list__entry">
  332. <span class="phpdocumentor-tag__name">inheritDoc</span>
  333. </dt>
  334. <dd class="phpdocumentor-tag-list__definition">
  335. </dd>
  336. <dt class="phpdocumentor-tag-list__entry">
  337. <span class="phpdocumentor-tag__name">throws</span>
  338. </dt>
  339. <dd class="phpdocumentor-tag-list__definition">
  340. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  341. </dd>
  342. </dl>
  343. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  344. <span class="phpdocumentor-signature__response_type">string</span>
  345. &mdash;
  346. </article>
  347. <article
  348. class="phpdocumentor-element
  349. -method
  350. -public
  351. "
  352. >
  353. <h4 class="phpdocumentor-element__name" id="method_getDataMode">
  354. getDataMode()
  355. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getDataMode" class="headerlink"><i class="fas fa-link"></i></a>
  356. </h4>
  357. <aside class="phpdocumentor-element-found-in">
  358. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeAbstract.php"><a href="files/src-data-qrdatamodeabstract.html"><abbr title="src/Data/QRDataModeAbstract.php">QRDataModeAbstract.php</abbr></a></abbr>
  359. :
  360. <span class="phpdocumentor-element-found-in__line">51</span>
  361. </aside>
  362. <p class="phpdocumentor-summary">returns the current data mode constant</p>
  363. <code class="phpdocumentor-code phpdocumentor-signature ">
  364. <span class="phpdocumentor-signature__visibility">public</span>
  365. <span class="phpdocumentor-signature__name">getDataMode</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  366. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  367. Tags
  368. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  369. </h5>
  370. <dl class="phpdocumentor-tag-list">
  371. <dt class="phpdocumentor-tag-list__entry">
  372. <span class="phpdocumentor-tag__name">inheritDoc</span>
  373. </dt>
  374. <dd class="phpdocumentor-tag-list__definition">
  375. </dd>
  376. </dl>
  377. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  378. <span class="phpdocumentor-signature__response_type">int</span>
  379. &mdash;
  380. </article>
  381. <article
  382. class="phpdocumentor-element
  383. -method
  384. -public
  385. "
  386. >
  387. <h4 class="phpdocumentor-element__name" id="method_getLengthInBits">
  388. getLengthInBits()
  389. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_getLengthInBits" class="headerlink"><i class="fas fa-link"></i></a>
  390. </h4>
  391. <aside class="phpdocumentor-element-found-in">
  392. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/Byte.php"><a href="files/src-data-byte.html"><abbr title="src/Data/Byte.php">Byte.php</abbr></a></abbr>
  393. :
  394. <span class="phpdocumentor-element-found-in__line">33</span>
  395. </aside>
  396. <code class="phpdocumentor-code phpdocumentor-signature ">
  397. <span class="phpdocumentor-signature__visibility">public</span>
  398. <span class="phpdocumentor-signature__name">getLengthInBits</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  399. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  400. Tags
  401. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  402. </h5>
  403. <dl class="phpdocumentor-tag-list">
  404. <dt class="phpdocumentor-tag-list__entry">
  405. <span class="phpdocumentor-tag__name">inheritDoc</span>
  406. </dt>
  407. <dd class="phpdocumentor-tag-list__definition">
  408. </dd>
  409. </dl>
  410. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  411. <span class="phpdocumentor-signature__response_type">int</span>
  412. &mdash;
  413. </article>
  414. <article
  415. class="phpdocumentor-element
  416. -method
  417. -public
  418. -static "
  419. >
  420. <h4 class="phpdocumentor-element__name" id="method_validateString">
  421. validateString()
  422. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_validateString" class="headerlink"><i class="fas fa-link"></i></a>
  423. </h4>
  424. <aside class="phpdocumentor-element-found-in">
  425. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/Byte.php"><a href="files/src-data-byte.html"><abbr title="src/Data/Byte.php">Byte.php</abbr></a></abbr>
  426. :
  427. <span class="phpdocumentor-element-found-in__line">40</span>
  428. </aside>
  429. <code class="phpdocumentor-code phpdocumentor-signature ">
  430. <span class="phpdocumentor-signature__visibility">public</span>
  431. <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>
  432. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  433. <dl class="phpdocumentor-argument-list">
  434. <dt class="phpdocumentor-argument-list__entry">
  435. <span class="phpdocumentor-signature__argument__name">$string</span>
  436. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  437. </dt>
  438. <dd class="phpdocumentor-argument-list__definition">
  439. <section class="phpdocumentor-description"></section>
  440. </dd>
  441. </dl>
  442. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  443. Tags
  444. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  445. </h5>
  446. <dl class="phpdocumentor-tag-list">
  447. <dt class="phpdocumentor-tag-list__entry">
  448. <span class="phpdocumentor-tag__name">inheritDoc</span>
  449. </dt>
  450. <dd class="phpdocumentor-tag-list__definition">
  451. </dd>
  452. </dl>
  453. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  454. <span class="phpdocumentor-signature__response_type">bool</span>
  455. &mdash;
  456. </article>
  457. <article
  458. class="phpdocumentor-element
  459. -method
  460. -public
  461. "
  462. >
  463. <h4 class="phpdocumentor-element__name" id="method_write">
  464. write()
  465. <a href="classes/chillerlan-QRCode-Data-Byte.html#method_write" class="headerlink"><i class="fas fa-link"></i></a>
  466. </h4>
  467. <aside class="phpdocumentor-element-found-in">
  468. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/Byte.php"><a href="files/src-data-byte.html"><abbr title="src/Data/Byte.php">Byte.php</abbr></a></abbr>
  469. :
  470. <span class="phpdocumentor-element-found-in__line">47</span>
  471. </aside>
  472. <code class="phpdocumentor-code phpdocumentor-signature ">
  473. <span class="phpdocumentor-signature__visibility">public</span>
  474. <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>
  475. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  476. <dl class="phpdocumentor-argument-list">
  477. <dt class="phpdocumentor-argument-list__entry">
  478. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  479. : <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>
  480. </dt>
  481. <dd class="phpdocumentor-argument-list__definition">
  482. <section class="phpdocumentor-description"></section>
  483. </dd>
  484. <dt class="phpdocumentor-argument-list__entry">
  485. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  486. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  487. </dt>
  488. <dd class="phpdocumentor-argument-list__definition">
  489. <section class="phpdocumentor-description"></section>
  490. </dd>
  491. </dl>
  492. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  493. Tags
  494. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  495. </h5>
  496. <dl class="phpdocumentor-tag-list">
  497. <dt class="phpdocumentor-tag-list__entry">
  498. <span class="phpdocumentor-tag__name">inheritDoc</span>
  499. </dt>
  500. <dd class="phpdocumentor-tag-list__definition">
  501. </dd>
  502. </dl>
  503. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  504. <span class="phpdocumentor-signature__response_type">void</span>
  505. &mdash;
  506. </article>
  507. <article
  508. class="phpdocumentor-element
  509. -method
  510. -protected
  511. "
  512. >
  513. <h4 class="phpdocumentor-element__name" id="method_getCharCount">
  514. getCharCount()
  515. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount" class="headerlink"><i class="fas fa-link"></i></a>
  516. </h4>
  517. <aside class="phpdocumentor-element-found-in">
  518. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/QRDataModeAbstract.php"><a href="files/src-data-qrdatamodeabstract.html"><abbr title="src/Data/QRDataModeAbstract.php">QRDataModeAbstract.php</abbr></a></abbr>
  519. :
  520. <span class="phpdocumentor-element-found-in__line">44</span>
  521. </aside>
  522. <p class="phpdocumentor-summary">returns the character count of the $data string</p>
  523. <code class="phpdocumentor-code phpdocumentor-signature ">
  524. <span class="phpdocumentor-signature__visibility">protected</span>
  525. <span class="phpdocumentor-signature__name">getCharCount</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  526. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  527. <span class="phpdocumentor-signature__response_type">int</span>
  528. &mdash;
  529. </article>
  530. </section>
  531. <script type="text/javascript">
  532. function loadExternalCodeSnippets(line) {
  533. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  534. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  535. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  536. var language = 'php';
  537. var code = document.createElement('code');
  538. code.className = 'language-' + language;
  539. pre.textContent = '';
  540. pre.setAttribute('data-line', line)
  541. code.textContent = 'Loading…';
  542. pre.appendChild(code);
  543. var xhr = new XMLHttpRequest();
  544. xhr.open('GET', src, true);
  545. xhr.onreadystatechange = function () {
  546. if (xhr.readyState == 4) {
  547. if (xhr.status < 400 && xhr.responseText) {
  548. code.textContent = xhr.responseText;
  549. Prism.highlightElement(code);
  550. }
  551. else if (xhr.status >= 400) {
  552. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  553. }
  554. else {
  555. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  556. }
  557. }
  558. };
  559. xhr.send(null);
  560. });
  561. }
  562. var modals = document.querySelectorAll("[data-modal]");
  563. modals.forEach(function (trigger) {
  564. trigger.addEventListener("click", function (event) {
  565. //event.preventDefault();
  566. const modal = document.getElementById(trigger.dataset.modal);
  567. modal.classList.add("phpdocumentor-modal__open");
  568. loadExternalCodeSnippets(trigger.dataset.line)
  569. const exits = modal.querySelectorAll("[data-exit-button]");
  570. exits.forEach(function (exit) {
  571. exit.addEventListener("click", function (event) {
  572. event.preventDefault();
  573. modal.classList.remove("phpdocumentor-modal__open");
  574. });
  575. });
  576. });
  577. });
  578. </script>
  579. </article>
  580. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  581. <section class="phpdocumentor-search-results__dialog">
  582. <header class="phpdocumentor-search-results__header">
  583. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  584. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  585. </header>
  586. <section class="phpdocumentor-search-results__body">
  587. <ul class="phpdocumentor-search-results__entries"></ul>
  588. </section>
  589. </section>
  590. </section>
  591. </div>
  592. </div>
  593. <a href="classes/chillerlan-QRCode-Data-Byte.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  594. </main>
  595. <script>
  596. cssVars({});
  597. </script>
  598. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  599. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  600. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  601. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  602. </body>
  603. </html>