chillerlan-QRCode-Data-ECI.html 46 KB

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