chillerlan-QRCode-Data-Byte.html 39 KB

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