chillerlan-QRCode-Data-Byte.html 39 KB

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