chillerlan-QRCodeTest-Output-QROutputTestAbstract.html 22 KB

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