chillerlan-QRCodeTest-QROptionsTest.html 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892
  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. </ul>
  59. </nav>
  60. </header>
  61. <main class="phpdocumentor">
  62. <div class="phpdocumentor-section">
  63. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  64. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  65. Menu
  66. </label>
  67. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  68. <section class="phpdocumentor-sidebar__category">
  69. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  70. <h4 class="phpdocumentor-sidebar__root-namespace">
  71. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  72. </h4>
  73. <ul class="phpdocumentor-list">
  74. <li>
  75. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  76. </li>
  77. <li>
  78. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  79. </li>
  80. </ul>
  81. </section>
  82. <section class="phpdocumentor-sidebar__category">
  83. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  84. <h4 class="phpdocumentor-sidebar__root-namespace">
  85. <a href="packages/Application.html" class="">Application</a>
  86. </h4>
  87. </section>
  88. <section class="phpdocumentor-sidebar__category">
  89. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  92. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  93. </section>
  94. <section class="phpdocumentor-sidebar__category">
  95. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  96. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  97. </section>
  98. </aside>
  99. <div class="phpdocumentor-column -nine phpdocumentor-content">
  100. <section>
  101. <ul class="phpdocumentor-breadcrumbs">
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  103. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a></li>
  104. </ul>
  105. <article class="phpdocumentor-element -class">
  106. <h2 class="phpdocumentor-content__title">
  107. QROptionsTest
  108. <span class="phpdocumentor-element__extends">
  109. extends <abbr title="\PHPUnit\Framework\TestCase">TestCase</abbr>
  110. </span>
  111. <div class="phpdocumentor-element__package">
  112. in package
  113. <ul class="phpdocumentor-breadcrumbs">
  114. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  115. </ul>
  116. </div>
  117. </h2>
  118. <div class="phpdocumentor-label-line">
  119. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Final</span><span>Yes</span></div>
  120. </div>
  121. <aside class="phpdocumentor-element-found-in">
  122. <abbr class="phpdocumentor-element-found-in__file" title="tests/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
  123. :
  124. <span class="phpdocumentor-element-found-in__line">22</span>
  125. </aside>
  126. <p class="phpdocumentor-summary">QROptions test</p>
  127. <h3 id="toc">
  128. Table of Contents
  129. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  130. </h3>
  131. <h4 id="toc-methods">
  132. Methods
  133. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  134. </h4>
  135. <dl class="phpdocumentor-table-of-contents">
  136. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  137. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_circleRadiusProvider">circleRadiusProvider()</a>
  138. <span>
  139. &nbsp;: array&lt;string|int, array&lt;string|int, float&gt;&gt; </span>
  140. </dt>
  141. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  142. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_logoSpaceValueProvider">logoSpaceValueProvider()</a>
  143. <span>
  144. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt; </span>
  145. </dt>
  146. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  147. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_RGBProvider">RGBProvider()</a>
  148. <span>
  149. &nbsp;: array&lt;string|int, array&lt;string|int, array&lt;string|int, int&gt;&gt;&gt; </span>
  150. </dt>
  151. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  152. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testClampCircleRadius">testClampCircleRadius()</a>
  153. <span>
  154. &nbsp;: void </span>
  155. </dt>
  156. <dd>Tests clamping of the circle radius</dd>
  157. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  158. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testClampLogoSpaceValue">testClampLogoSpaceValue()</a>
  159. <span>
  160. &nbsp;: void </span>
  161. </dt>
  162. <dd>Tests the clamping (between 0 and 177) of the logo space values</dd>
  163. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  164. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testLogoSpaceStartNullable">testLogoSpaceStartNullable()</a>
  165. <span>
  166. &nbsp;: void </span>
  167. </dt>
  168. <dd>Tests if the optional logo space start values are nullable</dd>
  169. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  170. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testVersionClamp">testVersionClamp()</a>
  171. <span>
  172. &nbsp;: void </span>
  173. </dt>
  174. <dd>Tests the $version clamping</dd>
  175. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  176. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testVersionMinMaxClamp">testVersionMinMaxClamp()</a>
  177. <span>
  178. &nbsp;: void </span>
  179. </dt>
  180. <dd>Tests the $versionMin/$versionMax clamping</dd>
  181. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  182. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_VersionMinMaxProvider">VersionMinMaxProvider()</a>
  183. <span>
  184. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt; </span>
  185. </dt>
  186. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  187. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_VersionProvider">VersionProvider()</a>
  188. <span>
  189. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt; </span>
  190. </dt>
  191. </dl>
  192. <section class="phpdocumentor-methods">
  193. <h3 class="phpdocumentor-elements__header" id="methods">
  194. Methods
  195. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  196. </h3>
  197. <article
  198. class="phpdocumentor-element
  199. -method
  200. -public
  201. -static "
  202. >
  203. <h4 class="phpdocumentor-element__name" id="method_circleRadiusProvider">
  204. circleRadiusProvider()
  205. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_circleRadiusProvider" class="headerlink"><i class="fas fa-link"></i></a>
  206. </h4>
  207. <aside class="phpdocumentor-element-found-in">
  208. <abbr class="phpdocumentor-element-found-in__file" title="tests/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
  209. :
  210. <span class="phpdocumentor-element-found-in__line">132</span>
  211. </aside>
  212. <code class="phpdocumentor-code phpdocumentor-signature ">
  213. <span class="phpdocumentor-signature__visibility">public</span>
  214. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">circleRadiusProvider</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, float&gt;&gt;</span></code>
  215. <div class="phpdocumentor-label-line">
  216. </div>
  217. <section>
  218. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  219. <span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, float&gt;&gt;</span>
  220. </section>
  221. </article>
  222. <article
  223. class="phpdocumentor-element
  224. -method
  225. -public
  226. -static "
  227. >
  228. <h4 class="phpdocumentor-element__name" id="method_logoSpaceValueProvider">
  229. logoSpaceValueProvider()
  230. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_logoSpaceValueProvider" class="headerlink"><i class="fas fa-link"></i></a>
  231. </h4>
  232. <aside class="phpdocumentor-element-found-in">
  233. <abbr class="phpdocumentor-element-found-in__file" title="tests/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
  234. :
  235. <span class="phpdocumentor-element-found-in__line">85</span>
  236. </aside>
  237. <code class="phpdocumentor-code phpdocumentor-signature ">
  238. <span class="phpdocumentor-signature__visibility">public</span>
  239. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">logoSpaceValueProvider</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;</span></code>
  240. <div class="phpdocumentor-label-line">
  241. </div>
  242. <section>
  243. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  244. <span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;</span>
  245. </section>
  246. </article>
  247. <article
  248. class="phpdocumentor-element
  249. -method
  250. -public
  251. -static "
  252. >
  253. <h4 class="phpdocumentor-element__name" id="method_RGBProvider">
  254. RGBProvider()
  255. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_RGBProvider" 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/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
  259. :
  260. <span class="phpdocumentor-element-found-in__line">74</span>
  261. </aside>
  262. <code class="phpdocumentor-code phpdocumentor-signature ">
  263. <span class="phpdocumentor-signature__visibility">public</span>
  264. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">RGBProvider</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, array&lt;string|int, int&gt;&gt;&gt;</span></code>
  265. <div class="phpdocumentor-label-line">
  266. </div>
  267. <section>
  268. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  269. <span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, array&lt;string|int, int&gt;&gt;&gt;</span>
  270. </section>
  271. </article>
  272. <article
  273. class="phpdocumentor-element
  274. -method
  275. -public
  276. "
  277. >
  278. <h4 class="phpdocumentor-element__name" id="method_testClampCircleRadius">
  279. testClampCircleRadius()
  280. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testClampCircleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  281. </h4>
  282. <aside class="phpdocumentor-element-found-in">
  283. <abbr class="phpdocumentor-element-found-in__file" title="tests/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
  284. :
  285. <span class="phpdocumentor-element-found-in__line">145</span>
  286. </aside>
  287. <p class="phpdocumentor-summary">Tests clamping of the circle radius</p>
  288. <code class="phpdocumentor-code phpdocumentor-signature ">
  289. <span class="phpdocumentor-signature__visibility">public</span>
  290. <span class="phpdocumentor-signature__name">testClampCircleRadius</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">float&nbsp;</span><span class="phpdocumentor-signature__argument__name">$expected</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  291. <div class="phpdocumentor-label-line">
  292. </div>
  293. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  294. <dl class="phpdocumentor-argument-list">
  295. <dt class="phpdocumentor-argument-list__entry">
  296. <span class="phpdocumentor-signature__argument__name">$value</span>
  297. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  298. </dt>
  299. <dd class="phpdocumentor-argument-list__definition">
  300. </dd>
  301. <dt class="phpdocumentor-argument-list__entry">
  302. <span class="phpdocumentor-signature__argument__name">$expected</span>
  303. : <span class="phpdocumentor-signature__argument__return-type">float</span>
  304. </dt>
  305. <dd class="phpdocumentor-argument-list__definition">
  306. </dd>
  307. </dl>
  308. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  309. Tags
  310. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testClampCircleRadius#tags" class="headerlink"><i class="fas fa-link"></i></a>
  311. </h5>
  312. <dl class="phpdocumentor-tag-list">
  313. <dt class="phpdocumentor-tag-list__entry">
  314. <span class="phpdocumentor-tag__name">dataProvider</span>
  315. </dt>
  316. <dd class="phpdocumentor-tag-list__definition">
  317. <section class="phpdocumentor-description"><p>circleRadiusProvider</p>
  318. </section>
  319. </dd>
  320. </dl>
  321. </article>
  322. <article
  323. class="phpdocumentor-element
  324. -method
  325. -public
  326. "
  327. >
  328. <h4 class="phpdocumentor-element__name" id="method_testClampLogoSpaceValue">
  329. testClampLogoSpaceValue()
  330. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testClampLogoSpaceValue" class="headerlink"><i class="fas fa-link"></i></a>
  331. </h4>
  332. <aside class="phpdocumentor-element-found-in">
  333. <abbr class="phpdocumentor-element-found-in__file" title="tests/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
  334. :
  335. <span class="phpdocumentor-element-found-in__line">100</span>
  336. </aside>
  337. <p class="phpdocumentor-summary">Tests the clamping (between 0 and 177) of the logo space values</p>
  338. <code class="phpdocumentor-code phpdocumentor-signature ">
  339. <span class="phpdocumentor-signature__visibility">public</span>
  340. <span class="phpdocumentor-signature__name">testClampLogoSpaceValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$expected</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  341. <div class="phpdocumentor-label-line">
  342. </div>
  343. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  344. <dl class="phpdocumentor-argument-list">
  345. <dt class="phpdocumentor-argument-list__entry">
  346. <span class="phpdocumentor-signature__argument__name">$value</span>
  347. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  348. </dt>
  349. <dd class="phpdocumentor-argument-list__definition">
  350. </dd>
  351. <dt class="phpdocumentor-argument-list__entry">
  352. <span class="phpdocumentor-signature__argument__name">$expected</span>
  353. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  354. </dt>
  355. <dd class="phpdocumentor-argument-list__definition">
  356. </dd>
  357. </dl>
  358. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  359. Tags
  360. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testClampLogoSpaceValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  361. </h5>
  362. <dl class="phpdocumentor-tag-list">
  363. <dt class="phpdocumentor-tag-list__entry">
  364. <span class="phpdocumentor-tag__name">dataProvider</span>
  365. </dt>
  366. <dd class="phpdocumentor-tag-list__definition">
  367. <section class="phpdocumentor-description"><p>logoSpaceValueProvider</p>
  368. </section>
  369. </dd>
  370. </dl>
  371. </article>
  372. <article
  373. class="phpdocumentor-element
  374. -method
  375. -public
  376. "
  377. >
  378. <h4 class="phpdocumentor-element__name" id="method_testLogoSpaceStartNullable">
  379. testLogoSpaceStartNullable()
  380. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testLogoSpaceStartNullable" class="headerlink"><i class="fas fa-link"></i></a>
  381. </h4>
  382. <aside class="phpdocumentor-element-found-in">
  383. <abbr class="phpdocumentor-element-found-in__file" title="tests/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
  384. :
  385. <span class="phpdocumentor-element-found-in__line">113</span>
  386. </aside>
  387. <p class="phpdocumentor-summary">Tests if the optional logo space start values are nullable</p>
  388. <code class="phpdocumentor-code phpdocumentor-signature ">
  389. <span class="phpdocumentor-signature__visibility">public</span>
  390. <span class="phpdocumentor-signature__name">testLogoSpaceStartNullable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  391. <div class="phpdocumentor-label-line">
  392. </div>
  393. </article>
  394. <article
  395. class="phpdocumentor-element
  396. -method
  397. -public
  398. "
  399. >
  400. <h4 class="phpdocumentor-element__name" id="method_testVersionClamp">
  401. testVersionClamp()
  402. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testVersionClamp" class="headerlink"><i class="fas fa-link"></i></a>
  403. </h4>
  404. <aside class="phpdocumentor-element-found-in">
  405. <abbr class="phpdocumentor-element-found-in__file" title="tests/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
  406. :
  407. <span class="phpdocumentor-element-found-in__line">41</span>
  408. </aside>
  409. <p class="phpdocumentor-summary">Tests the $version clamping</p>
  410. <code class="phpdocumentor-code phpdocumentor-signature ">
  411. <span class="phpdocumentor-signature__visibility">public</span>
  412. <span class="phpdocumentor-signature__name">testVersionClamp</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$version</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$expected</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  413. <div class="phpdocumentor-label-line">
  414. </div>
  415. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  416. <dl class="phpdocumentor-argument-list">
  417. <dt class="phpdocumentor-argument-list__entry">
  418. <span class="phpdocumentor-signature__argument__name">$version</span>
  419. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  420. </dt>
  421. <dd class="phpdocumentor-argument-list__definition">
  422. </dd>
  423. <dt class="phpdocumentor-argument-list__entry">
  424. <span class="phpdocumentor-signature__argument__name">$expected</span>
  425. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  426. </dt>
  427. <dd class="phpdocumentor-argument-list__definition">
  428. </dd>
  429. </dl>
  430. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  431. Tags
  432. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testVersionClamp#tags" class="headerlink"><i class="fas fa-link"></i></a>
  433. </h5>
  434. <dl class="phpdocumentor-tag-list">
  435. <dt class="phpdocumentor-tag-list__entry">
  436. <span class="phpdocumentor-tag__name">dataProvider</span>
  437. </dt>
  438. <dd class="phpdocumentor-tag-list__definition">
  439. <section class="phpdocumentor-description"><p>VersionProvider</p>
  440. </section>
  441. </dd>
  442. </dl>
  443. </article>
  444. <article
  445. class="phpdocumentor-element
  446. -method
  447. -public
  448. "
  449. >
  450. <h4 class="phpdocumentor-element__name" id="method_testVersionMinMaxClamp">
  451. testVersionMinMaxClamp()
  452. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testVersionMinMaxClamp" class="headerlink"><i class="fas fa-link"></i></a>
  453. </h4>
  454. <aside class="phpdocumentor-element-found-in">
  455. <abbr class="phpdocumentor-element-found-in__file" title="tests/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
  456. :
  457. <span class="phpdocumentor-element-found-in__line">64</span>
  458. </aside>
  459. <p class="phpdocumentor-summary">Tests the $versionMin/$versionMax clamping</p>
  460. <code class="phpdocumentor-code phpdocumentor-signature ">
  461. <span class="phpdocumentor-signature__visibility">public</span>
  462. <span class="phpdocumentor-signature__name">testVersionMinMaxClamp</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$versionMin</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$versionMax</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$expectedMin</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$expectedMax</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  463. <div class="phpdocumentor-label-line">
  464. </div>
  465. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  466. <dl class="phpdocumentor-argument-list">
  467. <dt class="phpdocumentor-argument-list__entry">
  468. <span class="phpdocumentor-signature__argument__name">$versionMin</span>
  469. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  470. </dt>
  471. <dd class="phpdocumentor-argument-list__definition">
  472. </dd>
  473. <dt class="phpdocumentor-argument-list__entry">
  474. <span class="phpdocumentor-signature__argument__name">$versionMax</span>
  475. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  476. </dt>
  477. <dd class="phpdocumentor-argument-list__definition">
  478. </dd>
  479. <dt class="phpdocumentor-argument-list__entry">
  480. <span class="phpdocumentor-signature__argument__name">$expectedMin</span>
  481. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  482. </dt>
  483. <dd class="phpdocumentor-argument-list__definition">
  484. </dd>
  485. <dt class="phpdocumentor-argument-list__entry">
  486. <span class="phpdocumentor-signature__argument__name">$expectedMax</span>
  487. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  488. </dt>
  489. <dd class="phpdocumentor-argument-list__definition">
  490. </dd>
  491. </dl>
  492. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  493. Tags
  494. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testVersionMinMaxClamp#tags" class="headerlink"><i class="fas fa-link"></i></a>
  495. </h5>
  496. <dl class="phpdocumentor-tag-list">
  497. <dt class="phpdocumentor-tag-list__entry">
  498. <span class="phpdocumentor-tag__name">dataProvider</span>
  499. </dt>
  500. <dd class="phpdocumentor-tag-list__definition">
  501. <section class="phpdocumentor-description"><p>VersionMinMaxProvider</p>
  502. </section>
  503. </dd>
  504. </dl>
  505. </article>
  506. <article
  507. class="phpdocumentor-element
  508. -method
  509. -public
  510. -static "
  511. >
  512. <h4 class="phpdocumentor-element__name" id="method_VersionMinMaxProvider">
  513. VersionMinMaxProvider()
  514. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_VersionMinMaxProvider" class="headerlink"><i class="fas fa-link"></i></a>
  515. </h4>
  516. <aside class="phpdocumentor-element-found-in">
  517. <abbr class="phpdocumentor-element-found-in__file" title="tests/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
  518. :
  519. <span class="phpdocumentor-element-found-in__line">50</span>
  520. </aside>
  521. <code class="phpdocumentor-code phpdocumentor-signature ">
  522. <span class="phpdocumentor-signature__visibility">public</span>
  523. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">VersionMinMaxProvider</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;</span></code>
  524. <div class="phpdocumentor-label-line">
  525. </div>
  526. <section>
  527. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  528. <span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;</span>
  529. </section>
  530. </article>
  531. <article
  532. class="phpdocumentor-element
  533. -method
  534. -public
  535. -static "
  536. >
  537. <h4 class="phpdocumentor-element__name" id="method_VersionProvider">
  538. VersionProvider()
  539. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_VersionProvider" class="headerlink"><i class="fas fa-link"></i></a>
  540. </h4>
  541. <aside class="phpdocumentor-element-found-in">
  542. <abbr class="phpdocumentor-element-found-in__file" title="tests/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
  543. :
  544. <span class="phpdocumentor-element-found-in__line">27</span>
  545. </aside>
  546. <code class="phpdocumentor-code phpdocumentor-signature ">
  547. <span class="phpdocumentor-signature__visibility">public</span>
  548. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">VersionProvider</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;</span></code>
  549. <div class="phpdocumentor-label-line">
  550. </div>
  551. <section>
  552. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  553. <span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;</span>
  554. </section>
  555. </article>
  556. </section>
  557. <div class="phpdocumentor-modal" id="source-view">
  558. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  559. <div class="phpdocumentor-modal-container">
  560. <div class="phpdocumentor-modal-content">
  561. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/tests/QROptionsTest.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  562. </div>
  563. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  564. </div>
  565. </div>
  566. <script type="text/javascript">
  567. (function () {
  568. function loadExternalCodeSnippet(el, url, line) {
  569. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  570. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  571. const language = 'php';
  572. const code = document.createElement('code');
  573. code.className = 'language-' + language;
  574. pre.textContent = '';
  575. pre.setAttribute('data-line', line)
  576. code.textContent = 'Loading…';
  577. pre.appendChild(code);
  578. var xhr = new XMLHttpRequest();
  579. xhr.open('GET', src, true);
  580. xhr.onreadystatechange = function () {
  581. if (xhr.readyState !== 4) {
  582. return;
  583. }
  584. if (xhr.status < 400 && xhr.responseText) {
  585. code.textContent = xhr.responseText;
  586. Prism.highlightElement(code);
  587. return;
  588. }
  589. if (xhr.status === 404) {
  590. code.textContent = '✖ Error: File could not be found';
  591. return;
  592. }
  593. if (xhr.status >= 400) {
  594. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  595. return;
  596. }
  597. code.textContent = '✖ Error: An unknown error occurred';
  598. };
  599. xhr.send(null);
  600. });
  601. }
  602. const modalButtons = document.querySelectorAll("[data-modal]");
  603. const openedAsLocalFile = window.location.protocol === 'file:';
  604. if (modalButtons.length > 0 && openedAsLocalFile) {
  605. console.warn(
  606. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  607. 'browsers block XHR requests when a page is opened this way'
  608. );
  609. }
  610. modalButtons.forEach(function (trigger) {
  611. if (openedAsLocalFile) {
  612. trigger.setAttribute("hidden", "hidden");
  613. }
  614. trigger.addEventListener("click", function (event) {
  615. event.preventDefault();
  616. const modal = document.getElementById(trigger.dataset.modal);
  617. if (!modal) {
  618. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  619. return;
  620. }
  621. modal.classList.add("phpdocumentor-modal__open");
  622. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  623. const exits = modal.querySelectorAll("[data-exit-button]");
  624. exits.forEach(function (exit) {
  625. exit.addEventListener("click", function (event) {
  626. event.preventDefault();
  627. modal.classList.remove("phpdocumentor-modal__open");
  628. });
  629. });
  630. });
  631. });
  632. })();
  633. </script>
  634. </article>
  635. </section>
  636. <section class="phpdocumentor-on-this-page__sidebar">
  637. <section class="phpdocumentor-on-this-page__content">
  638. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  639. <ul class="phpdocumentor-list -clean">
  640. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  641. <li>
  642. <ul class="phpdocumentor-list -clean">
  643. <li><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#toc-methods">Methods</a></li>
  644. </ul>
  645. </li>
  646. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  647. <li>
  648. <ul class="phpdocumentor-list -clean">
  649. <li><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_circleRadiusProvider">circleRadiusProvider()</a></li>
  650. <li><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_logoSpaceValueProvider">logoSpaceValueProvider()</a></li>
  651. <li><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_RGBProvider">RGBProvider()</a></li>
  652. <li><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testClampCircleRadius">testClampCircleRadius()</a></li>
  653. <li><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testClampLogoSpaceValue">testClampLogoSpaceValue()</a></li>
  654. <li><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testLogoSpaceStartNullable">testLogoSpaceStartNullable()</a></li>
  655. <li><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testVersionClamp">testVersionClamp()</a></li>
  656. <li><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testVersionMinMaxClamp">testVersionMinMaxClamp()</a></li>
  657. <li><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_VersionMinMaxProvider">VersionMinMaxProvider()</a></li>
  658. <li><a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_VersionProvider">VersionProvider()</a></li>
  659. </ul>
  660. </li>
  661. </ul>
  662. </section>
  663. </section>
  664. </div>
  665. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  666. <section class="phpdocumentor-search-results__dialog">
  667. <header class="phpdocumentor-search-results__header">
  668. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  669. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  670. </header>
  671. <section class="phpdocumentor-search-results__body">
  672. <ul class="phpdocumentor-search-results__entries"></ul>
  673. </section>
  674. </section>
  675. </section>
  676. </div>
  677. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  678. </main>
  679. <script>
  680. cssVars({});
  681. </script>
  682. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  683. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  684. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  685. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  686. </body>
  687. </html>