chillerlan-QRCode-Decoder-IMagickLuminanceSource.html 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062
  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-qrcode.html">QRCode</a></li>
  84. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-decoder.html">Decoder</a></li>
  85. </ul>
  86. <article class="phpdocumentor-element -class">
  87. <h2 class="phpdocumentor-content__title">
  88. IMagickLuminanceSource
  89. <span class="phpdocumentor-element__extends">
  90. extends <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html"><abbr title="\chillerlan\QRCode\Decoder\LuminanceSourceAbstract">LuminanceSourceAbstract</abbr></a>
  91. </span>
  92. <div class="phpdocumentor-element__package">
  93. in package
  94. <ul class="phpdocumentor-breadcrumbs">
  95. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  96. </ul>
  97. </div>
  98. </h2>
  99. <aside class="phpdocumentor-element-found-in">
  100. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/IMagickLuminanceSource.php"><a href="files/src-decoder-imagickluminancesource.html"><abbr title="src/Decoder/IMagickLuminanceSource.php">IMagickLuminanceSource.php</abbr></a></abbr>
  101. :
  102. <span class="phpdocumentor-element-found-in__line">24</span>
  103. </aside>
  104. <p class="phpdocumentor-summary">This class is used to help decode images from files which arrive as Imagick Resource
  105. It does not support rotation.</p>
  106. <h3 id="toc">
  107. Table of Contents
  108. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  109. </h3>
  110. <dl class="phpdocumentor-table-of-contents">
  111. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  112. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#property_height">$height</a>
  113. <span>
  114. &nbsp;: int </span>
  115. </dt>
  116. <dd></dd>
  117. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  118. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#property_imagick">$imagick</a>
  119. <span>
  120. &nbsp;: <abbr title="\Imagick">Imagick</abbr> </span>
  121. </dt>
  122. <dd></dd>
  123. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  124. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#property_luminances">$luminances</a>
  125. <span>
  126. &nbsp;: array&lt;string|int, mixed&gt; </span>
  127. </dt>
  128. <dd></dd>
  129. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  130. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#property_options">$options</a>
  131. <span>
  132. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  133. </dt>
  134. <dd></dd>
  135. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  136. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#property_width">$width</a>
  137. <span>
  138. &nbsp;: int </span>
  139. </dt>
  140. <dd></dd>
  141. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  142. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#method___construct">__construct()</a>
  143. <span>
  144. &nbsp;: mixed </span>
  145. </dt>
  146. <dd>IMagickLuminanceSource constructor.</dd>
  147. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  148. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#method_fromBlob">fromBlob()</a>
  149. <span>
  150. &nbsp;: self </span>
  151. </dt>
  152. <dd></dd>
  153. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  154. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#method_fromFile">fromFile()</a>
  155. <span>
  156. &nbsp;: self </span>
  157. </dt>
  158. <dd></dd>
  159. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  160. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#method_getHeight">getHeight()</a>
  161. <span>
  162. &nbsp;: int </span>
  163. </dt>
  164. <dd></dd>
  165. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  166. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#method_getMatrix">getMatrix()</a>
  167. <span>
  168. &nbsp;: array&lt;string|int, mixed&gt; </span>
  169. </dt>
  170. <dd>Fetches luminance data for the underlying bitmap. Values should be fetched using:
  171. `int luminance = array[y * width + x] &amp; 0xff`</dd>
  172. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  173. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#method_getRow">getRow()</a>
  174. <span>
  175. &nbsp;: array&lt;string|int, mixed&gt; </span>
  176. </dt>
  177. <dd>Fetches one row of luminance data from the underlying platform&#039;s bitmap. Values range from
  178. 0 (black) to 255 (white). Because Java does not have an unsigned byte type, callers will have
  179. to bitwise and with 0xff for each value. It is preferable for implementations of this method
  180. to only fetch this row rather than the whole image, since no 2D Readers may be installed and
  181. getMatrix() may never be called.</dd>
  182. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  183. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#method_getWidth">getWidth()</a>
  184. <span>
  185. &nbsp;: int </span>
  186. </dt>
  187. <dd></dd>
  188. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  189. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#method_checkFile">checkFile()</a>
  190. <span>
  191. &nbsp;: string </span>
  192. </dt>
  193. <dd></dd>
  194. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  195. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#method_setLuminancePixel">setLuminancePixel()</a>
  196. <span>
  197. &nbsp;: void </span>
  198. </dt>
  199. <dd></dd>
  200. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  201. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#method_setLuminancePixels">setLuminancePixels()</a>
  202. <span>
  203. &nbsp;: void </span>
  204. </dt>
  205. <dd></dd>
  206. </dl>
  207. <section class="phpdocumentor-properties">
  208. <h3 class="phpdocumentor-elements__header" id="properties">
  209. Properties
  210. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  211. </h3>
  212. <article
  213. class="
  214. phpdocumentor-element
  215. -property
  216. -protected
  217. "
  218. >
  219. <h4 class="phpdocumentor-element__name" id="property_height">
  220. $height
  221. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#property_height" class="headerlink"><i class="fas fa-link"></i></a>
  222. <span class="phpdocumentor-element__modifiers">
  223. </span>
  224. </h4>
  225. <aside class="phpdocumentor-element-found-in">
  226. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/LuminanceSourceAbstract.php"><a href="files/src-decoder-luminancesourceabstract.html"><abbr title="src/Decoder/LuminanceSourceAbstract.php">LuminanceSourceAbstract.php</abbr></a></abbr>
  227. :
  228. <span class="phpdocumentor-element-found-in__line">33</span>
  229. </aside>
  230. <code class="phpdocumentor-code phpdocumentor-signature ">
  231. <span class="phpdocumentor-signature__visibility">protected</span>
  232. <span class="phpdocumentor-signature__type">int</span>
  233. <span class="phpdocumentor-signature__name">$height</span>
  234. </code>
  235. <section class="phpdocumentor-description"></section>
  236. <section class="phpdocumentor-description"></section>
  237. </article>
  238. <article
  239. class="
  240. phpdocumentor-element
  241. -property
  242. -protected
  243. "
  244. >
  245. <h4 class="phpdocumentor-element__name" id="property_imagick">
  246. $imagick
  247. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#property_imagick" class="headerlink"><i class="fas fa-link"></i></a>
  248. <span class="phpdocumentor-element__modifiers">
  249. </span>
  250. </h4>
  251. <aside class="phpdocumentor-element-found-in">
  252. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/IMagickLuminanceSource.php"><a href="files/src-decoder-imagickluminancesource.html"><abbr title="src/Decoder/IMagickLuminanceSource.php">IMagickLuminanceSource.php</abbr></a></abbr>
  253. :
  254. <span class="phpdocumentor-element-found-in__line">26</span>
  255. </aside>
  256. <code class="phpdocumentor-code phpdocumentor-signature ">
  257. <span class="phpdocumentor-signature__visibility">protected</span>
  258. <span class="phpdocumentor-signature__type"><abbr title="\Imagick">Imagick</abbr></span>
  259. <span class="phpdocumentor-signature__name">$imagick</span>
  260. </code>
  261. <section class="phpdocumentor-description"></section>
  262. <section class="phpdocumentor-description"></section>
  263. </article>
  264. <article
  265. class="
  266. phpdocumentor-element
  267. -property
  268. -protected
  269. "
  270. >
  271. <h4 class="phpdocumentor-element__name" id="property_luminances">
  272. $luminances
  273. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#property_luminances" class="headerlink"><i class="fas fa-link"></i></a>
  274. <span class="phpdocumentor-element__modifiers">
  275. </span>
  276. </h4>
  277. <aside class="phpdocumentor-element-found-in">
  278. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/LuminanceSourceAbstract.php"><a href="files/src-decoder-luminancesourceabstract.html"><abbr title="src/Decoder/LuminanceSourceAbstract.php">LuminanceSourceAbstract.php</abbr></a></abbr>
  279. :
  280. <span class="phpdocumentor-element-found-in__line">31</span>
  281. </aside>
  282. <code class="phpdocumentor-code phpdocumentor-signature ">
  283. <span class="phpdocumentor-signature__visibility">protected</span>
  284. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  285. <span class="phpdocumentor-signature__name">$luminances</span>
  286. </code>
  287. <section class="phpdocumentor-description"></section>
  288. <section class="phpdocumentor-description"></section>
  289. </article>
  290. <article
  291. class="
  292. phpdocumentor-element
  293. -property
  294. -protected
  295. "
  296. >
  297. <h4 class="phpdocumentor-element__name" id="property_options">
  298. $options
  299. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  300. <span class="phpdocumentor-element__modifiers">
  301. </span>
  302. </h4>
  303. <aside class="phpdocumentor-element-found-in">
  304. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/LuminanceSourceAbstract.php"><a href="files/src-decoder-luminancesourceabstract.html"><abbr title="src/Decoder/LuminanceSourceAbstract.php">LuminanceSourceAbstract.php</abbr></a></abbr>
  305. :
  306. <span class="phpdocumentor-element-found-in__line">30</span>
  307. </aside>
  308. <code class="phpdocumentor-code phpdocumentor-signature ">
  309. <span class="phpdocumentor-signature__visibility">protected</span>
  310. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  311. <span class="phpdocumentor-signature__name">$options</span>
  312. </code>
  313. </article>
  314. <article
  315. class="
  316. phpdocumentor-element
  317. -property
  318. -protected
  319. "
  320. >
  321. <h4 class="phpdocumentor-element__name" id="property_width">
  322. $width
  323. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#property_width" 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/Decoder/LuminanceSourceAbstract.php"><a href="files/src-decoder-luminancesourceabstract.html"><abbr title="src/Decoder/LuminanceSourceAbstract.php">LuminanceSourceAbstract.php</abbr></a></abbr>
  329. :
  330. <span class="phpdocumentor-element-found-in__line">32</span>
  331. </aside>
  332. <code class="phpdocumentor-code phpdocumentor-signature ">
  333. <span class="phpdocumentor-signature__visibility">protected</span>
  334. <span class="phpdocumentor-signature__type">int</span>
  335. <span class="phpdocumentor-signature__name">$width</span>
  336. </code>
  337. <section class="phpdocumentor-description"></section>
  338. <section class="phpdocumentor-description"></section>
  339. </article>
  340. </section>
  341. <section class="phpdocumentor-methods">
  342. <h3 class="phpdocumentor-elements__header" id="methods">
  343. Methods
  344. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  345. </h3>
  346. <article
  347. class="phpdocumentor-element
  348. -method
  349. -public
  350. "
  351. >
  352. <h4 class="phpdocumentor-element__name" id="method___construct">
  353. __construct()
  354. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  355. </h4>
  356. <aside class="phpdocumentor-element-found-in">
  357. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/IMagickLuminanceSource.php"><a href="files/src-decoder-imagickluminancesource.html"><abbr title="src/Decoder/IMagickLuminanceSource.php">IMagickLuminanceSource.php</abbr></a></abbr>
  358. :
  359. <span class="phpdocumentor-element-found-in__line">31</span>
  360. </aside>
  361. <p class="phpdocumentor-summary">IMagickLuminanceSource constructor.</p>
  362. <code class="phpdocumentor-code phpdocumentor-signature ">
  363. <span class="phpdocumentor-signature__visibility">public</span>
  364. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Imagick">Imagick</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$imagick</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  365. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  366. <dl class="phpdocumentor-argument-list">
  367. <dt class="phpdocumentor-argument-list__entry">
  368. <span class="phpdocumentor-signature__argument__name">$imagick</span>
  369. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Imagick">Imagick</abbr></span>
  370. </dt>
  371. <dd class="phpdocumentor-argument-list__definition">
  372. <section class="phpdocumentor-description"></section>
  373. </dd>
  374. <dt class="phpdocumentor-argument-list__entry">
  375. <span class="phpdocumentor-signature__argument__name">$options</span>
  376. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  377. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  378. <dd class="phpdocumentor-argument-list__definition">
  379. <section class="phpdocumentor-description"></section>
  380. </dd>
  381. </dl>
  382. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  383. <span class="phpdocumentor-signature__response_type">mixed</span>
  384. &mdash;
  385. </article>
  386. <article
  387. class="phpdocumentor-element
  388. -method
  389. -public
  390. -static "
  391. >
  392. <h4 class="phpdocumentor-element__name" id="method_fromBlob">
  393. fromBlob()
  394. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#method_fromBlob" class="headerlink"><i class="fas fa-link"></i></a>
  395. </h4>
  396. <aside class="phpdocumentor-element-found-in">
  397. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/IMagickLuminanceSource.php"><a href="files/src-decoder-imagickluminancesource.html"><abbr title="src/Decoder/IMagickLuminanceSource.php">IMagickLuminanceSource.php</abbr></a></abbr>
  398. :
  399. <span class="phpdocumentor-element-found-in__line">68</span>
  400. </aside>
  401. <code class="phpdocumentor-code phpdocumentor-signature ">
  402. <span class="phpdocumentor-signature__visibility">public</span>
  403. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">fromBlob</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$blob</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  404. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  405. <dl class="phpdocumentor-argument-list">
  406. <dt class="phpdocumentor-argument-list__entry">
  407. <span class="phpdocumentor-signature__argument__name">$blob</span>
  408. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  409. </dt>
  410. <dd class="phpdocumentor-argument-list__definition">
  411. <section class="phpdocumentor-description"></section>
  412. </dd>
  413. <dt class="phpdocumentor-argument-list__entry">
  414. <span class="phpdocumentor-signature__argument__name">$options</span>
  415. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  416. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  417. <dd class="phpdocumentor-argument-list__definition">
  418. <section class="phpdocumentor-description"></section>
  419. </dd>
  420. </dl>
  421. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  422. Tags
  423. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  424. </h5>
  425. <dl class="phpdocumentor-tag-list">
  426. <dt class="phpdocumentor-tag-list__entry">
  427. <span class="phpdocumentor-tag__name">inheritDoc</span>
  428. </dt>
  429. <dd class="phpdocumentor-tag-list__definition">
  430. </dd>
  431. </dl>
  432. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  433. <span class="phpdocumentor-signature__response_type">self</span>
  434. &mdash;
  435. </article>
  436. <article
  437. class="phpdocumentor-element
  438. -method
  439. -public
  440. -static "
  441. >
  442. <h4 class="phpdocumentor-element__name" id="method_fromFile">
  443. fromFile()
  444. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#method_fromFile" class="headerlink"><i class="fas fa-link"></i></a>
  445. </h4>
  446. <aside class="phpdocumentor-element-found-in">
  447. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/IMagickLuminanceSource.php"><a href="files/src-decoder-imagickluminancesource.html"><abbr title="src/Decoder/IMagickLuminanceSource.php">IMagickLuminanceSource.php</abbr></a></abbr>
  448. :
  449. <span class="phpdocumentor-element-found-in__line">63</span>
  450. </aside>
  451. <code class="phpdocumentor-code phpdocumentor-signature ">
  452. <span class="phpdocumentor-signature__visibility">public</span>
  453. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">fromFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  454. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  455. <dl class="phpdocumentor-argument-list">
  456. <dt class="phpdocumentor-argument-list__entry">
  457. <span class="phpdocumentor-signature__argument__name">$path</span>
  458. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  459. </dt>
  460. <dd class="phpdocumentor-argument-list__definition">
  461. <section class="phpdocumentor-description"></section>
  462. </dd>
  463. <dt class="phpdocumentor-argument-list__entry">
  464. <span class="phpdocumentor-signature__argument__name">$options</span>
  465. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  466. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  467. <dd class="phpdocumentor-argument-list__definition">
  468. <section class="phpdocumentor-description"></section>
  469. </dd>
  470. </dl>
  471. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  472. Tags
  473. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  474. </h5>
  475. <dl class="phpdocumentor-tag-list">
  476. <dt class="phpdocumentor-tag-list__entry">
  477. <span class="phpdocumentor-tag__name">inheritDoc</span>
  478. </dt>
  479. <dd class="phpdocumentor-tag-list__definition">
  480. </dd>
  481. </dl>
  482. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  483. <span class="phpdocumentor-signature__response_type">self</span>
  484. &mdash;
  485. </article>
  486. <article
  487. class="phpdocumentor-element
  488. -method
  489. -public
  490. "
  491. >
  492. <h4 class="phpdocumentor-element__name" id="method_getHeight">
  493. getHeight()
  494. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#method_getHeight" class="headerlink"><i class="fas fa-link"></i></a>
  495. </h4>
  496. <aside class="phpdocumentor-element-found-in">
  497. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/LuminanceSourceAbstract.php"><a href="files/src-decoder-luminancesourceabstract.html"><abbr title="src/Decoder/LuminanceSourceAbstract.php">LuminanceSourceAbstract.php</abbr></a></abbr>
  498. :
  499. <span class="phpdocumentor-element-found-in__line">57</span>
  500. </aside>
  501. <code class="phpdocumentor-code phpdocumentor-signature ">
  502. <span class="phpdocumentor-signature__visibility">public</span>
  503. <span class="phpdocumentor-signature__name">getHeight</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  504. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  505. Tags
  506. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  507. </h5>
  508. <dl class="phpdocumentor-tag-list">
  509. <dt class="phpdocumentor-tag-list__entry">
  510. <span class="phpdocumentor-tag__name">inheritDoc</span>
  511. </dt>
  512. <dd class="phpdocumentor-tag-list__definition">
  513. </dd>
  514. </dl>
  515. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  516. <span class="phpdocumentor-signature__response_type">int</span>
  517. &mdash;
  518. <section class="phpdocumentor-description"><p>The height of the bitmap.</p>
  519. </section>
  520. </article>
  521. <article
  522. class="phpdocumentor-element
  523. -method
  524. -public
  525. "
  526. >
  527. <h4 class="phpdocumentor-element__name" id="method_getMatrix">
  528. getMatrix()
  529. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#method_getMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  530. </h4>
  531. <aside class="phpdocumentor-element-found-in">
  532. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/LuminanceSourceAbstract.php"><a href="files/src-decoder-luminancesourceabstract.html"><abbr title="src/Decoder/LuminanceSourceAbstract.php">LuminanceSourceAbstract.php</abbr></a></abbr>
  533. :
  534. <span class="phpdocumentor-element-found-in__line">47</span>
  535. </aside>
  536. <p class="phpdocumentor-summary">Fetches luminance data for the underlying bitmap. Values should be fetched using:
  537. `int luminance = array[y * width + x] &amp; 0xff`</p>
  538. <code class="phpdocumentor-code phpdocumentor-signature ">
  539. <span class="phpdocumentor-signature__visibility">public</span>
  540. <span class="phpdocumentor-signature__name">getMatrix</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  541. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  542. Tags
  543. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  544. </h5>
  545. <dl class="phpdocumentor-tag-list">
  546. <dt class="phpdocumentor-tag-list__entry">
  547. <span class="phpdocumentor-tag__name">inheritDoc</span>
  548. </dt>
  549. <dd class="phpdocumentor-tag-list__definition">
  550. </dd>
  551. </dl>
  552. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  553. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  554. &mdash;
  555. <section class="phpdocumentor-description"><p>A row-major 2D array of luminance values. Do not use result.length as it may be
  556. larger than width * height bytes on some platforms. Do not modify the contents
  557. of the result.</p>
  558. </section>
  559. </article>
  560. <article
  561. class="phpdocumentor-element
  562. -method
  563. -public
  564. "
  565. >
  566. <h4 class="phpdocumentor-element__name" id="method_getRow">
  567. getRow()
  568. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#method_getRow" class="headerlink"><i class="fas fa-link"></i></a>
  569. </h4>
  570. <aside class="phpdocumentor-element-found-in">
  571. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/LuminanceSourceAbstract.php"><a href="files/src-decoder-luminancesourceabstract.html"><abbr title="src/Decoder/LuminanceSourceAbstract.php">LuminanceSourceAbstract.php</abbr></a></abbr>
  572. :
  573. <span class="phpdocumentor-element-found-in__line">62</span>
  574. </aside>
  575. <p class="phpdocumentor-summary">Fetches one row of luminance data from the underlying platform&#039;s bitmap. Values range from
  576. 0 (black) to 255 (white). Because Java does not have an unsigned byte type, callers will have
  577. to bitwise and with 0xff for each value. It is preferable for implementations of this method
  578. to only fetch this row rather than the whole image, since no 2D Readers may be installed and
  579. getMatrix() may never be called.</p>
  580. <code class="phpdocumentor-code phpdocumentor-signature ">
  581. <span class="phpdocumentor-signature__visibility">public</span>
  582. <span class="phpdocumentor-signature__name">getRow</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  583. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  584. <dl class="phpdocumentor-argument-list">
  585. <dt class="phpdocumentor-argument-list__entry">
  586. <span class="phpdocumentor-signature__argument__name">$y</span>
  587. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  588. </dt>
  589. <dd class="phpdocumentor-argument-list__definition">
  590. <section class="phpdocumentor-description"><p>The row to fetch, which must be in [0,getHeight())</p>
  591. </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">inheritDoc</span>
  601. </dt>
  602. <dd class="phpdocumentor-tag-list__definition">
  603. </dd>
  604. </dl>
  605. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  606. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  607. &mdash;
  608. <section class="phpdocumentor-description"><p>An array containing the luminance data.</p>
  609. </section>
  610. </article>
  611. <article
  612. class="phpdocumentor-element
  613. -method
  614. -public
  615. "
  616. >
  617. <h4 class="phpdocumentor-element__name" id="method_getWidth">
  618. getWidth()
  619. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#method_getWidth" 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="src/Decoder/LuminanceSourceAbstract.php"><a href="files/src-decoder-luminancesourceabstract.html"><abbr title="src/Decoder/LuminanceSourceAbstract.php">LuminanceSourceAbstract.php</abbr></a></abbr>
  623. :
  624. <span class="phpdocumentor-element-found-in__line">52</span>
  625. </aside>
  626. <code class="phpdocumentor-code phpdocumentor-signature ">
  627. <span class="phpdocumentor-signature__visibility">public</span>
  628. <span class="phpdocumentor-signature__name">getWidth</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
  629. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  630. Tags
  631. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  632. </h5>
  633. <dl class="phpdocumentor-tag-list">
  634. <dt class="phpdocumentor-tag-list__entry">
  635. <span class="phpdocumentor-tag__name">inheritDoc</span>
  636. </dt>
  637. <dd class="phpdocumentor-tag-list__definition">
  638. </dd>
  639. </dl>
  640. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  641. <span class="phpdocumentor-signature__response_type">int</span>
  642. &mdash;
  643. <section class="phpdocumentor-description"><p>The width of the bitmap.</p>
  644. </section>
  645. </article>
  646. <article
  647. class="phpdocumentor-element
  648. -method
  649. -protected
  650. -static "
  651. >
  652. <h4 class="phpdocumentor-element__name" id="method_checkFile">
  653. checkFile()
  654. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#method_checkFile" class="headerlink"><i class="fas fa-link"></i></a>
  655. </h4>
  656. <aside class="phpdocumentor-element-found-in">
  657. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/LuminanceSourceAbstract.php"><a href="files/src-decoder-luminancesourceabstract.html"><abbr title="src/Decoder/LuminanceSourceAbstract.php">LuminanceSourceAbstract.php</abbr></a></abbr>
  658. :
  659. <span class="phpdocumentor-element-found-in__line">89</span>
  660. </aside>
  661. <code class="phpdocumentor-code phpdocumentor-signature ">
  662. <span class="phpdocumentor-signature__visibility">protected</span>
  663. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">checkFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$path</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  664. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  665. <dl class="phpdocumentor-argument-list">
  666. <dt class="phpdocumentor-argument-list__entry">
  667. <span class="phpdocumentor-signature__argument__name">$path</span>
  668. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  669. </dt>
  670. <dd class="phpdocumentor-argument-list__definition">
  671. <section class="phpdocumentor-description"></section>
  672. </dd>
  673. </dl>
  674. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  675. Tags
  676. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  677. </h5>
  678. <dl class="phpdocumentor-tag-list">
  679. <dt class="phpdocumentor-tag-list__entry">
  680. <span class="phpdocumentor-tag__name">throws</span>
  681. </dt>
  682. <dd class="phpdocumentor-tag-list__definition">
  683. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-QRCodeDecoderException.html"><abbr title="\chillerlan\QRCode\Decoder\QRCodeDecoderException">QRCodeDecoderException</abbr></a></span>
  684. </dd>
  685. </dl>
  686. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  687. <span class="phpdocumentor-signature__response_type">string</span>
  688. &mdash;
  689. </article>
  690. <article
  691. class="phpdocumentor-element
  692. -method
  693. -protected
  694. "
  695. >
  696. <h4 class="phpdocumentor-element__name" id="method_setLuminancePixel">
  697. setLuminancePixel()
  698. <a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceAbstract.html#method_setLuminancePixel" class="headerlink"><i class="fas fa-link"></i></a>
  699. </h4>
  700. <aside class="phpdocumentor-element-found-in">
  701. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/LuminanceSourceAbstract.php"><a href="files/src-decoder-luminancesourceabstract.html"><abbr title="src/Decoder/LuminanceSourceAbstract.php">LuminanceSourceAbstract.php</abbr></a></abbr>
  702. :
  703. <span class="phpdocumentor-element-found-in__line">78</span>
  704. </aside>
  705. <code class="phpdocumentor-code phpdocumentor-signature ">
  706. <span class="phpdocumentor-signature__visibility">protected</span>
  707. <span class="phpdocumentor-signature__name">setLuminancePixel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$r</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">$g</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">$b</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  708. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  709. <dl class="phpdocumentor-argument-list">
  710. <dt class="phpdocumentor-argument-list__entry">
  711. <span class="phpdocumentor-signature__argument__name">$r</span>
  712. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  713. </dt>
  714. <dd class="phpdocumentor-argument-list__definition">
  715. <section class="phpdocumentor-description"></section>
  716. </dd>
  717. <dt class="phpdocumentor-argument-list__entry">
  718. <span class="phpdocumentor-signature__argument__name">$g</span>
  719. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  720. </dt>
  721. <dd class="phpdocumentor-argument-list__definition">
  722. <section class="phpdocumentor-description"></section>
  723. </dd>
  724. <dt class="phpdocumentor-argument-list__entry">
  725. <span class="phpdocumentor-signature__argument__name">$b</span>
  726. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  727. </dt>
  728. <dd class="phpdocumentor-argument-list__definition">
  729. <section class="phpdocumentor-description"></section>
  730. </dd>
  731. </dl>
  732. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  733. <span class="phpdocumentor-signature__response_type">void</span>
  734. &mdash;
  735. </article>
  736. <article
  737. class="phpdocumentor-element
  738. -method
  739. -protected
  740. "
  741. >
  742. <h4 class="phpdocumentor-element__name" id="method_setLuminancePixels">
  743. setLuminancePixels()
  744. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#method_setLuminancePixels" class="headerlink"><i class="fas fa-link"></i></a>
  745. </h4>
  746. <aside class="phpdocumentor-element-found-in">
  747. <abbr class="phpdocumentor-element-found-in__file" title="src/Decoder/IMagickLuminanceSource.php"><a href="files/src-decoder-imagickluminancesource.html"><abbr title="src/Decoder/IMagickLuminanceSource.php">IMagickLuminanceSource.php</abbr></a></abbr>
  748. :
  749. <span class="phpdocumentor-element-found-in__line">42</span>
  750. </aside>
  751. <code class="phpdocumentor-code phpdocumentor-signature ">
  752. <span class="phpdocumentor-signature__visibility">protected</span>
  753. <span class="phpdocumentor-signature__name">setLuminancePixels</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  754. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  755. <span class="phpdocumentor-signature__response_type">void</span>
  756. &mdash;
  757. </article>
  758. </section>
  759. <script type="text/javascript">
  760. function loadExternalCodeSnippets(line) {
  761. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  762. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  763. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  764. var language = 'php';
  765. var code = document.createElement('code');
  766. code.className = 'language-' + language;
  767. pre.textContent = '';
  768. pre.setAttribute('data-line', line)
  769. code.textContent = 'Loading…';
  770. pre.appendChild(code);
  771. var xhr = new XMLHttpRequest();
  772. xhr.open('GET', src, true);
  773. xhr.onreadystatechange = function () {
  774. if (xhr.readyState == 4) {
  775. if (xhr.status < 400 && xhr.responseText) {
  776. code.textContent = xhr.responseText;
  777. Prism.highlightElement(code);
  778. }
  779. else if (xhr.status >= 400) {
  780. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  781. }
  782. else {
  783. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  784. }
  785. }
  786. };
  787. xhr.send(null);
  788. });
  789. }
  790. var modals = document.querySelectorAll("[data-modal]");
  791. modals.forEach(function (trigger) {
  792. trigger.addEventListener("click", function (event) {
  793. //event.preventDefault();
  794. const modal = document.getElementById(trigger.dataset.modal);
  795. modal.classList.add("phpdocumentor-modal__open");
  796. loadExternalCodeSnippets(trigger.dataset.line)
  797. const exits = modal.querySelectorAll("[data-exit-button]");
  798. exits.forEach(function (exit) {
  799. exit.addEventListener("click", function (event) {
  800. event.preventDefault();
  801. modal.classList.remove("phpdocumentor-modal__open");
  802. });
  803. });
  804. });
  805. });
  806. </script>
  807. </article>
  808. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  809. <section class="phpdocumentor-search-results__dialog">
  810. <header class="phpdocumentor-search-results__header">
  811. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  812. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  813. </header>
  814. <section class="phpdocumentor-search-results__body">
  815. <ul class="phpdocumentor-search-results__entries"></ul>
  816. </section>
  817. </section>
  818. </section>
  819. </div>
  820. </div>
  821. <a href="classes/chillerlan-QRCode-Decoder-IMagickLuminanceSource.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  822. </main>
  823. <script>
  824. cssVars({});
  825. </script>
  826. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  827. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  828. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  829. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  830. </body>
  831. </html>