chillerlan-QRCode-Data-Byte.html 38 KB

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