chillerlan-QRCode-Output-QRImagick.html 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170
  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-output.html">Output</a></li>
  85. </ul>
  86. <article class="phpdocumentor-element -class">
  87. <h2 class="phpdocumentor-content__title">
  88. QRImagick
  89. <span class="phpdocumentor-element__extends">
  90. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</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/Output/QRImagick.php"><a href="files/src-output-qrimagick.html"><abbr title="src/Output/QRImagick.php">QRImagick.php</abbr></a></abbr>
  101. :
  102. <span class="phpdocumentor-element-found-in__line">27</span>
  103. </aside>
  104. <p class="phpdocumentor-summary">ImageMagick output module (requires ext-imagick)</p>
  105. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  106. Tags
  107. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  108. </h5>
  109. <dl class="phpdocumentor-tag-list">
  110. <dt class="phpdocumentor-tag-list__entry">
  111. <span class="phpdocumentor-tag__name">see</span>
  112. </dt>
  113. <dd class="phpdocumentor-tag-list__definition">
  114. <span class="phpdocumentor-tag-link"><a href="http://php.net/manual/book.imagick.php"><abbr title="http://php.net/manual/book.imagick.php">http://php.net/manual/book.imagick.php</abbr></a></span>
  115. </dd>
  116. <dt class="phpdocumentor-tag-list__entry">
  117. <span class="phpdocumentor-tag__name">see</span>
  118. </dt>
  119. <dd class="phpdocumentor-tag-list__definition">
  120. <span class="phpdocumentor-tag-link"><a href="http://phpimagick.com"><abbr title="http://phpimagick.com">http://phpimagick.com</abbr></a></span>
  121. </dd>
  122. </dl>
  123. <h3 id="toc">
  124. Table of Contents
  125. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  126. </h3>
  127. <dl class="phpdocumentor-table-of-contents">
  128. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  129. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_defaultMode">$defaultMode</a>
  130. <span>
  131. &nbsp;: string </span>
  132. </dt>
  133. <dd>the default output mode of the current output module</dd>
  134. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  135. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick">$imagick</a>
  136. <span>
  137. &nbsp;: <abbr title="\Imagick">Imagick</abbr> </span>
  138. </dt>
  139. <dd></dd>
  140. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  141. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw">$imagickDraw</a>
  142. <span>
  143. &nbsp;: <abbr title="\ImagickDraw">ImagickDraw</abbr> </span>
  144. </dt>
  145. <dd></dd>
  146. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  147. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  148. <span>
  149. &nbsp;: int </span>
  150. </dt>
  151. <dd>the side length of the QR image (modules * scale)</dd>
  152. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  153. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  154. <span>
  155. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  156. </dt>
  157. <dd>the (filled) data matrix object</dd>
  158. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  159. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  160. <span>
  161. &nbsp;: int </span>
  162. </dt>
  163. <dd>the current size of the QR matrix</dd>
  164. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  165. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  166. <span>
  167. &nbsp;: array&lt;string|int, mixed&gt; </span>
  168. </dt>
  169. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  170. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  171. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  172. <span>
  173. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  174. </dt>
  175. <dd></dd>
  176. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  177. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_outputMode">$outputMode</a>
  178. <span>
  179. &nbsp;: string </span>
  180. </dt>
  181. <dd>the current output mode</dd>
  182. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  183. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  184. <span>
  185. &nbsp;: int </span>
  186. </dt>
  187. <dd>the current scaling for a QR pixel</dd>
  188. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  189. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct">__construct()</a>
  190. <span>
  191. &nbsp;: mixed </span>
  192. </dt>
  193. <dd>QROutputAbstract constructor.</dd>
  194. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  195. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump">dump()</a>
  196. <span>
  197. &nbsp;: string|<abbr title="\Imagick">Imagick</abbr> </span>
  198. </dt>
  199. <dd>generates the output, optionally dumps it to a file, and returns it</dd>
  200. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  201. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode">base64encode()</a>
  202. <span>
  203. &nbsp;: string </span>
  204. </dt>
  205. <dd>Returns a base64 data URI for the given string and mime type</dd>
  206. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  207. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage">drawImage()</a>
  208. <span>
  209. &nbsp;: void </span>
  210. </dt>
  211. <dd>Creates the QR image via ImagickDraw</dd>
  212. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  213. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawPixel">drawPixel()</a>
  214. <span>
  215. &nbsp;: void </span>
  216. </dt>
  217. <dd>draws a single pixel at the given position</dd>
  218. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  219. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  220. <span>
  221. &nbsp;: bool </span>
  222. </dt>
  223. <dd>saves the qr data to a file</dd>
  224. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  225. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setModuleValues">setModuleValues()</a>
  226. <span>
  227. &nbsp;: void </span>
  228. </dt>
  229. <dd>Sets the initial module values (clean-up &amp; defaults)</dd>
  230. </dl>
  231. <section class="phpdocumentor-properties">
  232. <h3 class="phpdocumentor-elements__header" id="properties">
  233. Properties
  234. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  235. </h3>
  236. <article
  237. class="
  238. phpdocumentor-element
  239. -property
  240. -protected
  241. "
  242. >
  243. <h4 class="phpdocumentor-element__name" id="property_defaultMode">
  244. $defaultMode
  245. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_defaultMode" class="headerlink"><i class="fas fa-link"></i></a>
  246. <span class="phpdocumentor-element__modifiers">
  247. </span>
  248. </h4>
  249. <aside class="phpdocumentor-element-found-in">
  250. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  251. :
  252. <span class="phpdocumentor-element-found-in__line">39</span>
  253. </aside>
  254. <p class="phpdocumentor-summary">the default output mode of the current output module</p>
  255. <code class="phpdocumentor-code phpdocumentor-signature ">
  256. <span class="phpdocumentor-signature__visibility">protected</span>
  257. <span class="phpdocumentor-signature__type">string</span>
  258. <span class="phpdocumentor-signature__name">$defaultMode</span>
  259. </code>
  260. <section class="phpdocumentor-description"></section>
  261. </article>
  262. <article
  263. class="
  264. phpdocumentor-element
  265. -property
  266. -protected
  267. "
  268. >
  269. <h4 class="phpdocumentor-element__name" id="property_imagick">
  270. $imagick
  271. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick" class="headerlink"><i class="fas fa-link"></i></a>
  272. <span class="phpdocumentor-element__modifiers">
  273. </span>
  274. </h4>
  275. <aside class="phpdocumentor-element-found-in">
  276. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRImagick.php"><a href="files/src-output-qrimagick.html"><abbr title="src/Output/QRImagick.php">QRImagick.php</abbr></a></abbr>
  277. :
  278. <span class="phpdocumentor-element-found-in__line">29</span>
  279. </aside>
  280. <code class="phpdocumentor-code phpdocumentor-signature ">
  281. <span class="phpdocumentor-signature__visibility">protected</span>
  282. <span class="phpdocumentor-signature__type"><abbr title="\Imagick">Imagick</abbr></span>
  283. <span class="phpdocumentor-signature__name">$imagick</span>
  284. </code>
  285. <section class="phpdocumentor-description"></section>
  286. <section class="phpdocumentor-description"></section>
  287. </article>
  288. <article
  289. class="
  290. phpdocumentor-element
  291. -property
  292. -protected
  293. "
  294. >
  295. <h4 class="phpdocumentor-element__name" id="property_imagickDraw">
  296. $imagickDraw
  297. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw" class="headerlink"><i class="fas fa-link"></i></a>
  298. <span class="phpdocumentor-element__modifiers">
  299. </span>
  300. </h4>
  301. <aside class="phpdocumentor-element-found-in">
  302. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRImagick.php"><a href="files/src-output-qrimagick.html"><abbr title="src/Output/QRImagick.php">QRImagick.php</abbr></a></abbr>
  303. :
  304. <span class="phpdocumentor-element-found-in__line">30</span>
  305. </aside>
  306. <code class="phpdocumentor-code phpdocumentor-signature ">
  307. <span class="phpdocumentor-signature__visibility">protected</span>
  308. <span class="phpdocumentor-signature__type"><abbr title="\ImagickDraw">ImagickDraw</abbr></span>
  309. <span class="phpdocumentor-signature__name">$imagickDraw</span>
  310. </code>
  311. <section class="phpdocumentor-description"></section>
  312. <section class="phpdocumentor-description"></section>
  313. </article>
  314. <article
  315. class="
  316. phpdocumentor-element
  317. -property
  318. -protected
  319. "
  320. >
  321. <h4 class="phpdocumentor-element__name" id="property_length">
  322. $length
  323. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" 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/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  329. :
  330. <span class="phpdocumentor-element-found-in__line">51</span>
  331. </aside>
  332. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  333. <code class="phpdocumentor-code phpdocumentor-signature ">
  334. <span class="phpdocumentor-signature__visibility">protected</span>
  335. <span class="phpdocumentor-signature__type">int</span>
  336. <span class="phpdocumentor-signature__name">$length</span>
  337. </code>
  338. <section class="phpdocumentor-description"></section>
  339. </article>
  340. <article
  341. class="
  342. phpdocumentor-element
  343. -property
  344. -protected
  345. "
  346. >
  347. <h4 class="phpdocumentor-element__name" id="property_matrix">
  348. $matrix
  349. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  350. <span class="phpdocumentor-element__modifiers">
  351. </span>
  352. </h4>
  353. <aside class="phpdocumentor-element-found-in">
  354. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  355. :
  356. <span class="phpdocumentor-element-found-in__line">61</span>
  357. </aside>
  358. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  359. <code class="phpdocumentor-code phpdocumentor-signature ">
  360. <span class="phpdocumentor-signature__visibility">protected</span>
  361. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  362. <span class="phpdocumentor-signature__name">$matrix</span>
  363. </code>
  364. <section class="phpdocumentor-description"></section>
  365. </article>
  366. <article
  367. class="
  368. phpdocumentor-element
  369. -property
  370. -protected
  371. "
  372. >
  373. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  374. $moduleCount
  375. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" 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/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  381. :
  382. <span class="phpdocumentor-element-found-in__line">27</span>
  383. </aside>
  384. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  385. <code class="phpdocumentor-code phpdocumentor-signature ">
  386. <span class="phpdocumentor-signature__visibility">protected</span>
  387. <span class="phpdocumentor-signature__type">int</span>
  388. <span class="phpdocumentor-signature__name">$moduleCount</span>
  389. </code>
  390. <section class="phpdocumentor-description"></section>
  391. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  392. Tags
  393. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  394. </h5>
  395. <dl class="phpdocumentor-tag-list">
  396. <dt class="phpdocumentor-tag-list__entry">
  397. <span class="phpdocumentor-tag__name">see</span>
  398. </dt>
  399. <dd class="phpdocumentor-tag-list__definition">
  400. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size"><abbr title="\chillerlan\QRCode\Data\QRMatrix::size()">QRMatrix::size()</abbr></a></span>
  401. </dd>
  402. </dl>
  403. </article>
  404. <article
  405. class="
  406. phpdocumentor-element
  407. -property
  408. -protected
  409. "
  410. >
  411. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  412. $moduleValues
  413. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  414. <span class="phpdocumentor-element__modifiers">
  415. </span>
  416. </h4>
  417. <aside class="phpdocumentor-element-found-in">
  418. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  419. :
  420. <span class="phpdocumentor-element-found-in__line">56</span>
  421. </aside>
  422. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  423. <code class="phpdocumentor-code phpdocumentor-signature ">
  424. <span class="phpdocumentor-signature__visibility">protected</span>
  425. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  426. <span class="phpdocumentor-signature__name">$moduleValues</span>
  427. </code>
  428. <section class="phpdocumentor-description"></section>
  429. </article>
  430. <article
  431. class="
  432. phpdocumentor-element
  433. -property
  434. -protected
  435. "
  436. >
  437. <h4 class="phpdocumentor-element__name" id="property_options">
  438. $options
  439. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  440. <span class="phpdocumentor-element__modifiers">
  441. </span>
  442. </h4>
  443. <aside class="phpdocumentor-element-found-in">
  444. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  445. :
  446. <span class="phpdocumentor-element-found-in__line">66</span>
  447. </aside>
  448. <code class="phpdocumentor-code phpdocumentor-signature ">
  449. <span class="phpdocumentor-signature__visibility">protected</span>
  450. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  451. <span class="phpdocumentor-signature__name">$options</span>
  452. </code>
  453. </article>
  454. <article
  455. class="
  456. phpdocumentor-element
  457. -property
  458. -protected
  459. "
  460. >
  461. <h4 class="phpdocumentor-element__name" id="property_outputMode">
  462. $outputMode
  463. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_outputMode" class="headerlink"><i class="fas fa-link"></i></a>
  464. <span class="phpdocumentor-element__modifiers">
  465. </span>
  466. </h4>
  467. <aside class="phpdocumentor-element-found-in">
  468. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  469. :
  470. <span class="phpdocumentor-element-found-in__line">34</span>
  471. </aside>
  472. <p class="phpdocumentor-summary">the current output mode</p>
  473. <code class="phpdocumentor-code phpdocumentor-signature ">
  474. <span class="phpdocumentor-signature__visibility">protected</span>
  475. <span class="phpdocumentor-signature__type">string</span>
  476. <span class="phpdocumentor-signature__name">$outputMode</span>
  477. </code>
  478. <section class="phpdocumentor-description"></section>
  479. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  480. Tags
  481. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  482. </h5>
  483. <dl class="phpdocumentor-tag-list">
  484. <dt class="phpdocumentor-tag-list__entry">
  485. <span class="phpdocumentor-tag__name">see</span>
  486. </dt>
  487. <dd class="phpdocumentor-tag-list__definition">
  488. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$outputType">QROptions::$outputType</abbr></span>
  489. </dd>
  490. </dl>
  491. </article>
  492. <article
  493. class="
  494. phpdocumentor-element
  495. -property
  496. -protected
  497. "
  498. >
  499. <h4 class="phpdocumentor-element__name" id="property_scale">
  500. $scale
  501. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  502. <span class="phpdocumentor-element__modifiers">
  503. </span>
  504. </h4>
  505. <aside class="phpdocumentor-element-found-in">
  506. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  507. :
  508. <span class="phpdocumentor-element-found-in__line">46</span>
  509. </aside>
  510. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  511. <code class="phpdocumentor-code phpdocumentor-signature ">
  512. <span class="phpdocumentor-signature__visibility">protected</span>
  513. <span class="phpdocumentor-signature__type">int</span>
  514. <span class="phpdocumentor-signature__name">$scale</span>
  515. </code>
  516. <section class="phpdocumentor-description"></section>
  517. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  518. Tags
  519. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  520. </h5>
  521. <dl class="phpdocumentor-tag-list">
  522. <dt class="phpdocumentor-tag-list__entry">
  523. <span class="phpdocumentor-tag__name">see</span>
  524. </dt>
  525. <dd class="phpdocumentor-tag-list__definition">
  526. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  527. </dd>
  528. </dl>
  529. </article>
  530. </section>
  531. <section class="phpdocumentor-methods">
  532. <h3 class="phpdocumentor-elements__header" id="methods">
  533. Methods
  534. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  535. </h3>
  536. <article
  537. class="phpdocumentor-element
  538. -method
  539. -public
  540. "
  541. >
  542. <h4 class="phpdocumentor-element__name" id="method___construct">
  543. __construct()
  544. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  545. </h4>
  546. <aside class="phpdocumentor-element-found-in">
  547. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRImagick.php"><a href="files/src-output-qrimagick.html"><abbr title="src/Output/QRImagick.php">QRImagick.php</abbr></a></abbr>
  548. :
  549. <span class="phpdocumentor-element-found-in__line">37</span>
  550. </aside>
  551. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  552. <code class="phpdocumentor-code phpdocumentor-signature ">
  553. <span class="phpdocumentor-signature__visibility">public</span>
  554. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><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 class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  555. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  556. <dl class="phpdocumentor-argument-list">
  557. <dt class="phpdocumentor-argument-list__entry">
  558. <span class="phpdocumentor-signature__argument__name">$options</span>
  559. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  560. </dt>
  561. <dd class="phpdocumentor-argument-list__definition">
  562. <section class="phpdocumentor-description"></section>
  563. </dd>
  564. <dt class="phpdocumentor-argument-list__entry">
  565. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  566. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  567. </dt>
  568. <dd class="phpdocumentor-argument-list__definition">
  569. <section class="phpdocumentor-description"></section>
  570. </dd>
  571. </dl>
  572. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  573. Tags
  574. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  575. </h5>
  576. <dl class="phpdocumentor-tag-list">
  577. <dt class="phpdocumentor-tag-list__entry">
  578. <span class="phpdocumentor-tag__name">inheritDoc</span>
  579. </dt>
  580. <dd class="phpdocumentor-tag-list__definition">
  581. </dd>
  582. <dt class="phpdocumentor-tag-list__entry">
  583. <span class="phpdocumentor-tag__name">throws</span>
  584. </dt>
  585. <dd class="phpdocumentor-tag-list__definition">
  586. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  587. </dd>
  588. </dl>
  589. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  590. <span class="phpdocumentor-signature__response_type">mixed</span>
  591. &mdash;
  592. </article>
  593. <article
  594. class="phpdocumentor-element
  595. -method
  596. -public
  597. "
  598. >
  599. <h4 class="phpdocumentor-element__name" id="method_dump">
  600. dump()
  601. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  602. </h4>
  603. <aside class="phpdocumentor-element-found-in">
  604. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRImagick.php"><a href="files/src-output-qrimagick.html"><abbr title="src/Output/QRImagick.php">QRImagick.php</abbr></a></abbr>
  605. :
  606. <span class="phpdocumentor-element-found-in__line">70</span>
  607. </aside>
  608. <p class="phpdocumentor-summary">generates the output, optionally dumps it to a file, and returns it</p>
  609. <code class="phpdocumentor-code phpdocumentor-signature ">
  610. <span class="phpdocumentor-signature__visibility">public</span>
  611. <span class="phpdocumentor-signature__name">dump</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</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">string|<abbr title="\Imagick">Imagick</abbr></span></code>
  612. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  613. <dl class="phpdocumentor-argument-list">
  614. <dt class="phpdocumentor-argument-list__entry">
  615. <span class="phpdocumentor-signature__argument__name">$file</span>
  616. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  617. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  618. <dd class="phpdocumentor-argument-list__definition">
  619. <section class="phpdocumentor-description"></section>
  620. </dd>
  621. </dl>
  622. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  623. Tags
  624. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  625. </h5>
  626. <dl class="phpdocumentor-tag-list">
  627. <dt class="phpdocumentor-tag-list__entry">
  628. <span class="phpdocumentor-tag__name">inheritDoc</span>
  629. </dt>
  630. <dd class="phpdocumentor-tag-list__definition">
  631. </dd>
  632. </dl>
  633. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  634. <span class="phpdocumentor-signature__response_type">string|<abbr title="\Imagick">Imagick</abbr></span>
  635. &mdash;
  636. </article>
  637. <article
  638. class="phpdocumentor-element
  639. -method
  640. -protected
  641. "
  642. >
  643. <h4 class="phpdocumentor-element__name" id="method_base64encode">
  644. base64encode()
  645. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode" class="headerlink"><i class="fas fa-link"></i></a>
  646. </h4>
  647. <aside class="phpdocumentor-element-found-in">
  648. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  649. :
  650. <span class="phpdocumentor-element-found-in__line">94</span>
  651. </aside>
  652. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  653. <code class="phpdocumentor-code phpdocumentor-signature ">
  654. <span class="phpdocumentor-signature__visibility">protected</span>
  655. <span class="phpdocumentor-signature__name">base64encode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  656. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  657. <dl class="phpdocumentor-argument-list">
  658. <dt class="phpdocumentor-argument-list__entry">
  659. <span class="phpdocumentor-signature__argument__name">$data</span>
  660. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  661. </dt>
  662. <dd class="phpdocumentor-argument-list__definition">
  663. <section class="phpdocumentor-description"></section>
  664. </dd>
  665. <dt class="phpdocumentor-argument-list__entry">
  666. <span class="phpdocumentor-signature__argument__name">$mime</span>
  667. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  668. </dt>
  669. <dd class="phpdocumentor-argument-list__definition">
  670. <section class="phpdocumentor-description"></section>
  671. </dd>
  672. </dl>
  673. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  674. <span class="phpdocumentor-signature__response_type">string</span>
  675. &mdash;
  676. </article>
  677. <article
  678. class="phpdocumentor-element
  679. -method
  680. -protected
  681. "
  682. >
  683. <h4 class="phpdocumentor-element__name" id="method_drawImage">
  684. drawImage()
  685. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage" class="headerlink"><i class="fas fa-link"></i></a>
  686. </h4>
  687. <aside class="phpdocumentor-element-found-in">
  688. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRImagick.php"><a href="files/src-output-qrimagick.html"><abbr title="src/Output/QRImagick.php">QRImagick.php</abbr></a></abbr>
  689. :
  690. <span class="phpdocumentor-element-found-in__line">101</span>
  691. </aside>
  692. <p class="phpdocumentor-summary">Creates the QR image via ImagickDraw</p>
  693. <code class="phpdocumentor-code phpdocumentor-signature ">
  694. <span class="phpdocumentor-signature__visibility">protected</span>
  695. <span class="phpdocumentor-signature__name">drawImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  696. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  697. <span class="phpdocumentor-signature__response_type">void</span>
  698. &mdash;
  699. </article>
  700. <article
  701. class="phpdocumentor-element
  702. -method
  703. -protected
  704. "
  705. >
  706. <h4 class="phpdocumentor-element__name" id="method_drawPixel">
  707. drawPixel()
  708. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawPixel" class="headerlink"><i class="fas fa-link"></i></a>
  709. </h4>
  710. <aside class="phpdocumentor-element-found-in">
  711. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRImagick.php"><a href="files/src-output-qrimagick.html"><abbr title="src/Output/QRImagick.php">QRImagick.php</abbr></a></abbr>
  712. :
  713. <span class="phpdocumentor-element-found-in__line">116</span>
  714. </aside>
  715. <p class="phpdocumentor-summary">draws a single pixel at the given position</p>
  716. <code class="phpdocumentor-code phpdocumentor-signature ">
  717. <span class="phpdocumentor-signature__visibility">protected</span>
  718. <span class="phpdocumentor-signature__name">drawPixel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</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">$y</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">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  719. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  720. <dl class="phpdocumentor-argument-list">
  721. <dt class="phpdocumentor-argument-list__entry">
  722. <span class="phpdocumentor-signature__argument__name">$x</span>
  723. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  724. </dt>
  725. <dd class="phpdocumentor-argument-list__definition">
  726. <section class="phpdocumentor-description"></section>
  727. </dd>
  728. <dt class="phpdocumentor-argument-list__entry">
  729. <span class="phpdocumentor-signature__argument__name">$y</span>
  730. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  731. </dt>
  732. <dd class="phpdocumentor-argument-list__definition">
  733. <section class="phpdocumentor-description"></section>
  734. </dd>
  735. <dt class="phpdocumentor-argument-list__entry">
  736. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  737. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  738. </dt>
  739. <dd class="phpdocumentor-argument-list__definition">
  740. <section class="phpdocumentor-description"></section>
  741. </dd>
  742. </dl>
  743. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  744. <span class="phpdocumentor-signature__response_type">void</span>
  745. &mdash;
  746. </article>
  747. <article
  748. class="phpdocumentor-element
  749. -method
  750. -protected
  751. "
  752. >
  753. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  754. saveToFile()
  755. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  756. </h4>
  757. <aside class="phpdocumentor-element-found-in">
  758. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  759. :
  760. <span class="phpdocumentor-element-found-in__line">106</span>
  761. </aside>
  762. <p class="phpdocumentor-summary">saves the qr data to a file</p>
  763. <code class="phpdocumentor-code phpdocumentor-signature ">
  764. <span class="phpdocumentor-signature__visibility">protected</span>
  765. <span class="phpdocumentor-signature__name">saveToFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  766. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  767. <dl class="phpdocumentor-argument-list">
  768. <dt class="phpdocumentor-argument-list__entry">
  769. <span class="phpdocumentor-signature__argument__name">$data</span>
  770. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  771. </dt>
  772. <dd class="phpdocumentor-argument-list__definition">
  773. <section class="phpdocumentor-description"></section>
  774. </dd>
  775. <dt class="phpdocumentor-argument-list__entry">
  776. <span class="phpdocumentor-signature__argument__name">$file</span>
  777. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  778. </dt>
  779. <dd class="phpdocumentor-argument-list__definition">
  780. <section class="phpdocumentor-description"></section>
  781. </dd>
  782. </dl>
  783. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  784. Tags
  785. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  786. </h5>
  787. <dl class="phpdocumentor-tag-list">
  788. <dt class="phpdocumentor-tag-list__entry">
  789. <span class="phpdocumentor-tag__name">see</span>
  790. </dt>
  791. <dd class="phpdocumentor-tag-list__definition">
  792. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  793. </dd>
  794. <dt class="phpdocumentor-tag-list__entry">
  795. <span class="phpdocumentor-tag__name">see</span>
  796. </dt>
  797. <dd class="phpdocumentor-tag-list__definition">
  798. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::cachefile">QROptions::cachefile</abbr></span>
  799. </dd>
  800. <dt class="phpdocumentor-tag-list__entry">
  801. <span class="phpdocumentor-tag__name">throws</span>
  802. </dt>
  803. <dd class="phpdocumentor-tag-list__definition">
  804. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  805. </dd>
  806. </dl>
  807. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  808. <span class="phpdocumentor-signature__response_type">bool</span>
  809. &mdash;
  810. </article>
  811. <article
  812. class="phpdocumentor-element
  813. -method
  814. -protected
  815. "
  816. >
  817. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  818. setModuleValues()
  819. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  820. </h4>
  821. <aside class="phpdocumentor-element-found-in">
  822. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRImagick.php"><a href="files/src-output-qrimagick.html"><abbr title="src/Output/QRImagick.php">QRImagick.php</abbr></a></abbr>
  823. :
  824. <span class="phpdocumentor-element-found-in__line">49</span>
  825. </aside>
  826. <p class="phpdocumentor-summary">Sets the initial module values (clean-up &amp; defaults)</p>
  827. <code class="phpdocumentor-code phpdocumentor-signature ">
  828. <span class="phpdocumentor-signature__visibility">protected</span>
  829. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  830. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  831. Tags
  832. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  833. </h5>
  834. <dl class="phpdocumentor-tag-list">
  835. <dt class="phpdocumentor-tag-list__entry">
  836. <span class="phpdocumentor-tag__name">inheritDoc</span>
  837. </dt>
  838. <dd class="phpdocumentor-tag-list__definition">
  839. </dd>
  840. </dl>
  841. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  842. <span class="phpdocumentor-signature__response_type">void</span>
  843. &mdash;
  844. </article>
  845. </section>
  846. <script type="text/javascript">
  847. function loadExternalCodeSnippets(line) {
  848. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  849. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  850. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  851. var language = 'php';
  852. var code = document.createElement('code');
  853. code.className = 'language-' + language;
  854. pre.textContent = '';
  855. pre.setAttribute('data-line', line)
  856. code.textContent = 'Loading…';
  857. pre.appendChild(code);
  858. var xhr = new XMLHttpRequest();
  859. xhr.open('GET', src, true);
  860. xhr.onreadystatechange = function () {
  861. if (xhr.readyState == 4) {
  862. if (xhr.status < 400 && xhr.responseText) {
  863. code.textContent = xhr.responseText;
  864. Prism.highlightElement(code);
  865. }
  866. else if (xhr.status >= 400) {
  867. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  868. }
  869. else {
  870. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  871. }
  872. }
  873. };
  874. xhr.send(null);
  875. });
  876. }
  877. var modals = document.querySelectorAll("[data-modal]");
  878. modals.forEach(function (trigger) {
  879. trigger.addEventListener("click", function (event) {
  880. //event.preventDefault();
  881. const modal = document.getElementById(trigger.dataset.modal);
  882. modal.classList.add("phpdocumentor-modal__open");
  883. loadExternalCodeSnippets(trigger.dataset.line)
  884. const exits = modal.querySelectorAll("[data-exit-button]");
  885. exits.forEach(function (exit) {
  886. exit.addEventListener("click", function (event) {
  887. event.preventDefault();
  888. modal.classList.remove("phpdocumentor-modal__open");
  889. });
  890. });
  891. });
  892. });
  893. </script>
  894. </article>
  895. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  896. <section class="phpdocumentor-search-results__dialog">
  897. <header class="phpdocumentor-search-results__header">
  898. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  899. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  900. </header>
  901. <section class="phpdocumentor-search-results__body">
  902. <ul class="phpdocumentor-search-results__entries"></ul>
  903. </section>
  904. </section>
  905. </section>
  906. </div>
  907. </div>
  908. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  909. </main>
  910. <script>
  911. cssVars({});
  912. </script>
  913. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  914. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  915. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  916. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  917. </body>
  918. </html>