chillerlan-QRCode-Data-ECI.html 39 KB

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