chillerlan-QRCodeTest-Output-QROutputTestAbstract.html 63 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343
  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. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcodetest-output.html">Output</a></li>
  112. </ul>
  113. <article class="phpdocumentor-element -class">
  114. <h2 class="phpdocumentor-content__title">
  115. QROutputTestAbstract
  116. <span class="phpdocumentor-element__extends">
  117. extends <abbr title="\PHPUnit\Framework\TestCase">TestCase</abbr>
  118. </span>
  119. <div class="phpdocumentor-element__package">
  120. in package
  121. <ul class="phpdocumentor-breadcrumbs">
  122. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  123. </ul>
  124. </div>
  125. <span class="phpdocumentor-element__extends">
  126. uses
  127. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html"><abbr title="\chillerlan\QRCodeTest\Traits\BuildDirTrait">BuildDirTrait</abbr></a> </span>
  128. </h2>
  129. <div class="phpdocumentor-label-line">
  130. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Abstract</span><span>Yes</span></div>
  131. </div>
  132. <aside class="phpdocumentor-element-found-in">
  133. <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>
  134. :
  135. <span class="phpdocumentor-element-found-in__line">27</span>
  136. </aside>
  137. <p class="phpdocumentor-summary">Test abstract for the several (built-in) output modules,
  138. should also be used to test custom output modules</p>
  139. <h3 id="toc">
  140. Table of Contents
  141. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  142. </h3>
  143. <h4 id="toc-constants">
  144. Constants
  145. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  146. </h4>
  147. <dl class="phpdocumentor-table-of-contents">
  148. <dt class="phpdocumentor-table-of-contents__entry -constant -protected">
  149. <a class="" href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#constant__buildDir">_buildDir</a>
  150. <span>
  151. &nbsp;= __DIR__ . &#039;/../../.build/&#039; </span>
  152. </dt>
  153. <dt class="phpdocumentor-table-of-contents__entry -constant -protected">
  154. <a class="" href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#constant_buildDir">buildDir</a>
  155. <span>
  156. &nbsp;= &#039;output-test&#039; </span>
  157. </dt>
  158. </dl>
  159. <h4 id="toc-properties">
  160. Properties
  161. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  162. </h4>
  163. <dl class="phpdocumentor-table-of-contents">
  164. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  165. <a class="" href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#property_matrix">$matrix</a>
  166. <span>
  167. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  168. </dt>
  169. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  170. <a class="" href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#property_options">$options</a>
  171. <span>
  172. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  173. </dt>
  174. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  175. <a class="" href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#property_outputInterface">$outputInterface</a>
  176. <span>
  177. &nbsp;: <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a> </span>
  178. </dt>
  179. </dl>
  180. <h4 id="toc-methods">
  181. Methods
  182. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  183. </h4>
  184. <dl class="phpdocumentor-table-of-contents">
  185. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  186. <a class="" href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_moduleValueProvider">moduleValueProvider()</a>
  187. <span>
  188. &nbsp;: array&lt;string|int, mixed&gt; </span>
  189. </dt>
  190. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  191. <a class="" href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_renderToCacheFile">renderToCacheFile()</a>
  192. <span>
  193. &nbsp;: void </span>
  194. </dt>
  195. <dd>coverage of the built-in output modules</dd>
  196. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  197. <a class="" href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_saveException">saveException()</a>
  198. <span>
  199. &nbsp;: void </span>
  200. </dt>
  201. <dd>Tests if an exception is thrown when trying to write a cache file to an invalid destination</dd>
  202. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  203. <a class="" href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_setModuleValues">setModuleValues()</a>
  204. <span>
  205. &nbsp;: void </span>
  206. </dt>
  207. <dd>covers the module values settings</dd>
  208. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  209. <a class="" href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_validateModuleValues">validateModuleValues()</a>
  210. <span>
  211. &nbsp;: void </span>
  212. </dt>
  213. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  214. <a class="" href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_createBuildDir">createBuildDir()</a>
  215. <span>
  216. &nbsp;: void </span>
  217. </dt>
  218. <dd>attempts to create the build dir</dd>
  219. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  220. <a class="" href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildDir">getBuildDir()</a>
  221. <span>
  222. &nbsp;: string </span>
  223. </dt>
  224. <dd>returns the full (real) path to the given build path</dd>
  225. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  226. <a class="" href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFileContent">getBuildFileContent()</a>
  227. <span>
  228. &nbsp;: string </span>
  229. </dt>
  230. <dd>returns the contents of the given build file</dd>
  231. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  232. <a class="" href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFilePath">getBuildFilePath()</a>
  233. <span>
  234. &nbsp;: string </span>
  235. </dt>
  236. <dd>returns the full (real) path to the given build file</dd>
  237. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  238. <a class="" href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildPath">getBuildPath()</a>
  239. <span>
  240. &nbsp;: string </span>
  241. </dt>
  242. <dd>returns the full raw path to the build dir</dd>
  243. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  244. <a class="" href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_getOutputInterface">getOutputInterface()</a>
  245. <span>
  246. &nbsp;: <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a> </span>
  247. </dt>
  248. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  249. <a class="" href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_setUp">setUp()</a>
  250. <span>
  251. &nbsp;: void </span>
  252. </dt>
  253. <dd>Attempts to create a directory under /.build and instances several required objects</dd>
  254. </dl>
  255. <section class="phpdocumentor-constants">
  256. <h3 class="phpdocumentor-elements__header" id="constants">
  257. Constants
  258. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  259. </h3>
  260. <article class="phpdocumentor-element -constant -protected ">
  261. <h4 class="phpdocumentor-element__name" id="constant__buildDir">
  262. _buildDir
  263. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#constant__buildDir" class="headerlink"><i class="fas fa-link"></i></a>
  264. </h4>
  265. <aside class="phpdocumentor-element-found-in">
  266. <abbr class="phpdocumentor-element-found-in__file" title="tests/Traits/BuildDirTrait.php"><a href="files/tests-traits-builddirtrait.html"><abbr title="tests/Traits/BuildDirTrait.php">BuildDirTrait.php</abbr></a></abbr>
  267. :
  268. <span class="phpdocumentor-element-found-in__line">22</span>
  269. </aside>
  270. <code class="phpdocumentor-signature phpdocumentor-code ">
  271. <span class="phpdocumentor-signature__visibility">protected</span>
  272. <span class="phpdocumentor-signature__type">mixed</span>
  273. <span class="phpdocumentor-signature__name">_buildDir</span>
  274. = <span class="phpdocumentor-signature__default-value">__DIR__ . &#039;/../../.build/&#039;</span>
  275. </code>
  276. </article>
  277. <article class="phpdocumentor-element -constant -protected ">
  278. <h4 class="phpdocumentor-element__name" id="constant_buildDir">
  279. buildDir
  280. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#constant_buildDir" 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">34</span>
  286. </aside>
  287. <code class="phpdocumentor-signature phpdocumentor-code ">
  288. <span class="phpdocumentor-signature__visibility">protected</span>
  289. <span class="phpdocumentor-signature__type">mixed</span>
  290. <span class="phpdocumentor-signature__name">buildDir</span>
  291. = <span class="phpdocumentor-signature__default-value">&#039;output-test&#039;</span>
  292. </code>
  293. </article>
  294. </section>
  295. <section class="phpdocumentor-properties">
  296. <h3 class="phpdocumentor-elements__header" id="properties">
  297. Properties
  298. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  299. </h3>
  300. <article
  301. class="
  302. phpdocumentor-element
  303. -property
  304. -protected
  305. "
  306. >
  307. <h4 class="phpdocumentor-element__name" id="property_matrix">
  308. $matrix
  309. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  310. <span class="phpdocumentor-element__modifiers">
  311. </span>
  312. </h4>
  313. <aside class="phpdocumentor-element-found-in">
  314. <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>
  315. :
  316. <span class="phpdocumentor-element-found-in__line">32</span>
  317. </aside>
  318. <code class="phpdocumentor-code phpdocumentor-signature ">
  319. <span class="phpdocumentor-signature__visibility">protected</span>
  320. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  321. <span class="phpdocumentor-signature__name">$matrix</span>
  322. </code>
  323. </article>
  324. <article
  325. class="
  326. phpdocumentor-element
  327. -property
  328. -protected
  329. "
  330. >
  331. <h4 class="phpdocumentor-element__name" id="property_options">
  332. $options
  333. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  334. <span class="phpdocumentor-element__modifiers">
  335. </span>
  336. </h4>
  337. <aside class="phpdocumentor-element-found-in">
  338. <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>
  339. :
  340. <span class="phpdocumentor-element-found-in__line">30</span>
  341. </aside>
  342. <code class="phpdocumentor-code phpdocumentor-signature ">
  343. <span class="phpdocumentor-signature__visibility">protected</span>
  344. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  345. <span class="phpdocumentor-signature__name">$options</span>
  346. </code>
  347. </article>
  348. <article
  349. class="
  350. phpdocumentor-element
  351. -property
  352. -protected
  353. "
  354. >
  355. <h4 class="phpdocumentor-element__name" id="property_outputInterface">
  356. $outputInterface
  357. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#property_outputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  358. <span class="phpdocumentor-element__modifiers">
  359. </span>
  360. </h4>
  361. <aside class="phpdocumentor-element-found-in">
  362. <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>
  363. :
  364. <span class="phpdocumentor-element-found-in__line">31</span>
  365. </aside>
  366. <code class="phpdocumentor-code phpdocumentor-signature ">
  367. <span class="phpdocumentor-signature__visibility">protected</span>
  368. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></span>
  369. <span class="phpdocumentor-signature__name">$outputInterface</span>
  370. </code>
  371. </article>
  372. </section>
  373. <section class="phpdocumentor-methods">
  374. <h3 class="phpdocumentor-elements__header" id="methods">
  375. Methods
  376. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  377. </h3>
  378. <article
  379. class="phpdocumentor-element
  380. -method
  381. -public
  382. -abstract -static "
  383. >
  384. <h4 class="phpdocumentor-element__name" id="method_moduleValueProvider">
  385. moduleValueProvider()
  386. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_moduleValueProvider" 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="tests/Output/QROutputTestAbstract.php"><a href="files/tests-output-qroutputtestabstract.html"><abbr title="tests/Output/QROutputTestAbstract.php">QROutputTestAbstract.php</abbr></a></abbr>
  390. :
  391. <span class="phpdocumentor-element-found-in__line">66</span>
  392. </aside>
  393. <code class="phpdocumentor-code phpdocumentor-signature ">
  394. <span class="phpdocumentor-signature__visibility">public</span>
  395. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">moduleValueProvider</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  396. <div class="phpdocumentor-label-line">
  397. </div>
  398. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  399. Tags
  400. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_moduleValueProvider#tags" class="headerlink"><i class="fas fa-link"></i></a>
  401. </h5>
  402. <dl class="phpdocumentor-tag-list">
  403. <dt class="phpdocumentor-tag-list__entry">
  404. <span class="phpdocumentor-tag__name">phpstan-return</span>
  405. </dt>
  406. <dd class="phpdocumentor-tag-list__definition">
  407. <section class="phpdocumentor-description"><p>array&lt;string, array{0: mixed, 1: bool}&gt;</p>
  408. </section>
  409. </dd>
  410. </dl>
  411. <section>
  412. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  413. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  414. </section>
  415. </article>
  416. <article
  417. class="phpdocumentor-element
  418. -method
  419. -public
  420. "
  421. >
  422. <h4 class="phpdocumentor-element__name" id="method_renderToCacheFile">
  423. renderToCacheFile()
  424. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_renderToCacheFile" class="headerlink"><i class="fas fa-link"></i></a>
  425. </h4>
  426. <aside class="phpdocumentor-element-found-in">
  427. <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>
  428. :
  429. <span class="phpdocumentor-element-found-in__line">87</span>
  430. </aside>
  431. <p class="phpdocumentor-summary">coverage of the built-in output modules</p>
  432. <code class="phpdocumentor-code phpdocumentor-signature ">
  433. <span class="phpdocumentor-signature__visibility">public</span>
  434. <span class="phpdocumentor-signature__name">renderToCacheFile</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  435. <div class="phpdocumentor-label-line">
  436. </div>
  437. <section class="phpdocumentor-attributes">
  438. <h5 class="phpdocumentor-elements__header" id="attributes">
  439. Attributes <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_renderToCacheFile#attributes" class="headerlink"><i class="fas fa-link"></i></a>
  440. </h5>
  441. <dl class="phpdocumentor-argument-list">
  442. <dt class="phpdocumentor-argument-list__entry">
  443. #[<abbr title="\PHPUnit\Framework\Attributes\Test">Test</abbr>]
  444. </dt>
  445. </dl>
  446. </section>
  447. </article>
  448. <article
  449. class="phpdocumentor-element
  450. -method
  451. -public
  452. "
  453. >
  454. <h4 class="phpdocumentor-element__name" id="method_saveException">
  455. saveException()
  456. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_saveException" class="headerlink"><i class="fas fa-link"></i></a>
  457. </h4>
  458. <aside class="phpdocumentor-element-found-in">
  459. <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>
  460. :
  461. <span class="phpdocumentor-element-found-in__line">55</span>
  462. </aside>
  463. <p class="phpdocumentor-summary">Tests if an exception is thrown when trying to write a cache file to an invalid destination</p>
  464. <code class="phpdocumentor-code phpdocumentor-signature ">
  465. <span class="phpdocumentor-signature__visibility">public</span>
  466. <span class="phpdocumentor-signature__name">saveException</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  467. <div class="phpdocumentor-label-line">
  468. </div>
  469. <section class="phpdocumentor-attributes">
  470. <h5 class="phpdocumentor-elements__header" id="attributes">
  471. Attributes <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_saveException#attributes" class="headerlink"><i class="fas fa-link"></i></a>
  472. </h5>
  473. <dl class="phpdocumentor-argument-list">
  474. <dt class="phpdocumentor-argument-list__entry">
  475. #[<abbr title="\PHPUnit\Framework\Attributes\Test">Test</abbr>]
  476. </dt>
  477. </dl>
  478. </section>
  479. </article>
  480. <article
  481. class="phpdocumentor-element
  482. -method
  483. -public
  484. -abstract "
  485. >
  486. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  487. setModuleValues()
  488. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  489. </h4>
  490. <aside class="phpdocumentor-element-found-in">
  491. <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>
  492. :
  493. <span class="phpdocumentor-element-found-in__line">81</span>
  494. </aside>
  495. <p class="phpdocumentor-summary">covers the module values settings</p>
  496. <code class="phpdocumentor-code phpdocumentor-signature ">
  497. <span class="phpdocumentor-signature__visibility">public</span>
  498. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  499. <div class="phpdocumentor-label-line">
  500. </div>
  501. <section class="phpdocumentor-attributes">
  502. <h5 class="phpdocumentor-elements__header" id="attributes">
  503. Attributes <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_setModuleValues#attributes" class="headerlink"><i class="fas fa-link"></i></a>
  504. </h5>
  505. <dl class="phpdocumentor-argument-list">
  506. <dt class="phpdocumentor-argument-list__entry">
  507. #[<abbr title="\PHPUnit\Framework\Attributes\Test">Test</abbr>]
  508. </dt>
  509. </dl>
  510. </section>
  511. </article>
  512. <article
  513. class="phpdocumentor-element
  514. -method
  515. -public
  516. "
  517. >
  518. <h4 class="phpdocumentor-element__name" id="method_validateModuleValues">
  519. validateModuleValues()
  520. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_validateModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  521. </h4>
  522. <aside class="phpdocumentor-element-found-in">
  523. <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>
  524. :
  525. <span class="phpdocumentor-element-found-in__line">68</span>
  526. </aside>
  527. <code class="phpdocumentor-code phpdocumentor-signature ">
  528. <span class="phpdocumentor-signature__visibility">public</span>
  529. <span class="phpdocumentor-signature__name">validateModuleValues</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$expected</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  530. <div class="phpdocumentor-label-line">
  531. </div>
  532. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  533. <dl class="phpdocumentor-argument-list">
  534. <dt class="phpdocumentor-argument-list__entry">
  535. <span class="phpdocumentor-signature__argument__name">$value</span>
  536. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  537. </dt>
  538. <dd class="phpdocumentor-argument-list__definition">
  539. </dd>
  540. <dt class="phpdocumentor-argument-list__entry">
  541. <span class="phpdocumentor-signature__argument__name">$expected</span>
  542. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  543. </dt>
  544. <dd class="phpdocumentor-argument-list__definition">
  545. </dd>
  546. </dl>
  547. <section class="phpdocumentor-attributes">
  548. <h5 class="phpdocumentor-elements__header" id="attributes">
  549. Attributes <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_validateModuleValues#attributes" class="headerlink"><i class="fas fa-link"></i></a>
  550. </h5>
  551. <dl class="phpdocumentor-argument-list">
  552. <dt class="phpdocumentor-argument-list__entry">
  553. #[<abbr title="\PHPUnit\Framework\Attributes\DataProvider">DataProvider</abbr>]
  554. </dt>
  555. <dd class="phpdocumentor-argument-list__entry">
  556. &#039;moduleValueProvider&#039;
  557. </dd>
  558. </dl>
  559. <dl class="phpdocumentor-argument-list">
  560. <dt class="phpdocumentor-argument-list__entry">
  561. #[<abbr title="\PHPUnit\Framework\Attributes\Test">Test</abbr>]
  562. </dt>
  563. </dl>
  564. </section>
  565. </article>
  566. <article
  567. class="phpdocumentor-element
  568. -method
  569. -protected
  570. "
  571. >
  572. <h4 class="phpdocumentor-element__name" id="method_createBuildDir">
  573. createBuildDir()
  574. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_createBuildDir" class="headerlink"><i class="fas fa-link"></i></a>
  575. </h4>
  576. <aside class="phpdocumentor-element-found-in">
  577. <abbr class="phpdocumentor-element-found-in__file" title="tests/Traits/BuildDirTrait.php"><a href="files/tests-traits-builddirtrait.html"><abbr title="tests/Traits/BuildDirTrait.php">BuildDirTrait.php</abbr></a></abbr>
  578. :
  579. <span class="phpdocumentor-element-found-in__line">36</span>
  580. </aside>
  581. <p class="phpdocumentor-summary">attempts to create the build dir</p>
  582. <code class="phpdocumentor-code phpdocumentor-signature ">
  583. <span class="phpdocumentor-signature__visibility">protected</span>
  584. <span class="phpdocumentor-signature__name">createBuildDir</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$subPath</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  585. <div class="phpdocumentor-label-line">
  586. </div>
  587. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  588. <dl class="phpdocumentor-argument-list">
  589. <dt class="phpdocumentor-argument-list__entry">
  590. <span class="phpdocumentor-signature__argument__name">$subPath</span>
  591. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  592. </dt>
  593. <dd class="phpdocumentor-argument-list__definition">
  594. </dd>
  595. </dl>
  596. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  597. Tags
  598. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_createBuildDir#tags" class="headerlink"><i class="fas fa-link"></i></a>
  599. </h5>
  600. <dl class="phpdocumentor-tag-list">
  601. <dt class="phpdocumentor-tag-list__entry">
  602. <span class="phpdocumentor-tag__name">throws</span>
  603. </dt>
  604. <dd class="phpdocumentor-tag-list__definition">
  605. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  606. </dd>
  607. </dl>
  608. </article>
  609. <article
  610. class="phpdocumentor-element
  611. -method
  612. -protected
  613. "
  614. >
  615. <h4 class="phpdocumentor-element__name" id="method_getBuildDir">
  616. getBuildDir()
  617. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildDir" 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="tests/Traits/BuildDirTrait.php"><a href="files/tests-traits-builddirtrait.html"><abbr title="tests/Traits/BuildDirTrait.php">BuildDirTrait.php</abbr></a></abbr>
  621. :
  622. <span class="phpdocumentor-element-found-in__line">54</span>
  623. </aside>
  624. <p class="phpdocumentor-summary">returns the full (real) path to the given build path</p>
  625. <code class="phpdocumentor-code phpdocumentor-signature ">
  626. <span class="phpdocumentor-signature__visibility">protected</span>
  627. <span class="phpdocumentor-signature__name">getBuildDir</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$subPath</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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">$subPath</span>
  634. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  635. = <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
  636. <dd class="phpdocumentor-argument-list__definition">
  637. </dd>
  638. </dl>
  639. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  640. Tags
  641. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildDir#tags" class="headerlink"><i class="fas fa-link"></i></a>
  642. </h5>
  643. <dl class="phpdocumentor-tag-list">
  644. <dt class="phpdocumentor-tag-list__entry">
  645. <span class="phpdocumentor-tag__name">throws</span>
  646. </dt>
  647. <dd class="phpdocumentor-tag-list__definition">
  648. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  649. </dd>
  650. </dl>
  651. <section>
  652. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  653. <span class="phpdocumentor-signature__response_type">string</span>
  654. </section>
  655. </article>
  656. <article
  657. class="phpdocumentor-element
  658. -method
  659. -protected
  660. "
  661. >
  662. <h4 class="phpdocumentor-element__name" id="method_getBuildFileContent">
  663. getBuildFileContent()
  664. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFileContent" class="headerlink"><i class="fas fa-link"></i></a>
  665. </h4>
  666. <aside class="phpdocumentor-element-found-in">
  667. <abbr class="phpdocumentor-element-found-in__file" title="tests/Traits/BuildDirTrait.php"><a href="files/tests-traits-builddirtrait.html"><abbr title="tests/Traits/BuildDirTrait.php">BuildDirTrait.php</abbr></a></abbr>
  668. :
  669. <span class="phpdocumentor-element-found-in__line">88</span>
  670. </aside>
  671. <p class="phpdocumentor-summary">returns the contents of the given build file</p>
  672. <code class="phpdocumentor-code phpdocumentor-signature ">
  673. <span class="phpdocumentor-signature__visibility">protected</span>
  674. <span class="phpdocumentor-signature__name">getBuildFileContent</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fileSubPath</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  675. <div class="phpdocumentor-label-line">
  676. </div>
  677. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  678. <dl class="phpdocumentor-argument-list">
  679. <dt class="phpdocumentor-argument-list__entry">
  680. <span class="phpdocumentor-signature__argument__name">$fileSubPath</span>
  681. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  682. </dt>
  683. <dd class="phpdocumentor-argument-list__definition">
  684. </dd>
  685. </dl>
  686. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  687. Tags
  688. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFileContent#tags" class="headerlink"><i class="fas fa-link"></i></a>
  689. </h5>
  690. <dl class="phpdocumentor-tag-list">
  691. <dt class="phpdocumentor-tag-list__entry">
  692. <span class="phpdocumentor-tag__name">throws</span>
  693. </dt>
  694. <dd class="phpdocumentor-tag-list__definition">
  695. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  696. </dd>
  697. </dl>
  698. <section>
  699. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  700. <span class="phpdocumentor-signature__response_type">string</span>
  701. </section>
  702. </article>
  703. <article
  704. class="phpdocumentor-element
  705. -method
  706. -protected
  707. "
  708. >
  709. <h4 class="phpdocumentor-element__name" id="method_getBuildFilePath">
  710. getBuildFilePath()
  711. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFilePath" class="headerlink"><i class="fas fa-link"></i></a>
  712. </h4>
  713. <aside class="phpdocumentor-element-found-in">
  714. <abbr class="phpdocumentor-element-found-in__file" title="tests/Traits/BuildDirTrait.php"><a href="files/tests-traits-builddirtrait.html"><abbr title="tests/Traits/BuildDirTrait.php">BuildDirTrait.php</abbr></a></abbr>
  715. :
  716. <span class="phpdocumentor-element-found-in__line">69</span>
  717. </aside>
  718. <p class="phpdocumentor-summary">returns the full (real) path to the given build file</p>
  719. <code class="phpdocumentor-code phpdocumentor-signature ">
  720. <span class="phpdocumentor-signature__visibility">protected</span>
  721. <span class="phpdocumentor-signature__name">getBuildFilePath</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fileSubPath</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  722. <div class="phpdocumentor-label-line">
  723. </div>
  724. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  725. <dl class="phpdocumentor-argument-list">
  726. <dt class="phpdocumentor-argument-list__entry">
  727. <span class="phpdocumentor-signature__argument__name">$fileSubPath</span>
  728. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  729. </dt>
  730. <dd class="phpdocumentor-argument-list__definition">
  731. </dd>
  732. </dl>
  733. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  734. Tags
  735. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFilePath#tags" class="headerlink"><i class="fas fa-link"></i></a>
  736. </h5>
  737. <dl class="phpdocumentor-tag-list">
  738. <dt class="phpdocumentor-tag-list__entry">
  739. <span class="phpdocumentor-tag__name">throws</span>
  740. </dt>
  741. <dd class="phpdocumentor-tag-list__definition">
  742. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  743. </dd>
  744. </dl>
  745. <section>
  746. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  747. <span class="phpdocumentor-signature__response_type">string</span>
  748. </section>
  749. </article>
  750. <article
  751. class="phpdocumentor-element
  752. -method
  753. -protected
  754. "
  755. >
  756. <h4 class="phpdocumentor-element__name" id="method_getBuildPath">
  757. getBuildPath()
  758. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildPath" class="headerlink"><i class="fas fa-link"></i></a>
  759. </h4>
  760. <aside class="phpdocumentor-element-found-in">
  761. <abbr class="phpdocumentor-element-found-in__file" title="tests/Traits/BuildDirTrait.php"><a href="files/tests-traits-builddirtrait.html"><abbr title="tests/Traits/BuildDirTrait.php">BuildDirTrait.php</abbr></a></abbr>
  762. :
  763. <span class="phpdocumentor-element-found-in__line">27</span>
  764. </aside>
  765. <p class="phpdocumentor-summary">returns the full raw path to the build dir</p>
  766. <code class="phpdocumentor-code phpdocumentor-signature ">
  767. <span class="phpdocumentor-signature__visibility">protected</span>
  768. <span class="phpdocumentor-signature__name">getBuildPath</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$subPath</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  769. <div class="phpdocumentor-label-line">
  770. </div>
  771. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  772. <dl class="phpdocumentor-argument-list">
  773. <dt class="phpdocumentor-argument-list__entry">
  774. <span class="phpdocumentor-signature__argument__name">$subPath</span>
  775. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  776. </dt>
  777. <dd class="phpdocumentor-argument-list__definition">
  778. </dd>
  779. </dl>
  780. <section>
  781. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  782. <span class="phpdocumentor-signature__response_type">string</span>
  783. </section>
  784. </article>
  785. <article
  786. class="phpdocumentor-element
  787. -method
  788. -protected
  789. -abstract "
  790. >
  791. <h4 class="phpdocumentor-element__name" id="method_getOutputInterface">
  792. getOutputInterface()
  793. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_getOutputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  794. </h4>
  795. <aside class="phpdocumentor-element-found-in">
  796. <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>
  797. :
  798. <span class="phpdocumentor-element-found-in__line">47</span>
  799. </aside>
  800. <code class="phpdocumentor-code phpdocumentor-signature ">
  801. <span class="phpdocumentor-signature__visibility">protected</span>
  802. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getOutputInterface</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span></span><span class="phpdocumentor-signature__argument"><span>, </span><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"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></span></code>
  803. <div class="phpdocumentor-label-line">
  804. </div>
  805. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  806. <dl class="phpdocumentor-argument-list">
  807. <dt class="phpdocumentor-argument-list__entry">
  808. <span class="phpdocumentor-signature__argument__name">$options</span>
  809. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  810. </dt>
  811. <dd class="phpdocumentor-argument-list__definition">
  812. </dd>
  813. <dt class="phpdocumentor-argument-list__entry">
  814. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  815. : <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>
  816. </dt>
  817. <dd class="phpdocumentor-argument-list__definition">
  818. </dd>
  819. </dl>
  820. <section>
  821. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  822. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></span>
  823. </section>
  824. </article>
  825. <article
  826. class="phpdocumentor-element
  827. -method
  828. -protected
  829. "
  830. >
  831. <h4 class="phpdocumentor-element__name" id="method_setUp">
  832. setUp()
  833. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_setUp" class="headerlink"><i class="fas fa-link"></i></a>
  834. </h4>
  835. <aside class="phpdocumentor-element-found-in">
  836. <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>
  837. :
  838. <span class="phpdocumentor-element-found-in__line">39</span>
  839. </aside>
  840. <p class="phpdocumentor-summary">Attempts to create a directory under /.build and instances several required objects</p>
  841. <code class="phpdocumentor-code phpdocumentor-signature ">
  842. <span class="phpdocumentor-signature__visibility">protected</span>
  843. <span class="phpdocumentor-signature__name">setUp</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  844. <div class="phpdocumentor-label-line">
  845. </div>
  846. </article>
  847. </section>
  848. <div class="phpdocumentor-modal" id="source-view">
  849. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  850. <div class="phpdocumentor-modal-container">
  851. <div class="phpdocumentor-modal-content">
  852. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/tests/Output/QROutputTestAbstract.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  853. </div>
  854. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  855. </div>
  856. </div>
  857. <script type="text/javascript">
  858. (function () {
  859. function loadExternalCodeSnippet(el, url, line) {
  860. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  861. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  862. const language = 'php';
  863. const code = document.createElement('code');
  864. code.className = 'language-' + language;
  865. pre.textContent = '';
  866. pre.setAttribute('data-line', line)
  867. code.textContent = 'Loading…';
  868. pre.appendChild(code);
  869. var xhr = new XMLHttpRequest();
  870. xhr.open('GET', src, true);
  871. xhr.onreadystatechange = function () {
  872. if (xhr.readyState !== 4) {
  873. return;
  874. }
  875. if (xhr.status < 400 && xhr.responseText) {
  876. code.textContent = xhr.responseText;
  877. Prism.highlightElement(code);
  878. d=document.getElementsByClassName("line-numbers");
  879. d[0].scrollTop = d[0].children[1].offsetTop;
  880. return;
  881. }
  882. if (xhr.status === 404) {
  883. code.textContent = '✖ Error: File could not be found';
  884. return;
  885. }
  886. if (xhr.status >= 400) {
  887. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  888. return;
  889. }
  890. code.textContent = '✖ Error: An unknown error occurred';
  891. };
  892. xhr.send(null);
  893. });
  894. }
  895. const modalButtons = document.querySelectorAll("[data-modal]");
  896. const openedAsLocalFile = window.location.protocol === 'file:';
  897. if (modalButtons.length > 0 && openedAsLocalFile) {
  898. console.warn(
  899. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  900. 'browsers block XHR requests when a page is opened this way'
  901. );
  902. }
  903. modalButtons.forEach(function (trigger) {
  904. if (openedAsLocalFile) {
  905. trigger.setAttribute("hidden", "hidden");
  906. }
  907. trigger.addEventListener("click", function (event) {
  908. event.preventDefault();
  909. const modal = document.getElementById(trigger.dataset.modal);
  910. if (!modal) {
  911. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  912. return;
  913. }
  914. modal.classList.add("phpdocumentor-modal__open");
  915. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  916. const exits = modal.querySelectorAll("[data-exit-button]");
  917. exits.forEach(function (exit) {
  918. exit.addEventListener("click", function (event) {
  919. event.preventDefault();
  920. modal.classList.remove("phpdocumentor-modal__open");
  921. });
  922. });
  923. });
  924. });
  925. })();
  926. </script>
  927. </article>
  928. </section>
  929. <section class="phpdocumentor-on-this-page__sidebar">
  930. <section class="phpdocumentor-on-this-page__content">
  931. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  932. <ul class="phpdocumentor-list -clean">
  933. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  934. <li>
  935. <ul class="phpdocumentor-list -clean">
  936. <li><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#toc-constants">Constants</a></li>
  937. <li><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#toc-properties">Properties</a></li>
  938. <li><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#toc-methods">Methods</a></li>
  939. </ul>
  940. </li>
  941. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  942. <li>
  943. <ul class="phpdocumentor-list -clean">
  944. <li class=""><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#constant__buildDir">_buildDir</a></li>
  945. <li class=""><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#constant_buildDir">buildDir</a></li>
  946. </ul>
  947. </li>
  948. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  949. <li>
  950. <ul class="phpdocumentor-list -clean">
  951. <li class=""><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#property_matrix">$matrix</a></li>
  952. <li class=""><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#property_options">$options</a></li>
  953. <li class=""><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#property_outputInterface">$outputInterface</a></li>
  954. </ul>
  955. </li>
  956. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  957. <li>
  958. <ul class="phpdocumentor-list -clean">
  959. <li class=""><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_moduleValueProvider">moduleValueProvider()</a></li>
  960. <li class=""><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_renderToCacheFile">renderToCacheFile()</a></li>
  961. <li class=""><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_saveException">saveException()</a></li>
  962. <li class=""><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  963. <li class=""><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_validateModuleValues">validateModuleValues()</a></li>
  964. <li class=""><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_createBuildDir">createBuildDir()</a></li>
  965. <li class=""><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildDir">getBuildDir()</a></li>
  966. <li class=""><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFileContent">getBuildFileContent()</a></li>
  967. <li class=""><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFilePath">getBuildFilePath()</a></li>
  968. <li class=""><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildPath">getBuildPath()</a></li>
  969. <li class=""><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_getOutputInterface">getOutputInterface()</a></li>
  970. <li class=""><a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#method_setUp">setUp()</a></li>
  971. </ul>
  972. </li>
  973. </ul>
  974. </section>
  975. </section>
  976. </div>
  977. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  978. <section class="phpdocumentor-search-results__dialog">
  979. <header class="phpdocumentor-search-results__header">
  980. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  981. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  982. </header>
  983. <section class="phpdocumentor-search-results__body">
  984. <ul class="phpdocumentor-search-results__entries"></ul>
  985. </section>
  986. </section>
  987. </section>
  988. </div>
  989. <a href="classes/chillerlan-QRCodeTest-Output-QROutputTestAbstract.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  990. </main>
  991. <script>
  992. cssVars({});
  993. </script>
  994. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  995. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  996. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  997. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  998. </body>
  999. </html>