chillerlan-QRCode-Data-Byte.html 33 KB

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