chillerlan-QRCode-QRCodeReaderOptionsTrait.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. </section>
  89. <section class="phpdocumentor-sidebar__category -packages">
  90. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  91. <h4 class="phpdocumentor-sidebar__root-namespace">
  92. <a href="packages/Application.html" class="">Application</a>
  93. </h4>
  94. </section>
  95. <section class="phpdocumentor-sidebar__category -reports">
  96. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  97. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  98. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  99. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  100. </section>
  101. <section class="phpdocumentor-sidebar__category -indices">
  102. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  103. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  104. </section>
  105. </aside>
  106. <div class="phpdocumentor-column -nine phpdocumentor-content">
  107. <section>
  108. <ul class="phpdocumentor-breadcrumbs">
  109. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  110. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  111. </ul>
  112. <article class="phpdocumentor-element -trait">
  113. <h2 class="phpdocumentor-content__title">
  114. QRCodeReaderOptionsTrait
  115. </h2>
  116. <aside class="phpdocumentor-element-found-in">
  117. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  118. :
  119. <span class="phpdocumentor-element-found-in__line">24</span>
  120. </aside>
  121. <p class="phpdocumentor-summary">Trait QRCodeReaderOptionsTrait</p>
  122. <h3 id="toc">
  123. Table of Contents
  124. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  125. </h3>
  126. <h4 id="toc-properties">
  127. Properties
  128. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  129. </h4>
  130. <dl class="phpdocumentor-table-of-contents">
  131. <dt class="phpdocumentor-table-of-contents__entry -property -public">
  132. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale">$readerGrayscale</a>
  133. <span>
  134. &nbsp;: bool </span>
  135. </dt>
  136. <dt class="phpdocumentor-table-of-contents__entry -property -public">
  137. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a>
  138. <span>
  139. &nbsp;: bool </span>
  140. </dt>
  141. <dt class="phpdocumentor-table-of-contents__entry -property -public">
  142. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors">$readerInvertColors</a>
  143. <span>
  144. &nbsp;: bool </span>
  145. </dt>
  146. <dt class="phpdocumentor-table-of-contents__entry -property -public">
  147. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a>
  148. <span>
  149. &nbsp;: bool </span>
  150. </dt>
  151. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  152. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale">$readerGrayscale</a>
  153. <span>
  154. &nbsp;: bool </span>
  155. </dt>
  156. <dd>Grayscale the image before reading</dd>
  157. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  158. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a>
  159. <span>
  160. &nbsp;: bool </span>
  161. </dt>
  162. <dd>Increase the contrast before reading</dd>
  163. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  164. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors">$readerInvertColors</a>
  165. <span>
  166. &nbsp;: bool </span>
  167. </dt>
  168. <dd>Invert the colors of the image</dd>
  169. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  170. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a>
  171. <span>
  172. &nbsp;: bool </span>
  173. </dt>
  174. <dd>Use Imagick (if available) when reading QR Codes</dd>
  175. </dl>
  176. <h4 id="toc-methods">
  177. Methods
  178. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  179. </h4>
  180. <dl class="phpdocumentor-table-of-contents">
  181. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  182. <a class="" href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#method_set_readerUseImagickIfAvailable">set_readerUseImagickIfAvailable()</a>
  183. <span>
  184. &nbsp;: void </span>
  185. </dt>
  186. <dd>enables Imagick for the QR Code reader if the extension is available</dd>
  187. </dl>
  188. <section class="phpdocumentor-properties">
  189. <h3 class="phpdocumentor-elements__header" id="properties">
  190. Properties
  191. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  192. </h3>
  193. <article
  194. class="
  195. phpdocumentor-element
  196. -property
  197. -public
  198. "
  199. >
  200. <h4 class="phpdocumentor-element__name" id="property_readerGrayscale">
  201. $readerGrayscale
  202. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale" class="headerlink"><i class="fas fa-link"></i></a>
  203. <span class="phpdocumentor-element__modifiers">
  204. </span>
  205. </h4>
  206. <aside class="phpdocumentor-element-found-in">
  207. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  208. :
  209. <span class="phpdocumentor-element-found-in__line">0</span>
  210. </aside>
  211. <code class="phpdocumentor-code phpdocumentor-signature ">
  212. <span class="phpdocumentor-signature__visibility">public</span>
  213. <span class="phpdocumentor-signature__type">bool</span>
  214. <span class="phpdocumentor-signature__name">$readerGrayscale</span>
  215. </code>
  216. </article>
  217. <article
  218. class="
  219. phpdocumentor-element
  220. -property
  221. -public
  222. "
  223. >
  224. <h4 class="phpdocumentor-element__name" id="property_readerIncreaseContrast">
  225. $readerIncreaseContrast
  226. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast" class="headerlink"><i class="fas fa-link"></i></a>
  227. <span class="phpdocumentor-element__modifiers">
  228. </span>
  229. </h4>
  230. <aside class="phpdocumentor-element-found-in">
  231. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  232. :
  233. <span class="phpdocumentor-element-found-in__line">0</span>
  234. </aside>
  235. <code class="phpdocumentor-code phpdocumentor-signature ">
  236. <span class="phpdocumentor-signature__visibility">public</span>
  237. <span class="phpdocumentor-signature__type">bool</span>
  238. <span class="phpdocumentor-signature__name">$readerIncreaseContrast</span>
  239. </code>
  240. </article>
  241. <article
  242. class="
  243. phpdocumentor-element
  244. -property
  245. -public
  246. "
  247. >
  248. <h4 class="phpdocumentor-element__name" id="property_readerInvertColors">
  249. $readerInvertColors
  250. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors" class="headerlink"><i class="fas fa-link"></i></a>
  251. <span class="phpdocumentor-element__modifiers">
  252. </span>
  253. </h4>
  254. <aside class="phpdocumentor-element-found-in">
  255. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  256. :
  257. <span class="phpdocumentor-element-found-in__line">0</span>
  258. </aside>
  259. <code class="phpdocumentor-code phpdocumentor-signature ">
  260. <span class="phpdocumentor-signature__visibility">public</span>
  261. <span class="phpdocumentor-signature__type">bool</span>
  262. <span class="phpdocumentor-signature__name">$readerInvertColors</span>
  263. </code>
  264. </article>
  265. <article
  266. class="
  267. phpdocumentor-element
  268. -property
  269. -public
  270. "
  271. >
  272. <h4 class="phpdocumentor-element__name" id="property_readerUseImagickIfAvailable">
  273. $readerUseImagickIfAvailable
  274. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  275. <span class="phpdocumentor-element__modifiers">
  276. </span>
  277. </h4>
  278. <aside class="phpdocumentor-element-found-in">
  279. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  280. :
  281. <span class="phpdocumentor-element-found-in__line">0</span>
  282. </aside>
  283. <code class="phpdocumentor-code phpdocumentor-signature ">
  284. <span class="phpdocumentor-signature__visibility">public</span>
  285. <span class="phpdocumentor-signature__type">bool</span>
  286. <span class="phpdocumentor-signature__name">$readerUseImagickIfAvailable</span>
  287. </code>
  288. </article>
  289. <article
  290. class="
  291. phpdocumentor-element
  292. -property
  293. -protected
  294. "
  295. >
  296. <h4 class="phpdocumentor-element__name" id="property_readerGrayscale">
  297. $readerGrayscale
  298. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale" class="headerlink"><i class="fas fa-link"></i></a>
  299. <span class="phpdocumentor-element__modifiers">
  300. </span>
  301. </h4>
  302. <aside class="phpdocumentor-element-found-in">
  303. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  304. :
  305. <span class="phpdocumentor-element-found-in__line">34</span>
  306. </aside>
  307. <p class="phpdocumentor-summary">Grayscale the image before reading</p>
  308. <code class="phpdocumentor-code phpdocumentor-signature ">
  309. <span class="phpdocumentor-signature__visibility">protected</span>
  310. <span class="phpdocumentor-signature__type">bool</span>
  311. <span class="phpdocumentor-signature__name">$readerGrayscale</span>
  312. = <span class="phpdocumentor-signature__default-value">false</span></code>
  313. </article>
  314. <article
  315. class="
  316. phpdocumentor-element
  317. -property
  318. -protected
  319. "
  320. >
  321. <h4 class="phpdocumentor-element__name" id="property_readerIncreaseContrast">
  322. $readerIncreaseContrast
  323. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast" class="headerlink"><i class="fas fa-link"></i></a>
  324. <span class="phpdocumentor-element__modifiers">
  325. </span>
  326. </h4>
  327. <aside class="phpdocumentor-element-found-in">
  328. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  329. :
  330. <span class="phpdocumentor-element-found-in__line">46</span>
  331. </aside>
  332. <p class="phpdocumentor-summary">Increase the contrast before reading</p>
  333. <code class="phpdocumentor-code phpdocumentor-signature ">
  334. <span class="phpdocumentor-signature__visibility">protected</span>
  335. <span class="phpdocumentor-signature__type">bool</span>
  336. <span class="phpdocumentor-signature__name">$readerIncreaseContrast</span>
  337. = <span class="phpdocumentor-signature__default-value">false</span></code>
  338. <section class="phpdocumentor-description"><p>note that applying contrast works different in GD and Imagick, so mileage may vary</p>
  339. </section>
  340. </article>
  341. <article
  342. class="
  343. phpdocumentor-element
  344. -property
  345. -protected
  346. "
  347. >
  348. <h4 class="phpdocumentor-element__name" id="property_readerInvertColors">
  349. $readerInvertColors
  350. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors" class="headerlink"><i class="fas fa-link"></i></a>
  351. <span class="phpdocumentor-element__modifiers">
  352. </span>
  353. </h4>
  354. <aside class="phpdocumentor-element-found-in">
  355. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  356. :
  357. <span class="phpdocumentor-element-found-in__line">39</span>
  358. </aside>
  359. <p class="phpdocumentor-summary">Invert the colors of the image</p>
  360. <code class="phpdocumentor-code phpdocumentor-signature ">
  361. <span class="phpdocumentor-signature__visibility">protected</span>
  362. <span class="phpdocumentor-signature__type">bool</span>
  363. <span class="phpdocumentor-signature__name">$readerInvertColors</span>
  364. = <span class="phpdocumentor-signature__default-value">false</span></code>
  365. </article>
  366. <article
  367. class="
  368. phpdocumentor-element
  369. -property
  370. -protected
  371. "
  372. >
  373. <h4 class="phpdocumentor-element__name" id="property_readerUseImagickIfAvailable">
  374. $readerUseImagickIfAvailable
  375. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  376. <span class="phpdocumentor-element__modifiers">
  377. </span>
  378. </h4>
  379. <aside class="phpdocumentor-element-found-in">
  380. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  381. :
  382. <span class="phpdocumentor-element-found-in__line">29</span>
  383. </aside>
  384. <p class="phpdocumentor-summary">Use Imagick (if available) when reading QR Codes</p>
  385. <code class="phpdocumentor-code phpdocumentor-signature ">
  386. <span class="phpdocumentor-signature__visibility">protected</span>
  387. <span class="phpdocumentor-signature__type">bool</span>
  388. <span class="phpdocumentor-signature__name">$readerUseImagickIfAvailable</span>
  389. = <span class="phpdocumentor-signature__default-value">false</span></code>
  390. </article>
  391. </section>
  392. <section class="phpdocumentor-methods">
  393. <h3 class="phpdocumentor-elements__header" id="methods">
  394. Methods
  395. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  396. </h3>
  397. <article
  398. class="phpdocumentor-element
  399. -method
  400. -protected
  401. "
  402. >
  403. <h4 class="phpdocumentor-element__name" id="method_set_readerUseImagickIfAvailable">
  404. set_readerUseImagickIfAvailable()
  405. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#method_set_readerUseImagickIfAvailable" class="headerlink"><i class="fas fa-link"></i></a>
  406. </h4>
  407. <aside class="phpdocumentor-element-found-in">
  408. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCodeReaderOptionsTrait.php"><a href="files/src-qrcodereaderoptionstrait.html"><abbr title="src/QRCodeReaderOptionsTrait.php">QRCodeReaderOptionsTrait.php</abbr></a></abbr>
  409. :
  410. <span class="phpdocumentor-element-found-in__line">51</span>
  411. </aside>
  412. <p class="phpdocumentor-summary">enables Imagick for the QR Code reader if the extension is available</p>
  413. <code class="phpdocumentor-code phpdocumentor-signature ">
  414. <span class="phpdocumentor-signature__visibility">protected</span>
  415. <span class="phpdocumentor-signature__name">set_readerUseImagickIfAvailable</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  416. <div class="phpdocumentor-label-line">
  417. </div>
  418. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  419. <dl class="phpdocumentor-argument-list">
  420. <dt class="phpdocumentor-argument-list__entry">
  421. <span class="phpdocumentor-signature__argument__name">$useImagickIfAvailable</span>
  422. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  423. </dt>
  424. <dd class="phpdocumentor-argument-list__definition">
  425. </dd>
  426. </dl>
  427. </article>
  428. </section>
  429. <div class="phpdocumentor-modal" id="source-view">
  430. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  431. <div class="phpdocumentor-modal-container">
  432. <div class="phpdocumentor-modal-content">
  433. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/QRCodeReaderOptionsTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  434. </div>
  435. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  436. </div>
  437. </div>
  438. <script type="text/javascript">
  439. (function () {
  440. function loadExternalCodeSnippet(el, url, line) {
  441. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  442. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  443. const language = 'php';
  444. const code = document.createElement('code');
  445. code.className = 'language-' + language;
  446. pre.textContent = '';
  447. pre.setAttribute('data-line', line)
  448. code.textContent = 'Loading…';
  449. pre.appendChild(code);
  450. var xhr = new XMLHttpRequest();
  451. xhr.open('GET', src, true);
  452. xhr.onreadystatechange = function () {
  453. if (xhr.readyState !== 4) {
  454. return;
  455. }
  456. if (xhr.status < 400 && xhr.responseText) {
  457. code.textContent = xhr.responseText;
  458. Prism.highlightElement(code);
  459. return;
  460. }
  461. if (xhr.status === 404) {
  462. code.textContent = '✖ Error: File could not be found';
  463. return;
  464. }
  465. if (xhr.status >= 400) {
  466. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  467. return;
  468. }
  469. code.textContent = '✖ Error: An unknown error occurred';
  470. };
  471. xhr.send(null);
  472. });
  473. }
  474. const modalButtons = document.querySelectorAll("[data-modal]");
  475. const openedAsLocalFile = window.location.protocol === 'file:';
  476. if (modalButtons.length > 0 && openedAsLocalFile) {
  477. console.warn(
  478. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  479. 'browsers block XHR requests when a page is opened this way'
  480. );
  481. }
  482. modalButtons.forEach(function (trigger) {
  483. if (openedAsLocalFile) {
  484. trigger.setAttribute("hidden", "hidden");
  485. }
  486. trigger.addEventListener("click", function (event) {
  487. event.preventDefault();
  488. const modal = document.getElementById(trigger.dataset.modal);
  489. if (!modal) {
  490. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  491. return;
  492. }
  493. modal.classList.add("phpdocumentor-modal__open");
  494. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  495. const exits = modal.querySelectorAll("[data-exit-button]");
  496. exits.forEach(function (exit) {
  497. exit.addEventListener("click", function (event) {
  498. event.preventDefault();
  499. modal.classList.remove("phpdocumentor-modal__open");
  500. });
  501. });
  502. });
  503. });
  504. })();
  505. </script>
  506. </article>
  507. </section>
  508. <section class="phpdocumentor-on-this-page__sidebar">
  509. <section class="phpdocumentor-on-this-page__content">
  510. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  511. <ul class="phpdocumentor-list -clean">
  512. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  513. <li>
  514. <ul class="phpdocumentor-list -clean">
  515. <li><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#toc-properties">Properties</a></li>
  516. <li><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#toc-methods">Methods</a></li>
  517. </ul>
  518. </li>
  519. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  520. <li>
  521. <ul class="phpdocumentor-list -clean">
  522. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale">$readerGrayscale</a></li>
  523. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a></li>
  524. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors">$readerInvertColors</a></li>
  525. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a></li>
  526. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerGrayscale">$readerGrayscale</a></li>
  527. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerIncreaseContrast">$readerIncreaseContrast</a></li>
  528. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerInvertColors">$readerInvertColors</a></li>
  529. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#property_readerUseImagickIfAvailable">$readerUseImagickIfAvailable</a></li>
  530. </ul>
  531. </li>
  532. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  533. <li>
  534. <ul class="phpdocumentor-list -clean">
  535. <li class=""><a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#method_set_readerUseImagickIfAvailable">set_readerUseImagickIfAvailable()</a></li>
  536. </ul>
  537. </li>
  538. </ul>
  539. </section>
  540. </section>
  541. </div>
  542. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  543. <section class="phpdocumentor-search-results__dialog">
  544. <header class="phpdocumentor-search-results__header">
  545. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  546. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  547. </header>
  548. <section class="phpdocumentor-search-results__body">
  549. <ul class="phpdocumentor-search-results__entries"></ul>
  550. </section>
  551. </section>
  552. </section>
  553. </div>
  554. <a href="classes/chillerlan-QRCode-QRCodeReaderOptionsTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  555. </main>
  556. <script>
  557. cssVars({});
  558. </script>
  559. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  560. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  561. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  562. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  563. </body>
  564. </html>