chillerlan-QRCode-Data-ECI.html 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158
  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=Open+Sans:wght@100;200;300;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/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. <h4 class="phpdocumentor-sidebar__root-namespace">
  89. <a href="namespaces/output.html" class="">Output</a>
  90. </h4>
  91. </section>
  92. <section class="phpdocumentor-sidebar__category -packages">
  93. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  94. <h4 class="phpdocumentor-sidebar__root-namespace">
  95. <a href="packages/Application.html" class="">Application</a>
  96. </h4>
  97. </section>
  98. <section class="phpdocumentor-sidebar__category -reports">
  99. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  100. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  101. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  102. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  103. </section>
  104. <section class="phpdocumentor-sidebar__category -indices">
  105. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  106. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  107. </section>
  108. </aside>
  109. <div class="phpdocumentor-column -nine phpdocumentor-content">
  110. <section>
  111. <ul class="phpdocumentor-breadcrumbs">
  112. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  113. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  114. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-data.html">Data</a></li>
  115. </ul>
  116. <article class="phpdocumentor-element -class">
  117. <h2 class="phpdocumentor-content__title">
  118. ECI
  119. <span class="phpdocumentor-element__extends">
  120. extends <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeAbstract">QRDataModeAbstract</abbr></a>
  121. </span>
  122. <div class="phpdocumentor-element__package">
  123. in package
  124. <ul class="phpdocumentor-breadcrumbs">
  125. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  126. </ul>
  127. </div>
  128. </h2>
  129. <div class="phpdocumentor-label-line">
  130. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Final</span><span>Yes</span></div>
  131. </div>
  132. <aside class="phpdocumentor-element-found-in">
  133. <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>
  134. :
  135. <span class="phpdocumentor-element-found-in__line">23</span>
  136. </aside>
  137. <p class="phpdocumentor-summary">Adds an ECI Designator</p>
  138. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.4.1.1</p>
  139. <p>Please note that you have to take care for the correct data encoding when adding with QRCode::add*Segment()</p>
  140. </section>
  141. <h3 id="toc">
  142. Table of Contents
  143. <a href="classes/chillerlan-QRCode-Data-ECI.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  144. </h3>
  145. <h4 id="toc-constants">
  146. Constants
  147. <a href="classes/chillerlan-QRCode-Data-ECI.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  148. </h4>
  149. <dl class="phpdocumentor-table-of-contents">
  150. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  151. <a class="" href="classes/chillerlan-QRCode-Data-ECI.html#constant_DATAMODE">DATAMODE</a>
  152. <span>
  153. &nbsp;= \chillerlan\QRCode\Common\Mode::ECI </span>
  154. </dt>
  155. </dl>
  156. <h4 id="toc-properties">
  157. Properties
  158. <a href="classes/chillerlan-QRCode-Data-ECI.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  159. </h4>
  160. <dl class="phpdocumentor-table-of-contents">
  161. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  162. <a class="" href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data">$data</a>
  163. <span>
  164. &nbsp;: string </span>
  165. </dt>
  166. <dd>The data to write</dd>
  167. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  168. <a class="" href="classes/chillerlan-QRCode-Data-ECI.html#property_encoding">$encoding</a>
  169. <span>
  170. &nbsp;: int </span>
  171. </dt>
  172. <dd>The current ECI encoding id</dd>
  173. </dl>
  174. <h4 id="toc-methods">
  175. Methods
  176. <a href="classes/chillerlan-QRCode-Data-ECI.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  177. </h4>
  178. <dl class="phpdocumentor-table-of-contents">
  179. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  180. <a class="" href="classes/chillerlan-QRCode-Data-ECI.html#method___construct">__construct()</a>
  181. <span>
  182. &nbsp;: mixed </span>
  183. </dt>
  184. <dd>QRDataModeAbstract constructor.</dd>
  185. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  186. <a class="" href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_convertEncoding">convertEncoding()</a>
  187. <span>
  188. &nbsp;: string </span>
  189. </dt>
  190. <dd>encoding conversion helper</dd>
  191. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  192. <a class="" href="classes/chillerlan-QRCode-Data-ECI.html#method_decodeSegment">decodeSegment()</a>
  193. <span>
  194. &nbsp;: string </span>
  195. </dt>
  196. <dd>Reads and decodes the ECI designator including the following byte sequence</dd>
  197. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  198. <a class="" href="classes/chillerlan-QRCode-Data-ECI.html#method_getLengthInBits">getLengthInBits()</a>
  199. <span>
  200. &nbsp;: int </span>
  201. </dt>
  202. <dd>retruns the length in bits of the data string</dd>
  203. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  204. <a class="" href="classes/chillerlan-QRCode-Data-ECI.html#method_parseValue">parseValue()</a>
  205. <span>
  206. &nbsp;: <a href="classes/chillerlan-QRCode-Common-ECICharset.html"><abbr title="\chillerlan\QRCode\Common\ECICharset">ECICharset</abbr></a> </span>
  207. </dt>
  208. <dd>Reads and parses the value of an ECI designator</dd>
  209. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  210. <a class="" href="classes/chillerlan-QRCode-Data-ECI.html#method_validateString">validateString()</a>
  211. <span>
  212. &nbsp;: bool </span>
  213. </dt>
  214. <dd>checks if the given string qualifies for the encoder module</dd>
  215. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  216. <a class="" href="classes/chillerlan-QRCode-Data-ECI.html#method_write">write()</a>
  217. <span>
  218. &nbsp;: static </span>
  219. </dt>
  220. <dd>Writes an ECI designator to the bitbuffer</dd>
  221. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  222. <a class="" href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount">getCharCount()</a>
  223. <span>
  224. &nbsp;: int </span>
  225. </dt>
  226. <dd>returns the character count of the $data string</dd>
  227. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  228. <a class="" href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getLengthBits">getLengthBits()</a>
  229. <span>
  230. &nbsp;: int </span>
  231. </dt>
  232. <dd>shortcut</dd>
  233. </dl>
  234. <section class="phpdocumentor-constants">
  235. <h3 class="phpdocumentor-elements__header" id="constants">
  236. Constants
  237. <a href="classes/chillerlan-QRCode-Data-ECI.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  238. </h3>
  239. <article class="phpdocumentor-element -constant -public ">
  240. <h4 class="phpdocumentor-element__name" id="constant_DATAMODE">
  241. DATAMODE
  242. <a href="classes/chillerlan-QRCode-Data-ECI.html#constant_DATAMODE" class="headerlink"><i class="fas fa-link"></i></a>
  243. </h4>
  244. <aside class="phpdocumentor-element-found-in">
  245. <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>
  246. :
  247. <span class="phpdocumentor-element-found-in__line">28</span>
  248. </aside>
  249. <code class="phpdocumentor-signature phpdocumentor-code ">
  250. <span class="phpdocumentor-signature__visibility">public</span>
  251. <span class="phpdocumentor-signature__type">mixed</span>
  252. <span class="phpdocumentor-signature__name">DATAMODE</span>
  253. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Mode::ECI</span>
  254. </code>
  255. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  256. Tags
  257. <a href="classes/chillerlan-QRCode-Data-ECI.html#constant_DATAMODE#tags" class="headerlink"><i class="fas fa-link"></i></a>
  258. </h5>
  259. <dl class="phpdocumentor-tag-list">
  260. <dt class="phpdocumentor-tag-list__entry">
  261. <span class="phpdocumentor-tag__name">inheritDoc</span>
  262. </dt>
  263. <dd class="phpdocumentor-tag-list__definition">
  264. </dd>
  265. </dl>
  266. </article>
  267. </section>
  268. <section class="phpdocumentor-properties">
  269. <h3 class="phpdocumentor-elements__header" id="properties">
  270. Properties
  271. <a href="classes/chillerlan-QRCode-Data-ECI.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  272. </h3>
  273. <article
  274. class="
  275. phpdocumentor-element
  276. -property
  277. -protected
  278. "
  279. >
  280. <h4 class="phpdocumentor-element__name" id="property_data">
  281. $data
  282. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data" class="headerlink"><i class="fas fa-link"></i></a>
  283. <span class="phpdocumentor-element__modifiers">
  284. </span>
  285. </h4>
  286. <aside class="phpdocumentor-element-found-in">
  287. <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>
  288. :
  289. <span class="phpdocumentor-element-found-in__line">23</span>
  290. </aside>
  291. <p class="phpdocumentor-summary">The data to write</p>
  292. <code class="phpdocumentor-code phpdocumentor-signature ">
  293. <span class="phpdocumentor-signature__visibility">protected</span>
  294. <span class="phpdocumentor-signature__type">string</span>
  295. <span class="phpdocumentor-signature__name">$data</span>
  296. </code>
  297. </article>
  298. <article
  299. class="
  300. phpdocumentor-element
  301. -property
  302. -private
  303. "
  304. >
  305. <h4 class="phpdocumentor-element__name" id="property_encoding">
  306. $encoding
  307. <a href="classes/chillerlan-QRCode-Data-ECI.html#property_encoding" class="headerlink"><i class="fas fa-link"></i></a>
  308. <span class="phpdocumentor-element__modifiers">
  309. </span>
  310. </h4>
  311. <aside class="phpdocumentor-element-found-in">
  312. <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>
  313. :
  314. <span class="phpdocumentor-element-found-in__line">33</span>
  315. </aside>
  316. <p class="phpdocumentor-summary">The current ECI encoding id</p>
  317. <code class="phpdocumentor-code phpdocumentor-signature ">
  318. <span class="phpdocumentor-signature__visibility">private</span>
  319. <span class="phpdocumentor-signature__type">int</span>
  320. <span class="phpdocumentor-signature__name">$encoding</span>
  321. </code>
  322. </article>
  323. </section>
  324. <section class="phpdocumentor-methods">
  325. <h3 class="phpdocumentor-elements__header" id="methods">
  326. Methods
  327. <a href="classes/chillerlan-QRCode-Data-ECI.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  328. </h3>
  329. <article
  330. class="phpdocumentor-element
  331. -method
  332. -public
  333. "
  334. >
  335. <h4 class="phpdocumentor-element__name" id="method___construct">
  336. __construct()
  337. <a href="classes/chillerlan-QRCode-Data-ECI.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  338. </h4>
  339. <aside class="phpdocumentor-element-found-in">
  340. <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>
  341. :
  342. <span class="phpdocumentor-element-found-in__line">39</span>
  343. </aside>
  344. <p class="phpdocumentor-summary">QRDataModeAbstract constructor.</p>
  345. <code class="phpdocumentor-code phpdocumentor-signature ">
  346. <span class="phpdocumentor-signature__visibility">public</span>
  347. <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>
  348. <div class="phpdocumentor-label-line">
  349. </div>
  350. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  351. <dl class="phpdocumentor-argument-list">
  352. <dt class="phpdocumentor-argument-list__entry">
  353. <span class="phpdocumentor-signature__argument__name">$encoding</span>
  354. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  355. </dt>
  356. <dd class="phpdocumentor-argument-list__definition">
  357. </dd>
  358. </dl>
  359. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  360. Tags
  361. <a href="classes/chillerlan-QRCode-Data-ECI.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
  362. </h5>
  363. <dl class="phpdocumentor-tag-list">
  364. <dt class="phpdocumentor-tag-list__entry">
  365. <span class="phpdocumentor-tag__name">inheritDoc</span>
  366. </dt>
  367. <dd class="phpdocumentor-tag-list__definition">
  368. </dd>
  369. <dt class="phpdocumentor-tag-list__entry">
  370. <span class="phpdocumentor-tag__name">noinspection</span>
  371. </dt>
  372. <dd class="phpdocumentor-tag-list__definition">
  373. <section class="phpdocumentor-description"><p>PhpMissingParentConstructorInspection</p>
  374. </section>
  375. </dd>
  376. </dl>
  377. </article>
  378. <article
  379. class="phpdocumentor-element
  380. -method
  381. -public
  382. -static "
  383. >
  384. <h4 class="phpdocumentor-element__name" id="method_convertEncoding">
  385. convertEncoding()
  386. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_convertEncoding" class="headerlink"><i class="fas fa-link"></i></a>
  387. </h4>
  388. <aside class="phpdocumentor-element-found-in">
  389. <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>
  390. :
  391. <span class="phpdocumentor-element-found-in__line">50</span>
  392. </aside>
  393. <p class="phpdocumentor-summary">encoding conversion helper</p>
  394. <code class="phpdocumentor-code phpdocumentor-signature ">
  395. <span class="phpdocumentor-signature__visibility">public</span>
  396. <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>
  397. <div class="phpdocumentor-label-line">
  398. </div>
  399. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  400. <dl class="phpdocumentor-argument-list">
  401. <dt class="phpdocumentor-argument-list__entry">
  402. <span class="phpdocumentor-signature__argument__name">$string</span>
  403. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  404. </dt>
  405. <dd class="phpdocumentor-argument-list__definition">
  406. </dd>
  407. </dl>
  408. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  409. Tags
  410. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_convertEncoding#tags" class="headerlink"><i class="fas fa-link"></i></a>
  411. </h5>
  412. <dl class="phpdocumentor-tag-list">
  413. <dt class="phpdocumentor-tag-list__entry">
  414. <span class="phpdocumentor-tag__name">inheritDoc</span>
  415. </dt>
  416. <dd class="phpdocumentor-tag-list__definition">
  417. </dd>
  418. </dl>
  419. <section>
  420. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  421. <span class="phpdocumentor-signature__response_type">string</span>
  422. </section>
  423. </article>
  424. <article
  425. class="phpdocumentor-element
  426. -method
  427. -public
  428. -static "
  429. >
  430. <h4 class="phpdocumentor-element__name" id="method_decodeSegment">
  431. decodeSegment()
  432. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_decodeSegment" class="headerlink"><i class="fas fa-link"></i></a>
  433. </h4>
  434. <aside class="phpdocumentor-element-found-in">
  435. <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>
  436. :
  437. <span class="phpdocumentor-element-found-in__line">128</span>
  438. </aside>
  439. <p class="phpdocumentor-summary">Reads and decodes the ECI designator including the following byte sequence</p>
  440. <code class="phpdocumentor-code phpdocumentor-signature ">
  441. <span class="phpdocumentor-signature__visibility">public</span>
  442. <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>
  443. <div class="phpdocumentor-label-line">
  444. </div>
  445. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  446. <dl class="phpdocumentor-argument-list">
  447. <dt class="phpdocumentor-argument-list__entry">
  448. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  449. : <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>
  450. </dt>
  451. <dd class="phpdocumentor-argument-list__definition">
  452. </dd>
  453. <dt class="phpdocumentor-argument-list__entry">
  454. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  455. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  456. </dt>
  457. <dd class="phpdocumentor-argument-list__definition">
  458. </dd>
  459. </dl>
  460. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  461. Tags
  462. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_decodeSegment#tags" class="headerlink"><i class="fas fa-link"></i></a>
  463. </h5>
  464. <dl class="phpdocumentor-tag-list">
  465. <dt class="phpdocumentor-tag-list__entry">
  466. <span class="phpdocumentor-tag__name">throws</span>
  467. </dt>
  468. <dd class="phpdocumentor-tag-list__definition">
  469. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  470. </dd>
  471. </dl>
  472. <section>
  473. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  474. <span class="phpdocumentor-signature__response_type">string</span>
  475. </section>
  476. </article>
  477. <article
  478. class="phpdocumentor-element
  479. -method
  480. -public
  481. "
  482. >
  483. <h4 class="phpdocumentor-element__name" id="method_getLengthInBits">
  484. getLengthInBits()
  485. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_getLengthInBits" class="headerlink"><i class="fas fa-link"></i></a>
  486. </h4>
  487. <aside class="phpdocumentor-element-found-in">
  488. <abbr class="phpdocumentor-element-found-in__file" title="src/Data/ECI.php"><a href="files/src-data-eci.html"><abbr title="src/Data/ECI.php">ECI.php</abbr></a></abbr>
  489. :
  490. <span class="phpdocumentor-element-found-in__line">51</span>
  491. </aside>
  492. <p class="phpdocumentor-summary">retruns the length in bits of the data string</p>
  493. <code class="phpdocumentor-code phpdocumentor-signature ">
  494. <span class="phpdocumentor-signature__visibility">public</span>
  495. <span class="phpdocumentor-signature__name">getLengthInBits</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  496. <div class="phpdocumentor-label-line">
  497. </div>
  498. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  499. Tags
  500. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_getLengthInBits#tags" class="headerlink"><i class="fas fa-link"></i></a>
  501. </h5>
  502. <dl class="phpdocumentor-tag-list">
  503. <dt class="phpdocumentor-tag-list__entry">
  504. <span class="phpdocumentor-tag__name">inheritDoc</span>
  505. </dt>
  506. <dd class="phpdocumentor-tag-list__definition">
  507. </dd>
  508. </dl>
  509. <section>
  510. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  511. <span class="phpdocumentor-signature__response_type">int</span>
  512. </section>
  513. </article>
  514. <article
  515. class="phpdocumentor-element
  516. -method
  517. -public
  518. -static "
  519. >
  520. <h4 class="phpdocumentor-element__name" id="method_parseValue">
  521. parseValue()
  522. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_parseValue" class="headerlink"><i class="fas fa-link"></i></a>
  523. </h4>
  524. <aside class="phpdocumentor-element-found-in">
  525. <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>
  526. :
  527. <span class="phpdocumentor-element-found-in__line">94</span>
  528. </aside>
  529. <p class="phpdocumentor-summary">Reads and parses the value of an ECI designator</p>
  530. <code class="phpdocumentor-code phpdocumentor-signature ">
  531. <span class="phpdocumentor-signature__visibility">public</span>
  532. <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>
  533. <div class="phpdocumentor-label-line">
  534. </div>
  535. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  536. <dl class="phpdocumentor-argument-list">
  537. <dt class="phpdocumentor-argument-list__entry">
  538. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  539. : <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>
  540. </dt>
  541. <dd class="phpdocumentor-argument-list__definition">
  542. </dd>
  543. </dl>
  544. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  545. Tags
  546. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_parseValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  547. </h5>
  548. <dl class="phpdocumentor-tag-list">
  549. <dt class="phpdocumentor-tag-list__entry">
  550. <span class="phpdocumentor-tag__name">throws</span>
  551. </dt>
  552. <dd class="phpdocumentor-tag-list__definition">
  553. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  554. </dd>
  555. </dl>
  556. <section>
  557. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  558. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Common-ECICharset.html"><abbr title="\chillerlan\QRCode\Common\ECICharset">ECICharset</abbr></a></span>
  559. </section>
  560. </article>
  561. <article
  562. class="phpdocumentor-element
  563. -method
  564. -public
  565. -static "
  566. >
  567. <h4 class="phpdocumentor-element__name" id="method_validateString">
  568. validateString()
  569. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_validateString" class="headerlink"><i class="fas fa-link"></i></a>
  570. </h4>
  571. <aside class="phpdocumentor-element-found-in">
  572. <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>
  573. :
  574. <span class="phpdocumentor-element-found-in__line">119</span>
  575. </aside>
  576. <p class="phpdocumentor-summary">checks if the given string qualifies for the encoder module</p>
  577. <code class="phpdocumentor-code phpdocumentor-signature ">
  578. <span class="phpdocumentor-signature__visibility">public</span>
  579. <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>
  580. <div class="phpdocumentor-label-line">
  581. </div>
  582. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  583. <dl class="phpdocumentor-argument-list">
  584. <dt class="phpdocumentor-argument-list__entry">
  585. <span class="phpdocumentor-signature__argument__name">$string</span>
  586. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  587. </dt>
  588. <dd class="phpdocumentor-argument-list__definition">
  589. </dd>
  590. </dl>
  591. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  592. Tags
  593. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_validateString#tags" class="headerlink"><i class="fas fa-link"></i></a>
  594. </h5>
  595. <dl class="phpdocumentor-tag-list">
  596. <dt class="phpdocumentor-tag-list__entry">
  597. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  598. </dt>
  599. <dd class="phpdocumentor-tag-list__definition">
  600. <section class="phpdocumentor-description"><p>Unused, but required as per interface</p>
  601. </section>
  602. </dd>
  603. </dl>
  604. <section>
  605. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  606. <span class="phpdocumentor-signature__response_type">bool</span>
  607. </section>
  608. </article>
  609. <article
  610. class="phpdocumentor-element
  611. -method
  612. -public
  613. "
  614. >
  615. <h4 class="phpdocumentor-element__name" id="method_write">
  616. write()
  617. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_write" 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/ECI.php"><a href="files/src-data-eci.html"><abbr title="src/Data/ECI.php">ECI.php</abbr></a></abbr>
  621. :
  622. <span class="phpdocumentor-element-found-in__line">70</span>
  623. </aside>
  624. <p class="phpdocumentor-summary">Writes an ECI designator to the bitbuffer</p>
  625. <code class="phpdocumentor-code phpdocumentor-signature ">
  626. <span class="phpdocumentor-signature__visibility">public</span>
  627. <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">static</span></code>
  628. <div class="phpdocumentor-label-line">
  629. </div>
  630. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  631. <dl class="phpdocumentor-argument-list">
  632. <dt class="phpdocumentor-argument-list__entry">
  633. <span class="phpdocumentor-signature__argument__name">$bitBuffer</span>
  634. : <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>
  635. </dt>
  636. <dd class="phpdocumentor-argument-list__definition">
  637. </dd>
  638. <dt class="phpdocumentor-argument-list__entry">
  639. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  640. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  641. </dt>
  642. <dd class="phpdocumentor-argument-list__definition">
  643. </dd>
  644. </dl>
  645. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  646. Tags
  647. <a href="classes/chillerlan-QRCode-Data-ECI.html#method_write#tags" class="headerlink"><i class="fas fa-link"></i></a>
  648. </h5>
  649. <dl class="phpdocumentor-tag-list">
  650. <dt class="phpdocumentor-tag-list__entry">
  651. <span class="phpdocumentor-tag__name">inheritDoc</span>
  652. </dt>
  653. <dd class="phpdocumentor-tag-list__definition">
  654. </dd>
  655. <dt class="phpdocumentor-tag-list__entry">
  656. <span class="phpdocumentor-tag__name">throws</span>
  657. </dt>
  658. <dd class="phpdocumentor-tag-list__definition">
  659. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  660. </dd>
  661. </dl>
  662. <section>
  663. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  664. <span class="phpdocumentor-signature__response_type">static</span>
  665. </section>
  666. </article>
  667. <article
  668. class="phpdocumentor-element
  669. -method
  670. -protected
  671. "
  672. >
  673. <h4 class="phpdocumentor-element__name" id="method_getCharCount">
  674. getCharCount()
  675. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount" class="headerlink"><i class="fas fa-link"></i></a>
  676. </h4>
  677. <aside class="phpdocumentor-element-found-in">
  678. <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>
  679. :
  680. <span class="phpdocumentor-element-found-in__line">43</span>
  681. </aside>
  682. <p class="phpdocumentor-summary">returns the character count of the $data string</p>
  683. <code class="phpdocumentor-code phpdocumentor-signature ">
  684. <span class="phpdocumentor-signature__visibility">protected</span>
  685. <span class="phpdocumentor-signature__name">getCharCount</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  686. <div class="phpdocumentor-label-line">
  687. </div>
  688. <section>
  689. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  690. <span class="phpdocumentor-signature__response_type">int</span>
  691. </section>
  692. </article>
  693. <article
  694. class="phpdocumentor-element
  695. -method
  696. -protected
  697. -static "
  698. >
  699. <h4 class="phpdocumentor-element__name" id="method_getLengthBits">
  700. getLengthBits()
  701. <a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getLengthBits" class="headerlink"><i class="fas fa-link"></i></a>
  702. </h4>
  703. <aside class="phpdocumentor-element-found-in">
  704. <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>
  705. :
  706. <span class="phpdocumentor-element-found-in__line">57</span>
  707. </aside>
  708. <p class="phpdocumentor-summary">shortcut</p>
  709. <code class="phpdocumentor-code phpdocumentor-signature ">
  710. <span class="phpdocumentor-signature__visibility">protected</span>
  711. <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>
  712. <div class="phpdocumentor-label-line">
  713. </div>
  714. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  715. <dl class="phpdocumentor-argument-list">
  716. <dt class="phpdocumentor-argument-list__entry">
  717. <span class="phpdocumentor-signature__argument__name">$versionNumber</span>
  718. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  719. </dt>
  720. <dd class="phpdocumentor-argument-list__definition">
  721. </dd>
  722. </dl>
  723. <section>
  724. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  725. <span class="phpdocumentor-signature__response_type">int</span>
  726. </section>
  727. </article>
  728. </section>
  729. <div class="phpdocumentor-modal" id="source-view">
  730. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  731. <div class="phpdocumentor-modal-container">
  732. <div class="phpdocumentor-modal-content">
  733. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Data/ECI.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  734. </div>
  735. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  736. </div>
  737. </div>
  738. <script type="text/javascript">
  739. (function () {
  740. function loadExternalCodeSnippet(el, url, line) {
  741. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  742. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  743. const language = 'php';
  744. const code = document.createElement('code');
  745. code.className = 'language-' + language;
  746. pre.textContent = '';
  747. pre.setAttribute('data-line', line)
  748. code.textContent = 'Loading…';
  749. pre.appendChild(code);
  750. var xhr = new XMLHttpRequest();
  751. xhr.open('GET', src, true);
  752. xhr.onreadystatechange = function () {
  753. if (xhr.readyState !== 4) {
  754. return;
  755. }
  756. if (xhr.status < 400 && xhr.responseText) {
  757. code.textContent = xhr.responseText;
  758. Prism.highlightElement(code);
  759. return;
  760. }
  761. if (xhr.status === 404) {
  762. code.textContent = '✖ Error: File could not be found';
  763. return;
  764. }
  765. if (xhr.status >= 400) {
  766. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  767. return;
  768. }
  769. code.textContent = '✖ Error: An unknown error occurred';
  770. };
  771. xhr.send(null);
  772. });
  773. }
  774. const modalButtons = document.querySelectorAll("[data-modal]");
  775. const openedAsLocalFile = window.location.protocol === 'file:';
  776. if (modalButtons.length > 0 && openedAsLocalFile) {
  777. console.warn(
  778. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  779. 'browsers block XHR requests when a page is opened this way'
  780. );
  781. }
  782. modalButtons.forEach(function (trigger) {
  783. if (openedAsLocalFile) {
  784. trigger.setAttribute("hidden", "hidden");
  785. }
  786. trigger.addEventListener("click", function (event) {
  787. event.preventDefault();
  788. const modal = document.getElementById(trigger.dataset.modal);
  789. if (!modal) {
  790. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  791. return;
  792. }
  793. modal.classList.add("phpdocumentor-modal__open");
  794. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  795. const exits = modal.querySelectorAll("[data-exit-button]");
  796. exits.forEach(function (exit) {
  797. exit.addEventListener("click", function (event) {
  798. event.preventDefault();
  799. modal.classList.remove("phpdocumentor-modal__open");
  800. });
  801. });
  802. });
  803. });
  804. })();
  805. </script>
  806. </article>
  807. </section>
  808. <section class="phpdocumentor-on-this-page__sidebar">
  809. <section class="phpdocumentor-on-this-page__content">
  810. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  811. <ul class="phpdocumentor-list -clean">
  812. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  813. <li>
  814. <ul class="phpdocumentor-list -clean">
  815. <li><a href="classes/chillerlan-QRCode-Data-ECI.html#toc-constants">Constants</a></li>
  816. <li><a href="classes/chillerlan-QRCode-Data-ECI.html#toc-properties">Properties</a></li>
  817. <li><a href="classes/chillerlan-QRCode-Data-ECI.html#toc-methods">Methods</a></li>
  818. </ul>
  819. </li>
  820. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  821. <li>
  822. <ul class="phpdocumentor-list -clean">
  823. <li class=""><a href="classes/chillerlan-QRCode-Data-ECI.html#constant_DATAMODE">DATAMODE</a></li>
  824. </ul>
  825. </li>
  826. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  827. <li>
  828. <ul class="phpdocumentor-list -clean">
  829. <li class=""><a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#property_data">$data</li>
  830. <li class=""><a href="classes/chillerlan-QRCode-Data-ECI.html#property_encoding">$encoding</li>
  831. </ul>
  832. </li>
  833. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  834. <li>
  835. <ul class="phpdocumentor-list -clean">
  836. <li class=""><a href="classes/chillerlan-QRCode-Data-ECI.html#method___construct">__construct()</a></li>
  837. <li class=""><a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_convertEncoding">convertEncoding()</a></li>
  838. <li class=""><a href="classes/chillerlan-QRCode-Data-ECI.html#method_decodeSegment">decodeSegment()</a></li>
  839. <li class=""><a href="classes/chillerlan-QRCode-Data-ECI.html#method_getLengthInBits">getLengthInBits()</a></li>
  840. <li class=""><a href="classes/chillerlan-QRCode-Data-ECI.html#method_parseValue">parseValue()</a></li>
  841. <li class=""><a href="classes/chillerlan-QRCode-Data-ECI.html#method_validateString">validateString()</a></li>
  842. <li class=""><a href="classes/chillerlan-QRCode-Data-ECI.html#method_write">write()</a></li>
  843. <li class=""><a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getCharCount">getCharCount()</a></li>
  844. <li class=""><a href="classes/chillerlan-QRCode-Data-QRDataModeAbstract.html#method_getLengthBits">getLengthBits()</a></li>
  845. </ul>
  846. </li>
  847. </ul>
  848. </section>
  849. </section>
  850. </div>
  851. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  852. <section class="phpdocumentor-search-results__dialog">
  853. <header class="phpdocumentor-search-results__header">
  854. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  855. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  856. </header>
  857. <section class="phpdocumentor-search-results__body">
  858. <ul class="phpdocumentor-search-results__entries"></ul>
  859. </section>
  860. </section>
  861. </section>
  862. </div>
  863. <a href="classes/chillerlan-QRCode-Data-ECI.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  864. </main>
  865. <script>
  866. cssVars({});
  867. </script>
  868. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  869. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  870. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  871. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  872. </body>
  873. </html>