chillerlan-QRCode-Data-ECI.html 47 KB

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