chillerlan-QRCodeTest-QROptionsTest.html 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945
  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">21</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_logoSpaceValueProvider">logoSpaceValueProvider()</a>
  115. <span>
  116. &nbsp;: array&lt;string|int, array&lt;string|int, int&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_MaskPatternProvider">MaskPatternProvider()</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_testClampLogoSpaceValue">testClampLogoSpaceValue()</a>
  133. <span>
  134. &nbsp;: void </span>
  135. </dt>
  136. <dd>Tests the clamping (between 0 and 177) of the logo space values</dd>
  137. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  138. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testClampRGBValues">testClampRGBValues()</a>
  139. <span>
  140. &nbsp;: void </span>
  141. </dt>
  142. <dd>Tests clamping of the RGB values for $imageTransparencyBG</dd>
  143. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  144. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testInvalidEccLevelException">testInvalidEccLevelException()</a>
  145. <span>
  146. &nbsp;: void </span>
  147. </dt>
  148. <dd>Tests if an exception is thrown on an incorrect ECC level</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_testMaskPatternClamp">testMaskPatternClamp()</a>
  163. <span>
  164. &nbsp;: void </span>
  165. </dt>
  166. <dd>Tests the $maskPattern clamping</dd>
  167. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  168. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testVersionClamp">testVersionClamp()</a>
  169. <span>
  170. &nbsp;: void </span>
  171. </dt>
  172. <dd>Tests the $version clamping</dd>
  173. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  174. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testVersionMinMaxClamp">testVersionMinMaxClamp()</a>
  175. <span>
  176. &nbsp;: void </span>
  177. </dt>
  178. <dd>Tests the $versionMin/$versionMax clamping</dd>
  179. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  180. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_VersionMinMaxProvider">VersionMinMaxProvider()</a>
  181. <span>
  182. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt; </span>
  183. </dt>
  184. <dd></dd>
  185. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  186. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_VersionProvider">VersionProvider()</a>
  187. <span>
  188. &nbsp;: array&lt;string|int, array&lt;string|int, int&gt;&gt; </span>
  189. </dt>
  190. <dd></dd>
  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. "
  202. >
  203. <h4 class="phpdocumentor-element__name" id="method_logoSpaceValueProvider">
  204. logoSpaceValueProvider()
  205. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_logoSpaceValueProvider" 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">137</span>
  211. </aside>
  212. <code class="phpdocumentor-code phpdocumentor-signature ">
  213. <span class="phpdocumentor-signature__visibility">public</span>
  214. <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>
  215. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  216. <span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;</span>
  217. &mdash;
  218. </article>
  219. <article
  220. class="phpdocumentor-element
  221. -method
  222. -public
  223. "
  224. >
  225. <h4 class="phpdocumentor-element__name" id="method_MaskPatternProvider">
  226. MaskPatternProvider()
  227. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_MaskPatternProvider" class="headerlink"><i class="fas fa-link"></i></a>
  228. </h4>
  229. <aside class="phpdocumentor-element-found-in">
  230. <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>
  231. :
  232. <span class="phpdocumentor-element-found-in__line">73</span>
  233. </aside>
  234. <code class="phpdocumentor-code phpdocumentor-signature ">
  235. <span class="phpdocumentor-signature__visibility">public</span>
  236. <span class="phpdocumentor-signature__name">MaskPatternProvider</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>
  237. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  238. <span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;</span>
  239. &mdash;
  240. </article>
  241. <article
  242. class="phpdocumentor-element
  243. -method
  244. -public
  245. "
  246. >
  247. <h4 class="phpdocumentor-element__name" id="method_RGBProvider">
  248. RGBProvider()
  249. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_RGBProvider" class="headerlink"><i class="fas fa-link"></i></a>
  250. </h4>
  251. <aside class="phpdocumentor-element-found-in">
  252. <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>
  253. :
  254. <span class="phpdocumentor-element-found-in__line">105</span>
  255. </aside>
  256. <code class="phpdocumentor-code phpdocumentor-signature ">
  257. <span class="phpdocumentor-signature__visibility">public</span>
  258. <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>
  259. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  260. <span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, array&lt;string|int, int&gt;&gt;&gt;</span>
  261. &mdash;
  262. </article>
  263. <article
  264. class="phpdocumentor-element
  265. -method
  266. -public
  267. "
  268. >
  269. <h4 class="phpdocumentor-element__name" id="method_testClampLogoSpaceValue">
  270. testClampLogoSpaceValue()
  271. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testClampLogoSpaceValue" class="headerlink"><i class="fas fa-link"></i></a>
  272. </h4>
  273. <aside class="phpdocumentor-element-found-in">
  274. <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>
  275. :
  276. <span class="phpdocumentor-element-found-in__line">152</span>
  277. </aside>
  278. <p class="phpdocumentor-summary">Tests the clamping (between 0 and 177) of the logo space values</p>
  279. <code class="phpdocumentor-code phpdocumentor-signature ">
  280. <span class="phpdocumentor-signature__visibility">public</span>
  281. <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>
  282. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  283. <dl class="phpdocumentor-argument-list">
  284. <dt class="phpdocumentor-argument-list__entry">
  285. <span class="phpdocumentor-signature__argument__name">$value</span>
  286. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  287. </dt>
  288. <dd class="phpdocumentor-argument-list__definition">
  289. <section class="phpdocumentor-description"></section>
  290. </dd>
  291. <dt class="phpdocumentor-argument-list__entry">
  292. <span class="phpdocumentor-signature__argument__name">$expected</span>
  293. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  294. </dt>
  295. <dd class="phpdocumentor-argument-list__definition">
  296. <section class="phpdocumentor-description"></section>
  297. </dd>
  298. </dl>
  299. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  300. Tags
  301. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  302. </h5>
  303. <dl class="phpdocumentor-tag-list">
  304. <dt class="phpdocumentor-tag-list__entry">
  305. <span class="phpdocumentor-tag__name">dataProvider</span>
  306. </dt>
  307. <dd class="phpdocumentor-tag-list__definition">
  308. <section class="phpdocumentor-description"><p>logoSpaceValueProvider</p>
  309. </section>
  310. </dd>
  311. </dl>
  312. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  313. <span class="phpdocumentor-signature__response_type">void</span>
  314. &mdash;
  315. </article>
  316. <article
  317. class="phpdocumentor-element
  318. -method
  319. -public
  320. "
  321. >
  322. <h4 class="phpdocumentor-element__name" id="method_testClampRGBValues">
  323. testClampRGBValues()
  324. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testClampRGBValues" class="headerlink"><i class="fas fa-link"></i></a>
  325. </h4>
  326. <aside class="phpdocumentor-element-found-in">
  327. <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>
  328. :
  329. <span class="phpdocumentor-element-found-in__line">118</span>
  330. </aside>
  331. <p class="phpdocumentor-summary">Tests clamping of the RGB values for $imageTransparencyBG</p>
  332. <code class="phpdocumentor-code phpdocumentor-signature ">
  333. <span class="phpdocumentor-signature__visibility">public</span>
  334. <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>
  335. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  336. <dl class="phpdocumentor-argument-list">
  337. <dt class="phpdocumentor-argument-list__entry">
  338. <span class="phpdocumentor-signature__argument__name">$rgb</span>
  339. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  340. </dt>
  341. <dd class="phpdocumentor-argument-list__definition">
  342. <section class="phpdocumentor-description"></section>
  343. </dd>
  344. <dt class="phpdocumentor-argument-list__entry">
  345. <span class="phpdocumentor-signature__argument__name">$expected</span>
  346. : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
  347. </dt>
  348. <dd class="phpdocumentor-argument-list__definition">
  349. <section class="phpdocumentor-description"></section>
  350. </dd>
  351. </dl>
  352. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  353. Tags
  354. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  355. </h5>
  356. <dl class="phpdocumentor-tag-list">
  357. <dt class="phpdocumentor-tag-list__entry">
  358. <span class="phpdocumentor-tag__name">dataProvider</span>
  359. </dt>
  360. <dd class="phpdocumentor-tag-list__definition">
  361. <section class="phpdocumentor-description"><p>RGBProvider</p>
  362. </section>
  363. </dd>
  364. </dl>
  365. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  366. <span class="phpdocumentor-signature__response_type">void</span>
  367. &mdash;
  368. </article>
  369. <article
  370. class="phpdocumentor-element
  371. -method
  372. -public
  373. "
  374. >
  375. <h4 class="phpdocumentor-element__name" id="method_testInvalidEccLevelException">
  376. testInvalidEccLevelException()
  377. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testInvalidEccLevelException" class="headerlink"><i class="fas fa-link"></i></a>
  378. </h4>
  379. <aside class="phpdocumentor-element-found-in">
  380. <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>
  381. :
  382. <span class="phpdocumentor-element-found-in__line">95</span>
  383. </aside>
  384. <p class="phpdocumentor-summary">Tests if an exception is thrown on an incorrect ECC level</p>
  385. <code class="phpdocumentor-code phpdocumentor-signature ">
  386. <span class="phpdocumentor-signature__visibility">public</span>
  387. <span class="phpdocumentor-signature__name">testInvalidEccLevelException</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  388. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  389. <span class="phpdocumentor-signature__response_type">void</span>
  390. &mdash;
  391. </article>
  392. <article
  393. class="phpdocumentor-element
  394. -method
  395. -public
  396. "
  397. >
  398. <h4 class="phpdocumentor-element__name" id="method_testInvalidRGBValueException">
  399. testInvalidRGBValueException()
  400. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testInvalidRGBValueException" class="headerlink"><i class="fas fa-link"></i></a>
  401. </h4>
  402. <aside class="phpdocumentor-element-found-in">
  403. <abbr class="phpdocumentor-element-found-in__file" title="tests/QROptionsTest.php"><a href="files/tests-qroptionstest.html"><abbr title="tests/QROptionsTest.php">QROptionsTest.php</abbr></a></abbr>
  404. :
  405. <span class="phpdocumentor-element-found-in__line">127</span>
  406. </aside>
  407. <p class="phpdocumentor-summary">Tests if an exception is thrown when a non-numeric RGB value was encoutered</p>
  408. <code class="phpdocumentor-code phpdocumentor-signature ">
  409. <span class="phpdocumentor-signature__visibility">public</span>
  410. <span class="phpdocumentor-signature__name">testInvalidRGBValueException</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  411. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  412. <span class="phpdocumentor-signature__response_type">void</span>
  413. &mdash;
  414. </article>
  415. <article
  416. class="phpdocumentor-element
  417. -method
  418. -public
  419. "
  420. >
  421. <h4 class="phpdocumentor-element__name" id="method_testLogoSpaceStartNullable">
  422. testLogoSpaceStartNullable()
  423. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testLogoSpaceStartNullable" class="headerlink"><i class="fas fa-link"></i></a>
  424. </h4>
  425. <aside class="phpdocumentor-element-found-in">
  426. <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>
  427. :
  428. <span class="phpdocumentor-element-found-in__line">165</span>
  429. </aside>
  430. <p class="phpdocumentor-summary">Tests if the optional logo space start values are nullable</p>
  431. <code class="phpdocumentor-code phpdocumentor-signature ">
  432. <span class="phpdocumentor-signature__visibility">public</span>
  433. <span class="phpdocumentor-signature__name">testLogoSpaceStartNullable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  434. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  435. <span class="phpdocumentor-signature__response_type">void</span>
  436. &mdash;
  437. </article>
  438. <article
  439. class="phpdocumentor-element
  440. -method
  441. -public
  442. "
  443. >
  444. <h4 class="phpdocumentor-element__name" id="method_testMaskPatternClamp">
  445. testMaskPatternClamp()
  446. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testMaskPatternClamp" class="headerlink"><i class="fas fa-link"></i></a>
  447. </h4>
  448. <aside class="phpdocumentor-element-found-in">
  449. <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>
  450. :
  451. <span class="phpdocumentor-element-found-in__line">86</span>
  452. </aside>
  453. <p class="phpdocumentor-summary">Tests the $maskPattern clamping</p>
  454. <code class="phpdocumentor-code phpdocumentor-signature ">
  455. <span class="phpdocumentor-signature__visibility">public</span>
  456. <span class="phpdocumentor-signature__name">testMaskPatternClamp</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$maskPattern</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>
  457. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  458. <dl class="phpdocumentor-argument-list">
  459. <dt class="phpdocumentor-argument-list__entry">
  460. <span class="phpdocumentor-signature__argument__name">$maskPattern</span>
  461. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  462. </dt>
  463. <dd class="phpdocumentor-argument-list__definition">
  464. <section class="phpdocumentor-description"></section>
  465. </dd>
  466. <dt class="phpdocumentor-argument-list__entry">
  467. <span class="phpdocumentor-signature__argument__name">$expected</span>
  468. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  469. </dt>
  470. <dd class="phpdocumentor-argument-list__definition">
  471. <section class="phpdocumentor-description"></section>
  472. </dd>
  473. </dl>
  474. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  475. Tags
  476. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  477. </h5>
  478. <dl class="phpdocumentor-tag-list">
  479. <dt class="phpdocumentor-tag-list__entry">
  480. <span class="phpdocumentor-tag__name">dataProvider</span>
  481. </dt>
  482. <dd class="phpdocumentor-tag-list__definition">
  483. <section class="phpdocumentor-description"><p>MaskPatternProvider</p>
  484. </section>
  485. </dd>
  486. </dl>
  487. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  488. <span class="phpdocumentor-signature__response_type">void</span>
  489. &mdash;
  490. </article>
  491. <article
  492. class="phpdocumentor-element
  493. -method
  494. -public
  495. "
  496. >
  497. <h4 class="phpdocumentor-element__name" id="method_testVersionClamp">
  498. testVersionClamp()
  499. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testVersionClamp" class="headerlink"><i class="fas fa-link"></i></a>
  500. </h4>
  501. <aside class="phpdocumentor-element-found-in">
  502. <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>
  503. :
  504. <span class="phpdocumentor-element-found-in__line">40</span>
  505. </aside>
  506. <p class="phpdocumentor-summary">Tests the $version clamping</p>
  507. <code class="phpdocumentor-code phpdocumentor-signature ">
  508. <span class="phpdocumentor-signature__visibility">public</span>
  509. <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>
  510. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  511. <dl class="phpdocumentor-argument-list">
  512. <dt class="phpdocumentor-argument-list__entry">
  513. <span class="phpdocumentor-signature__argument__name">$version</span>
  514. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  515. </dt>
  516. <dd class="phpdocumentor-argument-list__definition">
  517. <section class="phpdocumentor-description"></section>
  518. </dd>
  519. <dt class="phpdocumentor-argument-list__entry">
  520. <span class="phpdocumentor-signature__argument__name">$expected</span>
  521. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  522. </dt>
  523. <dd class="phpdocumentor-argument-list__definition">
  524. <section class="phpdocumentor-description"></section>
  525. </dd>
  526. </dl>
  527. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  528. Tags
  529. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  530. </h5>
  531. <dl class="phpdocumentor-tag-list">
  532. <dt class="phpdocumentor-tag-list__entry">
  533. <span class="phpdocumentor-tag__name">dataProvider</span>
  534. </dt>
  535. <dd class="phpdocumentor-tag-list__definition">
  536. <section class="phpdocumentor-description"><p>VersionProvider</p>
  537. </section>
  538. </dd>
  539. </dl>
  540. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  541. <span class="phpdocumentor-signature__response_type">void</span>
  542. &mdash;
  543. </article>
  544. <article
  545. class="phpdocumentor-element
  546. -method
  547. -public
  548. "
  549. >
  550. <h4 class="phpdocumentor-element__name" id="method_testVersionMinMaxClamp">
  551. testVersionMinMaxClamp()
  552. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_testVersionMinMaxClamp" class="headerlink"><i class="fas fa-link"></i></a>
  553. </h4>
  554. <aside class="phpdocumentor-element-found-in">
  555. <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>
  556. :
  557. <span class="phpdocumentor-element-found-in__line">63</span>
  558. </aside>
  559. <p class="phpdocumentor-summary">Tests the $versionMin/$versionMax clamping</p>
  560. <code class="phpdocumentor-code phpdocumentor-signature ">
  561. <span class="phpdocumentor-signature__visibility">public</span>
  562. <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>
  563. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  564. <dl class="phpdocumentor-argument-list">
  565. <dt class="phpdocumentor-argument-list__entry">
  566. <span class="phpdocumentor-signature__argument__name">$versionMin</span>
  567. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  568. </dt>
  569. <dd class="phpdocumentor-argument-list__definition">
  570. <section class="phpdocumentor-description"></section>
  571. </dd>
  572. <dt class="phpdocumentor-argument-list__entry">
  573. <span class="phpdocumentor-signature__argument__name">$versionMax</span>
  574. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  575. </dt>
  576. <dd class="phpdocumentor-argument-list__definition">
  577. <section class="phpdocumentor-description"></section>
  578. </dd>
  579. <dt class="phpdocumentor-argument-list__entry">
  580. <span class="phpdocumentor-signature__argument__name">$expectedMin</span>
  581. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  582. </dt>
  583. <dd class="phpdocumentor-argument-list__definition">
  584. <section class="phpdocumentor-description"></section>
  585. </dd>
  586. <dt class="phpdocumentor-argument-list__entry">
  587. <span class="phpdocumentor-signature__argument__name">$expectedMax</span>
  588. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  589. </dt>
  590. <dd class="phpdocumentor-argument-list__definition">
  591. <section class="phpdocumentor-description"></section>
  592. </dd>
  593. </dl>
  594. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  595. Tags
  596. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  597. </h5>
  598. <dl class="phpdocumentor-tag-list">
  599. <dt class="phpdocumentor-tag-list__entry">
  600. <span class="phpdocumentor-tag__name">dataProvider</span>
  601. </dt>
  602. <dd class="phpdocumentor-tag-list__definition">
  603. <section class="phpdocumentor-description"><p>VersionMinMaxProvider</p>
  604. </section>
  605. </dd>
  606. </dl>
  607. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  608. <span class="phpdocumentor-signature__response_type">void</span>
  609. &mdash;
  610. </article>
  611. <article
  612. class="phpdocumentor-element
  613. -method
  614. -public
  615. "
  616. >
  617. <h4 class="phpdocumentor-element__name" id="method_VersionMinMaxProvider">
  618. VersionMinMaxProvider()
  619. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_VersionMinMaxProvider" class="headerlink"><i class="fas fa-link"></i></a>
  620. </h4>
  621. <aside class="phpdocumentor-element-found-in">
  622. <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>
  623. :
  624. <span class="phpdocumentor-element-found-in__line">49</span>
  625. </aside>
  626. <code class="phpdocumentor-code phpdocumentor-signature ">
  627. <span class="phpdocumentor-signature__visibility">public</span>
  628. <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>
  629. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  630. <span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;</span>
  631. &mdash;
  632. </article>
  633. <article
  634. class="phpdocumentor-element
  635. -method
  636. -public
  637. "
  638. >
  639. <h4 class="phpdocumentor-element__name" id="method_VersionProvider">
  640. VersionProvider()
  641. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#method_VersionProvider" class="headerlink"><i class="fas fa-link"></i></a>
  642. </h4>
  643. <aside class="phpdocumentor-element-found-in">
  644. <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>
  645. :
  646. <span class="phpdocumentor-element-found-in__line">26</span>
  647. </aside>
  648. <code class="phpdocumentor-code phpdocumentor-signature ">
  649. <span class="phpdocumentor-signature__visibility">public</span>
  650. <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>
  651. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  652. <span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, int&gt;&gt;</span>
  653. &mdash;
  654. </article>
  655. </section>
  656. <script type="text/javascript">
  657. function loadExternalCodeSnippets(line) {
  658. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  659. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  660. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  661. var language = 'php';
  662. var code = document.createElement('code');
  663. code.className = 'language-' + language;
  664. pre.textContent = '';
  665. pre.setAttribute('data-line', line)
  666. code.textContent = 'Loading…';
  667. pre.appendChild(code);
  668. var xhr = new XMLHttpRequest();
  669. xhr.open('GET', src, true);
  670. xhr.onreadystatechange = function () {
  671. if (xhr.readyState == 4) {
  672. if (xhr.status < 400 && xhr.responseText) {
  673. code.textContent = xhr.responseText;
  674. Prism.highlightElement(code);
  675. }
  676. else if (xhr.status >= 400) {
  677. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  678. }
  679. else {
  680. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  681. }
  682. }
  683. };
  684. xhr.send(null);
  685. });
  686. }
  687. var modals = document.querySelectorAll("[data-modal]");
  688. modals.forEach(function (trigger) {
  689. trigger.addEventListener("click", function (event) {
  690. //event.preventDefault();
  691. const modal = document.getElementById(trigger.dataset.modal);
  692. modal.classList.add("phpdocumentor-modal__open");
  693. loadExternalCodeSnippets(trigger.dataset.line)
  694. const exits = modal.querySelectorAll("[data-exit-button]");
  695. exits.forEach(function (exit) {
  696. exit.addEventListener("click", function (event) {
  697. event.preventDefault();
  698. modal.classList.remove("phpdocumentor-modal__open");
  699. });
  700. });
  701. });
  702. });
  703. </script>
  704. </article>
  705. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  706. <section class="phpdocumentor-search-results__dialog">
  707. <header class="phpdocumentor-search-results__header">
  708. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  709. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  710. </header>
  711. <section class="phpdocumentor-search-results__body">
  712. <ul class="phpdocumentor-search-results__entries"></ul>
  713. </section>
  714. </section>
  715. </section>
  716. </div>
  717. </div>
  718. <a href="classes/chillerlan-QRCodeTest-QROptionsTest.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  719. </main>
  720. <script>
  721. cssVars({});
  722. </script>
  723. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  724. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  725. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  726. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  727. </body>
  728. </html>