chillerlan-QRCode-Data-ECI.html 44 KB

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