chillerlan-QRCodeTest-QRMatrixDebugTrait.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448
  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. </section>
  89. <section class="phpdocumentor-sidebar__category -packages">
  90. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  91. <h4 class="phpdocumentor-sidebar__root-namespace">
  92. <a href="packages/Application.html" class="">Application</a>
  93. </h4>
  94. </section>
  95. <section class="phpdocumentor-sidebar__category -reports">
  96. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  97. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  98. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  99. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  100. </section>
  101. <section class="phpdocumentor-sidebar__category -indices">
  102. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  103. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  104. </section>
  105. </aside>
  106. <div class="phpdocumentor-column -nine phpdocumentor-content">
  107. <section>
  108. <ul class="phpdocumentor-breadcrumbs">
  109. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  110. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a></li>
  111. </ul>
  112. <article class="phpdocumentor-element -trait">
  113. <h2 class="phpdocumentor-content__title">
  114. QRMatrixDebugTrait
  115. </h2>
  116. <aside class="phpdocumentor-element-found-in">
  117. <abbr class="phpdocumentor-element-found-in__file" title="tests/QRMatrixDebugTrait.php"><a href="files/tests-qrmatrixdebugtrait.html"><abbr title="tests/QRMatrixDebugTrait.php">QRMatrixDebugTrait.php</abbr></a></abbr>
  118. :
  119. <span class="phpdocumentor-element-found-in__line">22</span>
  120. </aside>
  121. <p class="phpdocumentor-summary">Trait QRMatrixDebugTrait</p>
  122. <h3 id="toc">
  123. Table of Contents
  124. <a href="classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  125. </h3>
  126. <h4 id="toc-methods">
  127. Methods
  128. <a href="classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  129. </h4>
  130. <dl class="phpdocumentor-table-of-contents">
  131. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  132. <a class="" href="classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html#method_debugMatrix">debugMatrix()</a>
  133. <span>
  134. &nbsp;: void </span>
  135. </dt>
  136. <dd>Matrix debugging console output</dd>
  137. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  138. <a class="" href="classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html#method_dm">dm()</a>
  139. <span>
  140. &nbsp;: void </span>
  141. </dt>
  142. <dd>debugging shortcut - limit to a single version when using with matrixProvider</dd>
  143. </dl>
  144. <section class="phpdocumentor-methods">
  145. <h3 class="phpdocumentor-elements__header" id="methods">
  146. Methods
  147. <a href="classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  148. </h3>
  149. <article
  150. class="phpdocumentor-element
  151. -method
  152. -protected
  153. "
  154. >
  155. <h4 class="phpdocumentor-element__name" id="method_debugMatrix">
  156. debugMatrix()
  157. <a href="classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html#method_debugMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  158. </h4>
  159. <aside class="phpdocumentor-element-found-in">
  160. <abbr class="phpdocumentor-element-found-in__file" title="tests/QRMatrixDebugTrait.php"><a href="files/tests-qrmatrixdebugtrait.html"><abbr title="tests/QRMatrixDebugTrait.php">QRMatrixDebugTrait.php</abbr></a></abbr>
  161. :
  162. <span class="phpdocumentor-element-found-in__line">27</span>
  163. </aside>
  164. <p class="phpdocumentor-summary">Matrix debugging console output</p>
  165. <code class="phpdocumentor-code phpdocumentor-signature ">
  166. <span class="phpdocumentor-signature__visibility">protected</span>
  167. <span class="phpdocumentor-signature__name">debugMatrix</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  168. <div class="phpdocumentor-label-line">
  169. </div>
  170. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  171. <dl class="phpdocumentor-argument-list">
  172. <dt class="phpdocumentor-argument-list__entry">
  173. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  174. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  175. </dt>
  176. <dd class="phpdocumentor-argument-list__definition">
  177. </dd>
  178. </dl>
  179. </article>
  180. <article
  181. class="phpdocumentor-element
  182. -method
  183. -protected
  184. "
  185. >
  186. <h4 class="phpdocumentor-element__name" id="method_dm">
  187. dm()
  188. <a href="classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html#method_dm" class="headerlink"><i class="fas fa-link"></i></a>
  189. </h4>
  190. <aside class="phpdocumentor-element-found-in">
  191. <abbr class="phpdocumentor-element-found-in__file" title="tests/QRMatrixDebugTrait.php"><a href="files/tests-qrmatrixdebugtrait.html"><abbr title="tests/QRMatrixDebugTrait.php">QRMatrixDebugTrait.php</abbr></a></abbr>
  192. :
  193. <span class="phpdocumentor-element-found-in__line">84</span>
  194. </aside>
  195. <p class="phpdocumentor-summary">debugging shortcut - limit to a single version when using with matrixProvider</p>
  196. <code class="phpdocumentor-code phpdocumentor-signature ">
  197. <span class="phpdocumentor-signature__visibility">protected</span>
  198. <span class="phpdocumentor-signature__name">dm</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  199. <div class="phpdocumentor-label-line">
  200. </div>
  201. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  202. <dl class="phpdocumentor-argument-list">
  203. <dt class="phpdocumentor-argument-list__entry">
  204. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  205. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  206. </dt>
  207. <dd class="phpdocumentor-argument-list__definition">
  208. </dd>
  209. </dl>
  210. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  211. Tags
  212. <a href="classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html#method_dm#tags" class="headerlink"><i class="fas fa-link"></i></a>
  213. </h5>
  214. <dl class="phpdocumentor-tag-list">
  215. <dt class="phpdocumentor-tag-list__entry">
  216. <span class="phpdocumentor-tag__name">see</span>
  217. </dt>
  218. <dd class="phpdocumentor-tag-list__definition">
  219. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCodeTest\QRMatrixTest::matrixProvider()">QRMatrixTest::matrixProvider()</abbr></span>
  220. </dd>
  221. </dl>
  222. </article>
  223. </section>
  224. <div class="phpdocumentor-modal" id="source-view">
  225. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  226. <div class="phpdocumentor-modal-container">
  227. <div class="phpdocumentor-modal-content">
  228. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/tests/QRMatrixDebugTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  229. </div>
  230. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  231. </div>
  232. </div>
  233. <script type="text/javascript">
  234. (function () {
  235. function loadExternalCodeSnippet(el, url, line) {
  236. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  237. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  238. const language = 'php';
  239. const code = document.createElement('code');
  240. code.className = 'language-' + language;
  241. pre.textContent = '';
  242. pre.setAttribute('data-line', line)
  243. code.textContent = 'Loading…';
  244. pre.appendChild(code);
  245. var xhr = new XMLHttpRequest();
  246. xhr.open('GET', src, true);
  247. xhr.onreadystatechange = function () {
  248. if (xhr.readyState !== 4) {
  249. return;
  250. }
  251. if (xhr.status < 400 && xhr.responseText) {
  252. code.textContent = xhr.responseText;
  253. Prism.highlightElement(code);
  254. d=document.getElementsByClassName("line-numbers");
  255. d[0].scrollTop = d[0].children[1].offsetTop;
  256. return;
  257. }
  258. if (xhr.status === 404) {
  259. code.textContent = '✖ Error: File could not be found';
  260. return;
  261. }
  262. if (xhr.status >= 400) {
  263. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  264. return;
  265. }
  266. code.textContent = '✖ Error: An unknown error occurred';
  267. };
  268. xhr.send(null);
  269. });
  270. }
  271. const modalButtons = document.querySelectorAll("[data-modal]");
  272. const openedAsLocalFile = window.location.protocol === 'file:';
  273. if (modalButtons.length > 0 && openedAsLocalFile) {
  274. console.warn(
  275. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  276. 'browsers block XHR requests when a page is opened this way'
  277. );
  278. }
  279. modalButtons.forEach(function (trigger) {
  280. if (openedAsLocalFile) {
  281. trigger.setAttribute("hidden", "hidden");
  282. }
  283. trigger.addEventListener("click", function (event) {
  284. event.preventDefault();
  285. const modal = document.getElementById(trigger.dataset.modal);
  286. if (!modal) {
  287. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  288. return;
  289. }
  290. modal.classList.add("phpdocumentor-modal__open");
  291. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  292. const exits = modal.querySelectorAll("[data-exit-button]");
  293. exits.forEach(function (exit) {
  294. exit.addEventListener("click", function (event) {
  295. event.preventDefault();
  296. modal.classList.remove("phpdocumentor-modal__open");
  297. });
  298. });
  299. });
  300. });
  301. })();
  302. </script>
  303. </article>
  304. </section>
  305. <section class="phpdocumentor-on-this-page__sidebar">
  306. <section class="phpdocumentor-on-this-page__content">
  307. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  308. <ul class="phpdocumentor-list -clean">
  309. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  310. <li>
  311. <ul class="phpdocumentor-list -clean">
  312. <li><a href="classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html#toc-methods">Methods</a></li>
  313. </ul>
  314. </li>
  315. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  316. <li>
  317. <ul class="phpdocumentor-list -clean">
  318. <li class=""><a href="classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html#method_debugMatrix">debugMatrix()</a></li>
  319. <li class=""><a href="classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html#method_dm">dm()</a></li>
  320. </ul>
  321. </li>
  322. </ul>
  323. </section>
  324. </section>
  325. </div>
  326. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  327. <section class="phpdocumentor-search-results__dialog">
  328. <header class="phpdocumentor-search-results__header">
  329. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  330. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  331. </header>
  332. <section class="phpdocumentor-search-results__body">
  333. <ul class="phpdocumentor-search-results__entries"></ul>
  334. </section>
  335. </section>
  336. </section>
  337. </div>
  338. <a href="classes/chillerlan-QRCodeTest-QRMatrixDebugTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  339. </main>
  340. <script>
  341. cssVars({});
  342. </script>
  343. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  344. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  345. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  346. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  347. </body>
  348. </html>