chillerlan-QRCodeTest-QRCodeTest.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479
  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"><a href="namespaces/chillerlan.html">chillerlan</a></h4>
  56. <ul class="phpdocumentor-list">
  57. <li>
  58. <a href="namespaces/chillerlan-qrcode.html">QRCode</a>
  59. </li>
  60. <li>
  61. <a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a>
  62. </li>
  63. </ul>
  64. </section>
  65. <section class="phpdocumentor-sidebar__category">
  66. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  67. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
  68. </section>
  69. <section class="phpdocumentor-sidebar__category">
  70. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  71. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  72. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  73. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  74. </section>
  75. <section class="phpdocumentor-sidebar__category">
  76. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  78. </section>
  79. </aside>
  80. <div class="phpdocumentor-column -eight phpdocumentor-content">
  81. <ul class="phpdocumentor-breadcrumbs">
  82. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  83. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a></li>
  84. </ul>
  85. <article class="phpdocumentor-element -class">
  86. <h2 class="phpdocumentor-content__title">
  87. QRCodeTest
  88. <span class="phpdocumentor-element__extends">
  89. extends <abbr title="\PHPUnit\Framework\TestCase">TestCase</abbr>
  90. </span>
  91. <div class="phpdocumentor-element__package">
  92. in package
  93. <ul class="phpdocumentor-breadcrumbs">
  94. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  95. </ul>
  96. </div>
  97. </h2>
  98. <aside class="phpdocumentor-element-found-in">
  99. <abbr class="phpdocumentor-element-found-in__file" title="tests/QRCodeTest.php"><a href="files/tests-qrcodetest.html"><abbr title="tests/QRCodeTest.php">QRCodeTest.php</abbr></a></abbr>
  100. :
  101. <span class="phpdocumentor-element-found-in__line">21</span>
  102. </aside>
  103. <p class="phpdocumentor-summary">Tests basic functions of the QRCode class</p>
  104. <h3 id="toc">
  105. Table of Contents
  106. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  107. </h3>
  108. <dl class="phpdocumentor-table-of-contents">
  109. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  110. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#method_testGetMatrixException">testGetMatrixException()</a>
  111. <span>
  112. &nbsp;: void </span>
  113. </dt>
  114. <dd>tests if an exception is thrown when trying to call getMatrix() without data (empty string, no data set)</dd>
  115. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  116. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#method_testInitDataInterfaceException">testInitDataInterfaceException()</a>
  117. <span>
  118. &nbsp;: void </span>
  119. </dt>
  120. <dd>tests if an exception is thrown when an invalid (built-in) output type is specified</dd>
  121. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  122. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#method_testIsAlphaNum">testIsAlphaNum()</a>
  123. <span>
  124. &nbsp;: void </span>
  125. </dt>
  126. <dd>isAlphaNum() should pass on the 45 defined characters and fail on anything else (e.g. lowercase)</dd>
  127. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  128. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#method_testIsByte">testIsByte()</a>
  129. <span>
  130. &nbsp;: void </span>
  131. </dt>
  132. <dd>isByte() passses any binary string and only fails on empty strings</dd>
  133. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  134. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#method_testIsKanji">testIsKanji()</a>
  135. <span>
  136. &nbsp;: void </span>
  137. </dt>
  138. <dd>isKanji() should pass on Kanji/SJIS characters and fail on everything else</dd>
  139. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  140. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#method_testIsNumber">testIsNumber()</a>
  141. <span>
  142. &nbsp;: void </span>
  143. </dt>
  144. <dd>isNumber() should pass on any number and fail on anything else</dd>
  145. </dl>
  146. <section class="phpdocumentor-methods">
  147. <h3 class="phpdocumentor-elements__header" id="methods">
  148. Methods
  149. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  150. </h3>
  151. <article
  152. class="phpdocumentor-element
  153. -method
  154. -public
  155. "
  156. >
  157. <h4 class="phpdocumentor-element__name" id="method_testGetMatrixException">
  158. testGetMatrixException()
  159. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#method_testGetMatrixException" class="headerlink"><i class="fas fa-link"></i></a>
  160. </h4>
  161. <aside class="phpdocumentor-element-found-in">
  162. <abbr class="phpdocumentor-element-found-in__file" title="tests/QRCodeTest.php"><a href="files/tests-qrcodetest.html"><abbr title="tests/QRCodeTest.php">QRCodeTest.php</abbr></a></abbr>
  163. :
  164. <span class="phpdocumentor-element-found-in__line">92</span>
  165. </aside>
  166. <p class="phpdocumentor-summary">tests if an exception is thrown when trying to call getMatrix() without data (empty string, no data set)</p>
  167. <code class="phpdocumentor-code phpdocumentor-signature ">
  168. <span class="phpdocumentor-signature__visibility">public</span>
  169. <span class="phpdocumentor-signature__name">testGetMatrixException</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  170. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  171. <span class="phpdocumentor-signature__response_type">void</span>
  172. &mdash;
  173. </article>
  174. <article
  175. class="phpdocumentor-element
  176. -method
  177. -public
  178. "
  179. >
  180. <h4 class="phpdocumentor-element__name" id="method_testInitDataInterfaceException">
  181. testInitDataInterfaceException()
  182. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#method_testInitDataInterfaceException" class="headerlink"><i class="fas fa-link"></i></a>
  183. </h4>
  184. <aside class="phpdocumentor-element-found-in">
  185. <abbr class="phpdocumentor-element-found-in__file" title="tests/QRCodeTest.php"><a href="files/tests-qrcodetest.html"><abbr title="tests/QRCodeTest.php">QRCodeTest.php</abbr></a></abbr>
  186. :
  187. <span class="phpdocumentor-element-found-in__line">80</span>
  188. </aside>
  189. <p class="phpdocumentor-summary">tests if an exception is thrown when an invalid (built-in) output type is specified</p>
  190. <code class="phpdocumentor-code phpdocumentor-signature ">
  191. <span class="phpdocumentor-signature__visibility">public</span>
  192. <span class="phpdocumentor-signature__name">testInitDataInterfaceException</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  193. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  194. <span class="phpdocumentor-signature__response_type">void</span>
  195. &mdash;
  196. </article>
  197. <article
  198. class="phpdocumentor-element
  199. -method
  200. -public
  201. "
  202. >
  203. <h4 class="phpdocumentor-element__name" id="method_testIsAlphaNum">
  204. testIsAlphaNum()
  205. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#method_testIsAlphaNum" class="headerlink"><i class="fas fa-link"></i></a>
  206. </h4>
  207. <aside class="phpdocumentor-element-found-in">
  208. <abbr class="phpdocumentor-element-found-in__file" title="tests/QRCodeTest.php"><a href="files/tests-qrcodetest.html"><abbr title="tests/QRCodeTest.php">QRCodeTest.php</abbr></a></abbr>
  209. :
  210. <span class="phpdocumentor-element-found-in__line">50</span>
  211. </aside>
  212. <p class="phpdocumentor-summary">isAlphaNum() should pass on the 45 defined characters and fail on anything else (e.g. lowercase)</p>
  213. <code class="phpdocumentor-code phpdocumentor-signature ">
  214. <span class="phpdocumentor-signature__visibility">public</span>
  215. <span class="phpdocumentor-signature__name">testIsAlphaNum</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  216. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  217. <span class="phpdocumentor-signature__response_type">void</span>
  218. &mdash;
  219. </article>
  220. <article
  221. class="phpdocumentor-element
  222. -method
  223. -public
  224. "
  225. >
  226. <h4 class="phpdocumentor-element__name" id="method_testIsByte">
  227. testIsByte()
  228. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#method_testIsByte" class="headerlink"><i class="fas fa-link"></i></a>
  229. </h4>
  230. <aside class="phpdocumentor-element-found-in">
  231. <abbr class="phpdocumentor-element-found-in__file" title="tests/QRCodeTest.php"><a href="files/tests-qrcodetest.html"><abbr title="tests/QRCodeTest.php">QRCodeTest.php</abbr></a></abbr>
  232. :
  233. <span class="phpdocumentor-element-found-in__line">70</span>
  234. </aside>
  235. <p class="phpdocumentor-summary">isByte() passses any binary string and only fails on empty strings</p>
  236. <code class="phpdocumentor-code phpdocumentor-signature ">
  237. <span class="phpdocumentor-signature__visibility">public</span>
  238. <span class="phpdocumentor-signature__name">testIsByte</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  239. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  240. <span class="phpdocumentor-signature__response_type">void</span>
  241. &mdash;
  242. </article>
  243. <article
  244. class="phpdocumentor-element
  245. -method
  246. -public
  247. "
  248. >
  249. <h4 class="phpdocumentor-element__name" id="method_testIsKanji">
  250. testIsKanji()
  251. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#method_testIsKanji" class="headerlink"><i class="fas fa-link"></i></a>
  252. </h4>
  253. <aside class="phpdocumentor-element-found-in">
  254. <abbr class="phpdocumentor-element-found-in__file" title="tests/QRCodeTest.php"><a href="files/tests-qrcodetest.html"><abbr title="tests/QRCodeTest.php">QRCodeTest.php</abbr></a></abbr>
  255. :
  256. <span class="phpdocumentor-element-found-in__line">59</span>
  257. </aside>
  258. <p class="phpdocumentor-summary">isKanji() should pass on Kanji/SJIS characters and fail on everything else</p>
  259. <code class="phpdocumentor-code phpdocumentor-signature ">
  260. <span class="phpdocumentor-signature__visibility">public</span>
  261. <span class="phpdocumentor-signature__name">testIsKanji</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  262. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  263. <span class="phpdocumentor-signature__response_type">void</span>
  264. &mdash;
  265. </article>
  266. <article
  267. class="phpdocumentor-element
  268. -method
  269. -public
  270. "
  271. >
  272. <h4 class="phpdocumentor-element__name" id="method_testIsNumber">
  273. testIsNumber()
  274. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#method_testIsNumber" class="headerlink"><i class="fas fa-link"></i></a>
  275. </h4>
  276. <aside class="phpdocumentor-element-found-in">
  277. <abbr class="phpdocumentor-element-found-in__file" title="tests/QRCodeTest.php"><a href="files/tests-qrcodetest.html"><abbr title="tests/QRCodeTest.php">QRCodeTest.php</abbr></a></abbr>
  278. :
  279. <span class="phpdocumentor-element-found-in__line">41</span>
  280. </aside>
  281. <p class="phpdocumentor-summary">isNumber() should pass on any number and fail on anything else</p>
  282. <code class="phpdocumentor-code phpdocumentor-signature ">
  283. <span class="phpdocumentor-signature__visibility">public</span>
  284. <span class="phpdocumentor-signature__name">testIsNumber</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  285. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  286. <span class="phpdocumentor-signature__response_type">void</span>
  287. &mdash;
  288. </article>
  289. </section>
  290. <script type="text/javascript">
  291. function loadExternalCodeSnippets(line) {
  292. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  293. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  294. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  295. var language = 'php';
  296. var code = document.createElement('code');
  297. code.className = 'language-' + language;
  298. pre.textContent = '';
  299. pre.setAttribute('data-line', line)
  300. code.textContent = 'Loading…';
  301. pre.appendChild(code);
  302. var xhr = new XMLHttpRequest();
  303. xhr.open('GET', src, true);
  304. xhr.onreadystatechange = function () {
  305. if (xhr.readyState == 4) {
  306. if (xhr.status < 400 && xhr.responseText) {
  307. code.textContent = xhr.responseText;
  308. Prism.highlightElement(code);
  309. }
  310. else if (xhr.status >= 400) {
  311. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  312. }
  313. else {
  314. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  315. }
  316. }
  317. };
  318. xhr.send(null);
  319. });
  320. }
  321. var modals = document.querySelectorAll("[data-modal]");
  322. modals.forEach(function (trigger) {
  323. trigger.addEventListener("click", function (event) {
  324. //event.preventDefault();
  325. const modal = document.getElementById(trigger.dataset.modal);
  326. modal.classList.add("phpdocumentor-modal__open");
  327. loadExternalCodeSnippets(trigger.dataset.line)
  328. const exits = modal.querySelectorAll("[data-exit-button]");
  329. exits.forEach(function (exit) {
  330. exit.addEventListener("click", function (event) {
  331. event.preventDefault();
  332. modal.classList.remove("phpdocumentor-modal__open");
  333. });
  334. });
  335. });
  336. });
  337. </script>
  338. </article>
  339. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  340. <section class="phpdocumentor-search-results__dialog">
  341. <header class="phpdocumentor-search-results__header">
  342. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  343. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  344. </header>
  345. <section class="phpdocumentor-search-results__body">
  346. <ul class="phpdocumentor-search-results__entries"></ul>
  347. </section>
  348. </section>
  349. </section>
  350. </div>
  351. </div>
  352. <a href="classes/chillerlan-QRCodeTest-QRCodeTest.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  353. </main>
  354. <script>
  355. cssVars({});
  356. </script>
  357. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  358. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  359. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  360. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  361. </body>
  362. </html>