chillerlan-QRCodeTest-BuildDirTrait.html 32 KB

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