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