chillerlan-QRCode-Data-ECI.html 46 KB

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