chillerlan-QRCode-Data-Kanji.html 35 KB

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