chillerlan-QRCodeTest-QROptionsTest.html 43 KB

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