chillerlan-QRCodeTest-QROptionsTest.html 44 KB

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