chillerlan-QRCodeTest-Traits-BuildDirTrait.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724
  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-traits.html">Traits</a></li>
  112. </ul>
  113. <article class="phpdocumentor-element -trait">
  114. <h2 class="phpdocumentor-content__title">
  115. BuildDirTrait
  116. </h2>
  117. <aside class="phpdocumentor-element-found-in">
  118. <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>
  119. :
  120. <span class="phpdocumentor-element-found-in__line">20</span>
  121. </aside>
  122. <p class="phpdocumentor-summary">Trait BuildDirTrait</p>
  123. <h3 id="toc">
  124. Table of Contents
  125. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  126. </h3>
  127. <h4 id="toc-constants">
  128. Constants
  129. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  130. </h4>
  131. <dl class="phpdocumentor-table-of-contents">
  132. <dt class="phpdocumentor-table-of-contents__entry -constant -protected">
  133. <a class="" href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#constant__buildDir">_buildDir</a>
  134. <span>
  135. &nbsp;= __DIR__ . &#039;/../../.build/&#039; </span>
  136. </dt>
  137. </dl>
  138. <h4 id="toc-methods">
  139. Methods
  140. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  141. </h4>
  142. <dl class="phpdocumentor-table-of-contents">
  143. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  144. <a class="" href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_createBuildDir">createBuildDir()</a>
  145. <span>
  146. &nbsp;: void </span>
  147. </dt>
  148. <dd>attempts to create the build dir</dd>
  149. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  150. <a class="" href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildDir">getBuildDir()</a>
  151. <span>
  152. &nbsp;: string </span>
  153. </dt>
  154. <dd>returns the full (real) path to the given build path</dd>
  155. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  156. <a class="" href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFileContent">getBuildFileContent()</a>
  157. <span>
  158. &nbsp;: string </span>
  159. </dt>
  160. <dd>returns the contents of the given build file</dd>
  161. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  162. <a class="" href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFilePath">getBuildFilePath()</a>
  163. <span>
  164. &nbsp;: string </span>
  165. </dt>
  166. <dd>returns the full (real) path to the given build file</dd>
  167. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  168. <a class="" href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildPath">getBuildPath()</a>
  169. <span>
  170. &nbsp;: string </span>
  171. </dt>
  172. <dd>returns the full raw path to the build dir</dd>
  173. </dl>
  174. <section class="phpdocumentor-constants">
  175. <h3 class="phpdocumentor-elements__header" id="constants">
  176. Constants
  177. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  178. </h3>
  179. <article class="phpdocumentor-element -constant -protected ">
  180. <h4 class="phpdocumentor-element__name" id="constant__buildDir">
  181. _buildDir
  182. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#constant__buildDir" class="headerlink"><i class="fas fa-link"></i></a>
  183. </h4>
  184. <aside class="phpdocumentor-element-found-in">
  185. <abbr class="phpdocumentor-element-found-in__file" title="tests/Traits/BuildDirTrait.php"><a href="files/tests-traits-builddirtrait.html"><abbr title="tests/Traits/BuildDirTrait.php">BuildDirTrait.php</abbr></a></abbr>
  186. :
  187. <span class="phpdocumentor-element-found-in__line">22</span>
  188. </aside>
  189. <code class="phpdocumentor-signature phpdocumentor-code ">
  190. <span class="phpdocumentor-signature__visibility">protected</span>
  191. <span class="phpdocumentor-signature__type">mixed</span>
  192. <span class="phpdocumentor-signature__name">_buildDir</span>
  193. = <span class="phpdocumentor-signature__default-value">__DIR__ . &#039;/../../.build/&#039;</span>
  194. </code>
  195. </article>
  196. </section>
  197. <section class="phpdocumentor-methods">
  198. <h3 class="phpdocumentor-elements__header" id="methods">
  199. Methods
  200. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  201. </h3>
  202. <article
  203. class="phpdocumentor-element
  204. -method
  205. -protected
  206. "
  207. >
  208. <h4 class="phpdocumentor-element__name" id="method_createBuildDir">
  209. createBuildDir()
  210. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_createBuildDir" class="headerlink"><i class="fas fa-link"></i></a>
  211. </h4>
  212. <aside class="phpdocumentor-element-found-in">
  213. <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>
  214. :
  215. <span class="phpdocumentor-element-found-in__line">36</span>
  216. </aside>
  217. <p class="phpdocumentor-summary">attempts to create the build dir</p>
  218. <code class="phpdocumentor-code phpdocumentor-signature ">
  219. <span class="phpdocumentor-signature__visibility">protected</span>
  220. <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>
  221. <div class="phpdocumentor-label-line">
  222. </div>
  223. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  224. <dl class="phpdocumentor-argument-list">
  225. <dt class="phpdocumentor-argument-list__entry">
  226. <span class="phpdocumentor-signature__argument__name">$subPath</span>
  227. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  228. </dt>
  229. <dd class="phpdocumentor-argument-list__definition">
  230. </dd>
  231. </dl>
  232. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  233. Tags
  234. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_createBuildDir#tags" class="headerlink"><i class="fas fa-link"></i></a>
  235. </h5>
  236. <dl class="phpdocumentor-tag-list">
  237. <dt class="phpdocumentor-tag-list__entry">
  238. <span class="phpdocumentor-tag__name">throws</span>
  239. </dt>
  240. <dd class="phpdocumentor-tag-list__definition">
  241. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  242. </dd>
  243. </dl>
  244. </article>
  245. <article
  246. class="phpdocumentor-element
  247. -method
  248. -protected
  249. "
  250. >
  251. <h4 class="phpdocumentor-element__name" id="method_getBuildDir">
  252. getBuildDir()
  253. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildDir" class="headerlink"><i class="fas fa-link"></i></a>
  254. </h4>
  255. <aside class="phpdocumentor-element-found-in">
  256. <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>
  257. :
  258. <span class="phpdocumentor-element-found-in__line">54</span>
  259. </aside>
  260. <p class="phpdocumentor-summary">returns the full (real) path to the given build path</p>
  261. <code class="phpdocumentor-code phpdocumentor-signature ">
  262. <span class="phpdocumentor-signature__visibility">protected</span>
  263. <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>
  264. <div class="phpdocumentor-label-line">
  265. </div>
  266. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  267. <dl class="phpdocumentor-argument-list">
  268. <dt class="phpdocumentor-argument-list__entry">
  269. <span class="phpdocumentor-signature__argument__name">$subPath</span>
  270. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  271. = <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
  272. <dd class="phpdocumentor-argument-list__definition">
  273. </dd>
  274. </dl>
  275. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  276. Tags
  277. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildDir#tags" class="headerlink"><i class="fas fa-link"></i></a>
  278. </h5>
  279. <dl class="phpdocumentor-tag-list">
  280. <dt class="phpdocumentor-tag-list__entry">
  281. <span class="phpdocumentor-tag__name">throws</span>
  282. </dt>
  283. <dd class="phpdocumentor-tag-list__definition">
  284. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  285. </dd>
  286. </dl>
  287. <section>
  288. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  289. <span class="phpdocumentor-signature__response_type">string</span>
  290. </section>
  291. </article>
  292. <article
  293. class="phpdocumentor-element
  294. -method
  295. -protected
  296. "
  297. >
  298. <h4 class="phpdocumentor-element__name" id="method_getBuildFileContent">
  299. getBuildFileContent()
  300. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFileContent" class="headerlink"><i class="fas fa-link"></i></a>
  301. </h4>
  302. <aside class="phpdocumentor-element-found-in">
  303. <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>
  304. :
  305. <span class="phpdocumentor-element-found-in__line">88</span>
  306. </aside>
  307. <p class="phpdocumentor-summary">returns the contents of the given build file</p>
  308. <code class="phpdocumentor-code phpdocumentor-signature ">
  309. <span class="phpdocumentor-signature__visibility">protected</span>
  310. <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>
  311. <div class="phpdocumentor-label-line">
  312. </div>
  313. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  314. <dl class="phpdocumentor-argument-list">
  315. <dt class="phpdocumentor-argument-list__entry">
  316. <span class="phpdocumentor-signature__argument__name">$fileSubPath</span>
  317. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  318. </dt>
  319. <dd class="phpdocumentor-argument-list__definition">
  320. </dd>
  321. </dl>
  322. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  323. Tags
  324. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFileContent#tags" class="headerlink"><i class="fas fa-link"></i></a>
  325. </h5>
  326. <dl class="phpdocumentor-tag-list">
  327. <dt class="phpdocumentor-tag-list__entry">
  328. <span class="phpdocumentor-tag__name">throws</span>
  329. </dt>
  330. <dd class="phpdocumentor-tag-list__definition">
  331. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  332. </dd>
  333. </dl>
  334. <section>
  335. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  336. <span class="phpdocumentor-signature__response_type">string</span>
  337. </section>
  338. </article>
  339. <article
  340. class="phpdocumentor-element
  341. -method
  342. -protected
  343. "
  344. >
  345. <h4 class="phpdocumentor-element__name" id="method_getBuildFilePath">
  346. getBuildFilePath()
  347. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFilePath" class="headerlink"><i class="fas fa-link"></i></a>
  348. </h4>
  349. <aside class="phpdocumentor-element-found-in">
  350. <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>
  351. :
  352. <span class="phpdocumentor-element-found-in__line">69</span>
  353. </aside>
  354. <p class="phpdocumentor-summary">returns the full (real) path to the given build file</p>
  355. <code class="phpdocumentor-code phpdocumentor-signature ">
  356. <span class="phpdocumentor-signature__visibility">protected</span>
  357. <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>
  358. <div class="phpdocumentor-label-line">
  359. </div>
  360. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  361. <dl class="phpdocumentor-argument-list">
  362. <dt class="phpdocumentor-argument-list__entry">
  363. <span class="phpdocumentor-signature__argument__name">$fileSubPath</span>
  364. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  365. </dt>
  366. <dd class="phpdocumentor-argument-list__definition">
  367. </dd>
  368. </dl>
  369. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  370. Tags
  371. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFilePath#tags" class="headerlink"><i class="fas fa-link"></i></a>
  372. </h5>
  373. <dl class="phpdocumentor-tag-list">
  374. <dt class="phpdocumentor-tag-list__entry">
  375. <span class="phpdocumentor-tag__name">throws</span>
  376. </dt>
  377. <dd class="phpdocumentor-tag-list__definition">
  378. <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
  379. </dd>
  380. </dl>
  381. <section>
  382. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  383. <span class="phpdocumentor-signature__response_type">string</span>
  384. </section>
  385. </article>
  386. <article
  387. class="phpdocumentor-element
  388. -method
  389. -protected
  390. "
  391. >
  392. <h4 class="phpdocumentor-element__name" id="method_getBuildPath">
  393. getBuildPath()
  394. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildPath" class="headerlink"><i class="fas fa-link"></i></a>
  395. </h4>
  396. <aside class="phpdocumentor-element-found-in">
  397. <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>
  398. :
  399. <span class="phpdocumentor-element-found-in__line">27</span>
  400. </aside>
  401. <p class="phpdocumentor-summary">returns the full raw path to the build dir</p>
  402. <code class="phpdocumentor-code phpdocumentor-signature ">
  403. <span class="phpdocumentor-signature__visibility">protected</span>
  404. <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>
  405. <div class="phpdocumentor-label-line">
  406. </div>
  407. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  408. <dl class="phpdocumentor-argument-list">
  409. <dt class="phpdocumentor-argument-list__entry">
  410. <span class="phpdocumentor-signature__argument__name">$subPath</span>
  411. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  412. </dt>
  413. <dd class="phpdocumentor-argument-list__definition">
  414. </dd>
  415. </dl>
  416. <section>
  417. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  418. <span class="phpdocumentor-signature__response_type">string</span>
  419. </section>
  420. </article>
  421. </section>
  422. <div class="phpdocumentor-modal" id="source-view">
  423. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  424. <div class="phpdocumentor-modal-container">
  425. <div class="phpdocumentor-modal-content">
  426. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/tests/Traits/BuildDirTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  427. </div>
  428. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  429. </div>
  430. </div>
  431. <script type="text/javascript">
  432. (function () {
  433. function loadExternalCodeSnippet(el, url, line) {
  434. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  435. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  436. const language = 'php';
  437. const code = document.createElement('code');
  438. code.className = 'language-' + language;
  439. pre.textContent = '';
  440. pre.setAttribute('data-line', line)
  441. code.textContent = 'Loading…';
  442. pre.appendChild(code);
  443. var xhr = new XMLHttpRequest();
  444. xhr.open('GET', src, true);
  445. xhr.onreadystatechange = function () {
  446. if (xhr.readyState !== 4) {
  447. return;
  448. }
  449. if (xhr.status < 400 && xhr.responseText) {
  450. code.textContent = xhr.responseText;
  451. Prism.highlightElement(code);
  452. d=document.getElementsByClassName("line-numbers");
  453. d[0].scrollTop = d[0].children[1].offsetTop;
  454. return;
  455. }
  456. if (xhr.status === 404) {
  457. code.textContent = '✖ Error: File could not be found';
  458. return;
  459. }
  460. if (xhr.status >= 400) {
  461. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  462. return;
  463. }
  464. code.textContent = '✖ Error: An unknown error occurred';
  465. };
  466. xhr.send(null);
  467. });
  468. }
  469. const modalButtons = document.querySelectorAll("[data-modal]");
  470. const openedAsLocalFile = window.location.protocol === 'file:';
  471. if (modalButtons.length > 0 && openedAsLocalFile) {
  472. console.warn(
  473. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  474. 'browsers block XHR requests when a page is opened this way'
  475. );
  476. }
  477. modalButtons.forEach(function (trigger) {
  478. if (openedAsLocalFile) {
  479. trigger.setAttribute("hidden", "hidden");
  480. }
  481. trigger.addEventListener("click", function (event) {
  482. event.preventDefault();
  483. const modal = document.getElementById(trigger.dataset.modal);
  484. if (!modal) {
  485. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  486. return;
  487. }
  488. modal.classList.add("phpdocumentor-modal__open");
  489. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  490. const exits = modal.querySelectorAll("[data-exit-button]");
  491. exits.forEach(function (exit) {
  492. exit.addEventListener("click", function (event) {
  493. event.preventDefault();
  494. modal.classList.remove("phpdocumentor-modal__open");
  495. });
  496. });
  497. });
  498. });
  499. })();
  500. </script>
  501. </article>
  502. </section>
  503. <section class="phpdocumentor-on-this-page__sidebar">
  504. <section class="phpdocumentor-on-this-page__content">
  505. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  506. <ul class="phpdocumentor-list -clean">
  507. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  508. <li>
  509. <ul class="phpdocumentor-list -clean">
  510. <li><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#toc-constants">Constants</a></li>
  511. <li><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#toc-methods">Methods</a></li>
  512. </ul>
  513. </li>
  514. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  515. <li>
  516. <ul class="phpdocumentor-list -clean">
  517. <li class=""><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#constant__buildDir">_buildDir</a></li>
  518. </ul>
  519. </li>
  520. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  521. <li>
  522. <ul class="phpdocumentor-list -clean">
  523. <li class=""><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_createBuildDir">createBuildDir()</a></li>
  524. <li class=""><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildDir">getBuildDir()</a></li>
  525. <li class=""><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFileContent">getBuildFileContent()</a></li>
  526. <li class=""><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildFilePath">getBuildFilePath()</a></li>
  527. <li class=""><a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#method_getBuildPath">getBuildPath()</a></li>
  528. </ul>
  529. </li>
  530. </ul>
  531. </section>
  532. </section>
  533. </div>
  534. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  535. <section class="phpdocumentor-search-results__dialog">
  536. <header class="phpdocumentor-search-results__header">
  537. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  538. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  539. </header>
  540. <section class="phpdocumentor-search-results__body">
  541. <ul class="phpdocumentor-search-results__entries"></ul>
  542. </section>
  543. </section>
  544. </section>
  545. </div>
  546. <a href="classes/chillerlan-QRCodeTest-Traits-BuildDirTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  547. </main>
  548. <script>
  549. cssVars({});
  550. </script>
  551. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  552. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  553. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  554. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  555. </body>
  556. </html>