chillerlan-QRCodeTest-BuildDirTrait.html 33 KB

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