chillerlan-QRCodeTest-Output-QRMarkupTest.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505
  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. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcodetest-output.html">Output</a></li>
  85. </ul>
  86. <article class="phpdocumentor-element -class">
  87. <h2 class="phpdocumentor-content__title">
  88. QRMarkupTest
  89. <span class="phpdocumentor-element__extends">
  90. extends <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html"><abbr title="\chillerlan\QRCodeTest\Output\QROutputTestAbstract">QROutputTestAbstract</abbr></a>
  91. </span>
  92. <div class="phpdocumentor-element__package">
  93. in package
  94. <ul class="phpdocumentor-breadcrumbs">
  95. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  96. </ul>
  97. </div>
  98. </h2>
  99. <aside class="phpdocumentor-element-found-in">
  100. <abbr class="phpdocumentor-element-found-in__file" title="tests/Output/QRMarkupTest.php"><a href="files/tests-output-qrmarkuptest.html"><abbr title="tests/Output/QRMarkupTest.php">QRMarkupTest.php</abbr></a></abbr>
  101. :
  102. <span class="phpdocumentor-element-found-in__line">19</span>
  103. </aside>
  104. <p class="phpdocumentor-summary">Tests the QRMarkup output module</p>
  105. <h3 id="toc">
  106. Table of Contents
  107. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  108. </h3>
  109. <dl class="phpdocumentor-table-of-contents">
  110. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  111. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_testInstance">testInstance()</a>
  112. <span>
  113. &nbsp;: void </span>
  114. </dt>
  115. <dd>Validate the instance of the interface</dd>
  116. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  117. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_testRenderImage">testRenderImage()</a>
  118. <span>
  119. &nbsp;: void </span>
  120. </dt>
  121. <dd>covers the built-in output modules, tests against pre-rendered data</dd>
  122. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  123. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_testSaveException">testSaveException()</a>
  124. <span>
  125. &nbsp;: void </span>
  126. </dt>
  127. <dd>Tests if an exception is thrown when trying to write a cache file to an invalid destination</dd>
  128. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  129. <a href="classes/chillerlan-QRCodeTest-Output-QRMarkupTest.html#method_testSetModuleValues">testSetModuleValues()</a>
  130. <span>
  131. &nbsp;: void </span>
  132. </dt>
  133. <dd>covers the module values settings</dd>
  134. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  135. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_testStringOutput">testStringOutput()</a>
  136. <span>
  137. &nbsp;: void </span>
  138. </dt>
  139. <dd>coverage of the built-in output modules</dd>
  140. </dl>
  141. <section class="phpdocumentor-methods">
  142. <h3 class="phpdocumentor-elements__header" id="methods">
  143. Methods
  144. <a href="classes/chillerlan-QRCodeTest-Output-QRMarkupTest.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  145. </h3>
  146. <article
  147. class="phpdocumentor-element
  148. -method
  149. -public
  150. "
  151. >
  152. <h4 class="phpdocumentor-element__name" id="method_testInstance">
  153. testInstance()
  154. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_testInstance" class="headerlink"><i class="fas fa-link"></i></a>
  155. </h4>
  156. <aside class="phpdocumentor-element-found-in">
  157. <abbr class="phpdocumentor-element-found-in__file" title="tests/Output/QROutputTestAbstract.php"><a href="files/tests-output-qroutputtestabstract.html"><abbr title="tests/Output/QROutputTestAbstract.php">QROutputTestAbstract.php</abbr></a></abbr>
  158. :
  159. <span class="phpdocumentor-element-found-in__line">65</span>
  160. </aside>
  161. <p class="phpdocumentor-summary">Validate the instance of the interface</p>
  162. <code class="phpdocumentor-code phpdocumentor-signature ">
  163. <span class="phpdocumentor-signature__visibility">public</span>
  164. <span class="phpdocumentor-signature__name">testInstance</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  165. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  166. <span class="phpdocumentor-signature__response_type">void</span>
  167. &mdash;
  168. </article>
  169. <article
  170. class="phpdocumentor-element
  171. -method
  172. -public
  173. "
  174. >
  175. <h4 class="phpdocumentor-element__name" id="method_testRenderImage">
  176. testRenderImage()
  177. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_testRenderImage" class="headerlink"><i class="fas fa-link"></i></a>
  178. </h4>
  179. <aside class="phpdocumentor-element-found-in">
  180. <abbr class="phpdocumentor-element-found-in__file" title="tests/Output/QROutputTestAbstract.php"><a href="files/tests-output-qroutputtestabstract.html"><abbr title="tests/Output/QROutputTestAbstract.php">QROutputTestAbstract.php</abbr></a></abbr>
  181. :
  182. <span class="phpdocumentor-element-found-in__line">118</span>
  183. </aside>
  184. <p class="phpdocumentor-summary">covers the built-in output modules, tests against pre-rendered data</p>
  185. <code class="phpdocumentor-code phpdocumentor-signature ">
  186. <span class="phpdocumentor-signature__visibility">public</span>
  187. <span class="phpdocumentor-signature__name">testRenderImage</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  188. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  189. <dl class="phpdocumentor-argument-list">
  190. <dt class="phpdocumentor-argument-list__entry">
  191. <span class="phpdocumentor-signature__argument__name">$type</span>
  192. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  193. </dt>
  194. <dd class="phpdocumentor-argument-list__definition">
  195. <section class="phpdocumentor-description"></section>
  196. </dd>
  197. </dl>
  198. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  199. Tags
  200. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  201. </h5>
  202. <dl class="phpdocumentor-tag-list">
  203. <dt class="phpdocumentor-tag-list__entry">
  204. <span class="phpdocumentor-tag__name">dataProvider</span>
  205. </dt>
  206. <dd class="phpdocumentor-tag-list__definition">
  207. <section class="phpdocumentor-description"><p>types</p>
  208. </section>
  209. </dd>
  210. </dl>
  211. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  212. <span class="phpdocumentor-signature__response_type">void</span>
  213. &mdash;
  214. </article>
  215. <article
  216. class="phpdocumentor-element
  217. -method
  218. -public
  219. "
  220. >
  221. <h4 class="phpdocumentor-element__name" id="method_testSaveException">
  222. testSaveException()
  223. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_testSaveException" class="headerlink"><i class="fas fa-link"></i></a>
  224. </h4>
  225. <aside class="phpdocumentor-element-found-in">
  226. <abbr class="phpdocumentor-element-found-in__file" title="tests/Output/QROutputTestAbstract.php"><a href="files/tests-output-qroutputtestabstract.html"><abbr title="tests/Output/QROutputTestAbstract.php">QROutputTestAbstract.php</abbr></a></abbr>
  227. :
  228. <span class="phpdocumentor-element-found-in__line">72</span>
  229. </aside>
  230. <p class="phpdocumentor-summary">Tests if an exception is thrown when trying to write a cache file to an invalid destination</p>
  231. <code class="phpdocumentor-code phpdocumentor-signature ">
  232. <span class="phpdocumentor-signature__visibility">public</span>
  233. <span class="phpdocumentor-signature__name">testSaveException</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  234. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  235. <span class="phpdocumentor-signature__response_type">void</span>
  236. &mdash;
  237. </article>
  238. <article
  239. class="phpdocumentor-element
  240. -method
  241. -public
  242. "
  243. >
  244. <h4 class="phpdocumentor-element__name" id="method_testSetModuleValues">
  245. testSetModuleValues()
  246. <a href="classes/chillerlan-QRCodeTest-Output-QRMarkupTest.html#method_testSetModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  247. </h4>
  248. <aside class="phpdocumentor-element-found-in">
  249. <abbr class="phpdocumentor-element-found-in__file" title="tests/Output/QRMarkupTest.php"><a href="files/tests-output-qrmarkuptest.html"><abbr title="tests/Output/QRMarkupTest.php">QRMarkupTest.php</abbr></a></abbr>
  250. :
  251. <span class="phpdocumentor-element-found-in__line">43</span>
  252. </aside>
  253. <p class="phpdocumentor-summary">covers the module values settings</p>
  254. <code class="phpdocumentor-code phpdocumentor-signature ">
  255. <span class="phpdocumentor-signature__visibility">public</span>
  256. <span class="phpdocumentor-signature__name">testSetModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  257. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  258. Tags
  259. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  260. </h5>
  261. <dl class="phpdocumentor-tag-list">
  262. <dt class="phpdocumentor-tag-list__entry">
  263. <span class="phpdocumentor-tag__name">inheritDoc</span>
  264. </dt>
  265. <dd class="phpdocumentor-tag-list__definition">
  266. </dd>
  267. </dl>
  268. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  269. <span class="phpdocumentor-signature__response_type">void</span>
  270. &mdash;
  271. </article>
  272. <article
  273. class="phpdocumentor-element
  274. -method
  275. -public
  276. "
  277. >
  278. <h4 class="phpdocumentor-element__name" id="method_testStringOutput">
  279. testStringOutput()
  280. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_testStringOutput" class="headerlink"><i class="fas fa-link"></i></a>
  281. </h4>
  282. <aside class="phpdocumentor-element-found-in">
  283. <abbr class="phpdocumentor-element-found-in__file" title="tests/Output/QROutputTestAbstract.php"><a href="files/tests-output-qroutputtestabstract.html"><abbr title="tests/Output/QROutputTestAbstract.php">QROutputTestAbstract.php</abbr></a></abbr>
  284. :
  285. <span class="phpdocumentor-element-found-in__line">102</span>
  286. </aside>
  287. <p class="phpdocumentor-summary">coverage of the built-in output modules</p>
  288. <code class="phpdocumentor-code phpdocumentor-signature ">
  289. <span class="phpdocumentor-signature__visibility">public</span>
  290. <span class="phpdocumentor-signature__name">testStringOutput</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  291. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  292. <dl class="phpdocumentor-argument-list">
  293. <dt class="phpdocumentor-argument-list__entry">
  294. <span class="phpdocumentor-signature__argument__name">$type</span>
  295. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  296. </dt>
  297. <dd class="phpdocumentor-argument-list__definition">
  298. <section class="phpdocumentor-description"></section>
  299. </dd>
  300. </dl>
  301. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  302. Tags
  303. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  304. </h5>
  305. <dl class="phpdocumentor-tag-list">
  306. <dt class="phpdocumentor-tag-list__entry">
  307. <span class="phpdocumentor-tag__name">dataProvider</span>
  308. </dt>
  309. <dd class="phpdocumentor-tag-list__definition">
  310. <section class="phpdocumentor-description"><p>types</p>
  311. </section>
  312. </dd>
  313. </dl>
  314. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  315. <span class="phpdocumentor-signature__response_type">void</span>
  316. &mdash;
  317. </article>
  318. </section>
  319. <script type="text/javascript">
  320. function loadExternalCodeSnippets(line) {
  321. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  322. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  323. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  324. var language = 'php';
  325. var code = document.createElement('code');
  326. code.className = 'language-' + language;
  327. pre.textContent = '';
  328. pre.setAttribute('data-line', line)
  329. code.textContent = 'Loading…';
  330. pre.appendChild(code);
  331. var xhr = new XMLHttpRequest();
  332. xhr.open('GET', src, true);
  333. xhr.onreadystatechange = function () {
  334. if (xhr.readyState == 4) {
  335. if (xhr.status < 400 && xhr.responseText) {
  336. code.textContent = xhr.responseText;
  337. Prism.highlightElement(code);
  338. }
  339. else if (xhr.status >= 400) {
  340. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  341. }
  342. else {
  343. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  344. }
  345. }
  346. };
  347. xhr.send(null);
  348. });
  349. }
  350. var modals = document.querySelectorAll("[data-modal]");
  351. modals.forEach(function (trigger) {
  352. trigger.addEventListener("click", function (event) {
  353. //event.preventDefault();
  354. const modal = document.getElementById(trigger.dataset.modal);
  355. modal.classList.add("phpdocumentor-modal__open");
  356. loadExternalCodeSnippets(trigger.dataset.line)
  357. const exits = modal.querySelectorAll("[data-exit-button]");
  358. exits.forEach(function (exit) {
  359. exit.addEventListener("click", function (event) {
  360. event.preventDefault();
  361. modal.classList.remove("phpdocumentor-modal__open");
  362. });
  363. });
  364. });
  365. });
  366. </script>
  367. </article>
  368. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  369. <section class="phpdocumentor-search-results__dialog">
  370. <header class="phpdocumentor-search-results__header">
  371. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  372. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  373. </header>
  374. <section class="phpdocumentor-search-results__body">
  375. <ul class="phpdocumentor-search-results__entries"></ul>
  376. </section>
  377. </section>
  378. </section>
  379. </div>
  380. </div>
  381. <a href="classes/chillerlan-QRCodeTest-Output-QRMarkupTest.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  382. </main>
  383. <script>
  384. cssVars({});
  385. </script>
  386. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  387. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  388. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  389. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  390. </body>
  391. </html>