chillerlan-QRCode-Data-ECI.html 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875
  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">25</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::ECI</span></code>
  234. <section class="phpdocumentor-description"></section>
  235. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  236. Tags
  237. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  238. </h5>
  239. <dl class="phpdocumentor-tag-list">
  240. <dt class="phpdocumentor-tag-list__entry">
  241. <span class="phpdocumentor-tag__name">inheritDoc</span>
  242. </dt>
  243. <dd class="phpdocumentor-tag-list__definition">
  244. </dd>
  245. </dl>
  246. </article>
  247. <article
  248. class="
  249. phpdocumentor-element
  250. -property
  251. -private
  252. "
  253. >
  254. <h4 class="phpdocumentor-element__name" id="property_encoding">
  255. $encoding
  256. <a href="classes/chillerlan-QRCode-Data-ECI.html#property_encoding" class="headerlink"><i class="fas fa-link"></i></a>
  257. <span class="phpdocumentor-element__modifiers">
  258. </span>
  259. </h4>
  260. <aside class="phpdocumentor-element-found-in">
  261. <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>
  262. :
  263. <span class="phpdocumentor-element-found-in__line">30</span>
  264. </aside>
  265. <p class="phpdocumentor-summary">The current ECI encoding id</p>
  266. <code class="phpdocumentor-code phpdocumentor-signature ">
  267. <span class="phpdocumentor-signature__visibility">private</span>
  268. <span class="phpdocumentor-signature__type">int</span>
  269. <span class="phpdocumentor-signature__name">$encoding</span>
  270. </code>
  271. <section class="phpdocumentor-description"></section>
  272. </article>
  273. </section>
  274. <section class="phpdocumentor-methods">
  275. <h3 class="phpdocumentor-elements__header" id="methods">
  276. Methods
  277. <a href="classes/chillerlan-QRCode-Data-ECI.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  278. </h3>
  279. <article
  280. class="phpdocumentor-element
  281. -method
  282. -public
  283. "
  284. >
  285. <h4 class="phpdocumentor-element__name" id="method___construct">
  286. __construct()
  287. <a href="classes/chillerlan-QRCode-Data-ECI.html#method___construct" 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/ECI.php"><a href="files/src-data-eci.html"><abbr title="src/Data/ECI.php">ECI.php</abbr></a></abbr>
  291. :
  292. <span class="phpdocumentor-element-found-in__line">36</span>
  293. </aside>
  294. <p class="phpdocumentor-summary">QRDataModeAbstract constructor.</p>
  295. <code class="phpdocumentor-code phpdocumentor-signature ">
  296. <span class="phpdocumentor-signature__visibility">public</span>
  297. <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>
  298. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  299. <dl class="phpdocumentor-argument-list">
  300. <dt class="phpdocumentor-argument-list__entry">
  301. <span class="phpdocumentor-signature__argument__name">$encoding</span>
  302. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  303. </dt>
  304. <dd class="phpdocumentor-argument-list__definition">
  305. <section class="phpdocumentor-description"></section>
  306. </dd>
  307. </dl>
  308. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  309. Tags
  310. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  311. </h5>
  312. <dl class="phpdocumentor-tag-list">
  313. <dt class="phpdocumentor-tag-list__entry">
  314. <span class="phpdocumentor-tag__name">inheritDoc</span>
  315. </dt>
  316. <dd class="phpdocumentor-tag-list__definition">
  317. </dd>
  318. <dt class="phpdocumentor-tag-list__entry">
  319. <span class="phpdocumentor-tag__name">noinspection</span>
  320. </dt>
  321. <dd class="phpdocumentor-tag-list__definition">
  322. <section class="phpdocumentor-description"><p>PhpMissingParentConstructorInspection</p>
  323. </section>
  324. </dd>
  325. </dl>
  326. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  327. <span class="phpdocumentor-signature__response_type">mixed</span>
  328. &mdash;
  329. </article>
  330. <article
  331. class="phpdocumentor-element
  332. -method
  333. -public
  334. -static "
  335. >
  336. <h4 class="phpdocumentor-element__name" id="method_decodeSegment">
  337. decodeSegment()
  338. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_decodeSegment" class="headerlink"><i class="fas fa-link"></i></a>
  339. </h4>
  340. <aside class="phpdocumentor-element-found-in">
  341. <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>
  342. :
  343. <span class="phpdocumentor-element-found-in__line">91</span>
  344. </aside>
  345. <code class="phpdocumentor-code phpdocumentor-signature ">
  346. <span class="phpdocumentor-signature__visibility">public</span>
  347. <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>
  348. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  349. <dl class="phpdocumentor-argument-list">
  350. <dt class="phpdocumentor-argument-list__entry">
  351. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  352. : <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>
  353. </dt>
  354. <dd class="phpdocumentor-argument-list__definition">
  355. <section class="phpdocumentor-description"></section>
  356. </dd>
  357. <dt class="phpdocumentor-argument-list__entry">
  358. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  359. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  360. </dt>
  361. <dd class="phpdocumentor-argument-list__definition">
  362. <section class="phpdocumentor-description"></section>
  363. </dd>
  364. </dl>
  365. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  366. Tags
  367. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  368. </h5>
  369. <dl class="phpdocumentor-tag-list">
  370. <dt class="phpdocumentor-tag-list__entry">
  371. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  372. </dt>
  373. <dd class="phpdocumentor-tag-list__definition">
  374. <section class="phpdocumentor-description"><p>Unused, but required as per interface</p>
  375. </section>
  376. </dd>
  377. </dl>
  378. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  379. <span class="phpdocumentor-signature__response_type">string</span>
  380. &mdash;
  381. </article>
  382. <article
  383. class="phpdocumentor-element
  384. -method
  385. -public
  386. "
  387. >
  388. <h4 class="phpdocumentor-element__name" id="method_getDataMode">
  389. getDataMode()
  390. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getDataMode" class="headerlink"><i class="fas fa-link"></i></a>
  391. </h4>
  392. <aside class="phpdocumentor-element-found-in">
  393. <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>
  394. :
  395. <span class="phpdocumentor-element-found-in__line">51</span>
  396. </aside>
  397. <p class="phpdocumentor-summary">returns the current data mode constant</p>
  398. <code class="phpdocumentor-code phpdocumentor-signature ">
  399. <span class="phpdocumentor-signature__visibility">public</span>
  400. <span class="phpdocumentor-signature__name">getDataMode</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  401. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  402. Tags
  403. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  404. </h5>
  405. <dl class="phpdocumentor-tag-list">
  406. <dt class="phpdocumentor-tag-list__entry">
  407. <span class="phpdocumentor-tag__name">inheritDoc</span>
  408. </dt>
  409. <dd class="phpdocumentor-tag-list__definition">
  410. </dd>
  411. </dl>
  412. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  413. <span class="phpdocumentor-signature__response_type">int</span>
  414. &mdash;
  415. </article>
  416. <article
  417. class="phpdocumentor-element
  418. -method
  419. -public
  420. "
  421. >
  422. <h4 class="phpdocumentor-element__name" id="method_getLengthInBits">
  423. getLengthInBits()
  424. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_getLengthInBits" class="headerlink"><i class="fas fa-link"></i></a>
  425. </h4>
  426. <aside class="phpdocumentor-element-found-in">
  427. <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>
  428. :
  429. <span class="phpdocumentor-element-found-in__line">43</span>
  430. </aside>
  431. <code class="phpdocumentor-code phpdocumentor-signature ">
  432. <span class="phpdocumentor-signature__visibility">public</span>
  433. <span class="phpdocumentor-signature__name">getLengthInBits</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  434. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  435. Tags
  436. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  437. </h5>
  438. <dl class="phpdocumentor-tag-list">
  439. <dt class="phpdocumentor-tag-list__entry">
  440. <span class="phpdocumentor-tag__name">inheritDoc</span>
  441. </dt>
  442. <dd class="phpdocumentor-tag-list__definition">
  443. </dd>
  444. </dl>
  445. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  446. <span class="phpdocumentor-signature__response_type">int</span>
  447. &mdash;
  448. </article>
  449. <article
  450. class="phpdocumentor-element
  451. -method
  452. -public
  453. -static "
  454. >
  455. <h4 class="phpdocumentor-element__name" id="method_parseValue">
  456. parseValue()
  457. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_parseValue" class="headerlink"><i class="fas fa-link"></i></a>
  458. </h4>
  459. <aside class="phpdocumentor-element-found-in">
  460. <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>
  461. :
  462. <span class="phpdocumentor-element-found-in__line">60</span>
  463. </aside>
  464. <code class="phpdocumentor-code phpdocumentor-signature ">
  465. <span class="phpdocumentor-signature__visibility">public</span>
  466. <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>
  467. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  468. <dl class="phpdocumentor-argument-list">
  469. <dt class="phpdocumentor-argument-list__entry">
  470. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  471. : <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>
  472. </dt>
  473. <dd class="phpdocumentor-argument-list__definition">
  474. <section class="phpdocumentor-description"></section>
  475. </dd>
  476. </dl>
  477. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  478. Tags
  479. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  480. </h5>
  481. <dl class="phpdocumentor-tag-list">
  482. <dt class="phpdocumentor-tag-list__entry">
  483. <span class="phpdocumentor-tag__name">throws</span>
  484. </dt>
  485. <dd class="phpdocumentor-tag-list__definition">
  486. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  487. </dd>
  488. </dl>
  489. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  490. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-ECICharset.html"><abbr title="\chillerlan\QRCode\Common\ECICharset">ECICharset</abbr></a></span>
  491. &mdash;
  492. </article>
  493. <article
  494. class="phpdocumentor-element
  495. -method
  496. -public
  497. -static "
  498. >
  499. <h4 class="phpdocumentor-element__name" id="method_validateString">
  500. validateString()
  501. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_validateString" 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/ECI.php"><a href="files/src-data-eci.html"><abbr title="src/Data/ECI.php">ECI.php</abbr></a></abbr>
  505. :
  506. <span class="phpdocumentor-element-found-in__line">84</span>
  507. </aside>
  508. <code class="phpdocumentor-code phpdocumentor-signature ">
  509. <span class="phpdocumentor-signature__visibility">public</span>
  510. <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>
  511. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  512. <dl class="phpdocumentor-argument-list">
  513. <dt class="phpdocumentor-argument-list__entry">
  514. <span class="phpdocumentor-signature__argument__name">$string</span>
  515. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  516. </dt>
  517. <dd class="phpdocumentor-argument-list__definition">
  518. <section class="phpdocumentor-description"></section>
  519. </dd>
  520. </dl>
  521. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  522. Tags
  523. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  524. </h5>
  525. <dl class="phpdocumentor-tag-list">
  526. <dt class="phpdocumentor-tag-list__entry">
  527. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  528. </dt>
  529. <dd class="phpdocumentor-tag-list__definition">
  530. <section class="phpdocumentor-description"><p>Unused, but required as per interface</p>
  531. </section>
  532. </dd>
  533. </dl>
  534. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  535. <span class="phpdocumentor-signature__response_type">bool</span>
  536. &mdash;
  537. </article>
  538. <article
  539. class="phpdocumentor-element
  540. -method
  541. -public
  542. "
  543. >
  544. <h4 class="phpdocumentor-element__name" id="method_write">
  545. write()
  546. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_write" class="headerlink"><i class="fas fa-link"></i></a>
  547. </h4>
  548. <aside class="phpdocumentor-element-found-in">
  549. <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>
  550. :
  551. <span class="phpdocumentor-element-found-in__line">50</span>
  552. </aside>
  553. <code class="phpdocumentor-code phpdocumentor-signature ">
  554. <span class="phpdocumentor-signature__visibility">public</span>
  555. <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>
  556. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  557. <dl class="phpdocumentor-argument-list">
  558. <dt class="phpdocumentor-argument-list__entry">
  559. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  560. : <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>
  561. </dt>
  562. <dd class="phpdocumentor-argument-list__definition">
  563. <section class="phpdocumentor-description"></section>
  564. </dd>
  565. <dt class="phpdocumentor-argument-list__entry">
  566. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  567. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  568. </dt>
  569. <dd class="phpdocumentor-argument-list__definition">
  570. <section class="phpdocumentor-description"></section>
  571. </dd>
  572. </dl>
  573. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  574. Tags
  575. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  576. </h5>
  577. <dl class="phpdocumentor-tag-list">
  578. <dt class="phpdocumentor-tag-list__entry">
  579. <span class="phpdocumentor-tag__name">inheritDoc</span>
  580. </dt>
  581. <dd class="phpdocumentor-tag-list__definition">
  582. </dd>
  583. </dl>
  584. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  585. <span class="phpdocumentor-signature__response_type">void</span>
  586. &mdash;
  587. </article>
  588. <article
  589. class="phpdocumentor-element
  590. -method
  591. -protected
  592. "
  593. >
  594. <h4 class="phpdocumentor-element__name" id="method_getCharCount">
  595. getCharCount()
  596. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount" class="headerlink"><i class="fas fa-link"></i></a>
  597. </h4>
  598. <aside class="phpdocumentor-element-found-in">
  599. <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>
  600. :
  601. <span class="phpdocumentor-element-found-in__line">44</span>
  602. </aside>
  603. <p class="phpdocumentor-summary">returns the character count of the $data string</p>
  604. <code class="phpdocumentor-code phpdocumentor-signature ">
  605. <span class="phpdocumentor-signature__visibility">protected</span>
  606. <span class="phpdocumentor-signature__name">getCharCount</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  607. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  608. <span class="phpdocumentor-signature__response_type">int</span>
  609. &mdash;
  610. </article>
  611. </section>
  612. <script type="text/javascript">
  613. function loadExternalCodeSnippets(line) {
  614. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  615. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  616. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  617. var language = 'php';
  618. var code = document.createElement('code');
  619. code.className = 'language-' + language;
  620. pre.textContent = '';
  621. pre.setAttribute('data-line', line)
  622. code.textContent = 'Loading…';
  623. pre.appendChild(code);
  624. var xhr = new XMLHttpRequest();
  625. xhr.open('GET', src, true);
  626. xhr.onreadystatechange = function () {
  627. if (xhr.readyState == 4) {
  628. if (xhr.status < 400 && xhr.responseText) {
  629. code.textContent = xhr.responseText;
  630. Prism.highlightElement(code);
  631. }
  632. else if (xhr.status >= 400) {
  633. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  634. }
  635. else {
  636. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  637. }
  638. }
  639. };
  640. xhr.send(null);
  641. });
  642. }
  643. var modals = document.querySelectorAll("[data-modal]");
  644. modals.forEach(function (trigger) {
  645. trigger.addEventListener("click", function (event) {
  646. //event.preventDefault();
  647. const modal = document.getElementById(trigger.dataset.modal);
  648. modal.classList.add("phpdocumentor-modal__open");
  649. loadExternalCodeSnippets(trigger.dataset.line)
  650. const exits = modal.querySelectorAll("[data-exit-button]");
  651. exits.forEach(function (exit) {
  652. exit.addEventListener("click", function (event) {
  653. event.preventDefault();
  654. modal.classList.remove("phpdocumentor-modal__open");
  655. });
  656. });
  657. });
  658. });
  659. </script>
  660. </article>
  661. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  662. <section class="phpdocumentor-search-results__dialog">
  663. <header class="phpdocumentor-search-results__header">
  664. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  665. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  666. </header>
  667. <section class="phpdocumentor-search-results__body">
  668. <ul class="phpdocumentor-search-results__entries"></ul>
  669. </section>
  670. </section>
  671. </section>
  672. </div>
  673. </div>
  674. <a href="classes/chillerlan-QRCode-Data-ECI.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  675. </main>
  676. <script>
  677. cssVars({});
  678. </script>
  679. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  680. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  681. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  682. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  683. </body>
  684. </html>