chillerlan-QRCode-Output-QRImagick.html 71 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. QRImagick
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  95. </span>
  96. <div class="phpdocumentor-element__package">
  97. in package
  98. <ul class="phpdocumentor-breadcrumbs">
  99. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  100. </ul>
  101. </div>
  102. </h2>
  103. <aside class="phpdocumentor-element-found-in">
  104. <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>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">27</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">ImageMagick output module (requires ext-imagick)</p>
  109. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  110. Tags
  111. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  112. </h5>
  113. <dl class="phpdocumentor-tag-list">
  114. <dt class="phpdocumentor-tag-list__entry">
  115. <span class="phpdocumentor-tag__name">see</span>
  116. </dt>
  117. <dd class="phpdocumentor-tag-list__definition">
  118. <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>
  119. </dd>
  120. <dt class="phpdocumentor-tag-list__entry">
  121. <span class="phpdocumentor-tag__name">see</span>
  122. </dt>
  123. <dd class="phpdocumentor-tag-list__definition">
  124. <span class="phpdocumentor-tag-link"><a href="http://phpimagick.com"><abbr title="http://phpimagick.com">http://phpimagick.com</abbr></a></span>
  125. </dd>
  126. </dl>
  127. <h3 id="toc">
  128. Table of Contents
  129. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  130. </h3>
  131. <dl class="phpdocumentor-table-of-contents">
  132. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  133. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_background">$background</a>
  134. <span>
  135. &nbsp;: <abbr title="\ImagickPixel">ImagickPixel</abbr> </span>
  136. </dt>
  137. <dd>The allocated background color</dd>
  138. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  139. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick">$imagick</a>
  140. <span>
  141. &nbsp;: <abbr title="\Imagick">Imagick</abbr> </span>
  142. </dt>
  143. <dd>The main image instance</dd>
  144. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  145. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw">$imagickDraw</a>
  146. <span>
  147. &nbsp;: <abbr title="\ImagickDraw">ImagickDraw</abbr> </span>
  148. </dt>
  149. <dd>The main draw instance</dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  151. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  152. <span>
  153. &nbsp;: int </span>
  154. </dt>
  155. <dd>the side length of the QR image (modules * scale)</dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  157. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  158. <span>
  159. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  160. </dt>
  161. <dd>the (filled) data matrix object</dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  163. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  164. <span>
  165. &nbsp;: int </span>
  166. </dt>
  167. <dd>the current size of the QR matrix</dd>
  168. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  170. <span>
  171. &nbsp;: array&lt;string|int, mixed&gt; </span>
  172. </dt>
  173. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  174. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  175. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  176. <span>
  177. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  178. </dt>
  179. <dd></dd>
  180. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  181. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  182. <span>
  183. &nbsp;: int </span>
  184. </dt>
  185. <dd>the current scaling for a QR pixel</dd>
  186. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  187. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct">__construct()</a>
  188. <span>
  189. &nbsp;: mixed </span>
  190. </dt>
  191. <dd>QROutputAbstract constructor.</dd>
  192. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  193. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump">dump()</a>
  194. <span>
  195. &nbsp;: string|<abbr title="\Imagick">Imagick</abbr> </span>
  196. </dt>
  197. <dd></dd>
  198. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  199. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  200. <span>
  201. &nbsp;: bool </span>
  202. </dt>
  203. <dd>note: we&#039;re not necessarily validating the several values, just checking the general syntax</dd>
  204. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  205. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  206. <span>
  207. &nbsp;: array&lt;string|int, mixed&gt; </span>
  208. </dt>
  209. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  210. returns an array with the transformed modules</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  212. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage">drawImage()</a>
  213. <span>
  214. &nbsp;: void </span>
  215. </dt>
  216. <dd>Creates the QR image via ImagickDraw</dd>
  217. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  218. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  219. <span>
  220. &nbsp;: mixed </span>
  221. </dt>
  222. <dd>Returns a default value for either dark or light modules (return value depends on the output module)</dd>
  223. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  224. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getModuleValue">getModuleValue()</a>
  225. <span>
  226. &nbsp;: mixed </span>
  227. </dt>
  228. <dd>Returns the final value for the given input (return value depends on the output module)</dd>
  229. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  230. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  231. <span>
  232. &nbsp;: void </span>
  233. </dt>
  234. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  235. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  236. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setBgColor">setBgColor()</a>
  237. <span>
  238. &nbsp;: void </span>
  239. </dt>
  240. <dd>Sets the background color</dd>
  241. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  242. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  243. <span>
  244. &nbsp;: void </span>
  245. </dt>
  246. <dd>Sets/updates the matrix dimensions</dd>
  247. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  248. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  249. <span>
  250. &nbsp;: void </span>
  251. </dt>
  252. <dd>Sets the initial module values</dd>
  253. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  254. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setPixel">setPixel()</a>
  255. <span>
  256. &nbsp;: void </span>
  257. </dt>
  258. <dd>draws a single pixel at the given position</dd>
  259. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  260. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setTransparencyColor">setTransparencyColor()</a>
  261. <span>
  262. &nbsp;: void </span>
  263. </dt>
  264. <dd>Sets the transparency color</dd>
  265. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  266. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  267. <span>
  268. &nbsp;: string </span>
  269. </dt>
  270. <dd>Returns a base64 data URI for the given string and mime type</dd>
  271. </dl>
  272. <section class="phpdocumentor-properties">
  273. <h3 class="phpdocumentor-elements__header" id="properties">
  274. Properties
  275. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  276. </h3>
  277. <article
  278. class="
  279. phpdocumentor-element
  280. -property
  281. -protected
  282. "
  283. >
  284. <h4 class="phpdocumentor-element__name" id="property_background">
  285. $background
  286. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_background" class="headerlink"><i class="fas fa-link"></i></a>
  287. <span class="phpdocumentor-element__modifiers">
  288. </span>
  289. </h4>
  290. <aside class="phpdocumentor-element-found-in">
  291. <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>
  292. :
  293. <span class="phpdocumentor-element-found-in__line">42</span>
  294. </aside>
  295. <p class="phpdocumentor-summary">The allocated background color</p>
  296. <code class="phpdocumentor-code phpdocumentor-signature ">
  297. <span class="phpdocumentor-signature__visibility">protected</span>
  298. <span class="phpdocumentor-signature__type"><abbr title="\ImagickPixel">ImagickPixel</abbr></span>
  299. <span class="phpdocumentor-signature__name">$background</span>
  300. </code>
  301. <section class="phpdocumentor-description"></section>
  302. </article>
  303. <article
  304. class="
  305. phpdocumentor-element
  306. -property
  307. -protected
  308. "
  309. >
  310. <h4 class="phpdocumentor-element__name" id="property_imagick">
  311. $imagick
  312. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick" class="headerlink"><i class="fas fa-link"></i></a>
  313. <span class="phpdocumentor-element__modifiers">
  314. </span>
  315. </h4>
  316. <aside class="phpdocumentor-element-found-in">
  317. <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>
  318. :
  319. <span class="phpdocumentor-element-found-in__line">32</span>
  320. </aside>
  321. <p class="phpdocumentor-summary">The main image instance</p>
  322. <code class="phpdocumentor-code phpdocumentor-signature ">
  323. <span class="phpdocumentor-signature__visibility">protected</span>
  324. <span class="phpdocumentor-signature__type"><abbr title="\Imagick">Imagick</abbr></span>
  325. <span class="phpdocumentor-signature__name">$imagick</span>
  326. </code>
  327. <section class="phpdocumentor-description"></section>
  328. </article>
  329. <article
  330. class="
  331. phpdocumentor-element
  332. -property
  333. -protected
  334. "
  335. >
  336. <h4 class="phpdocumentor-element__name" id="property_imagickDraw">
  337. $imagickDraw
  338. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw" class="headerlink"><i class="fas fa-link"></i></a>
  339. <span class="phpdocumentor-element__modifiers">
  340. </span>
  341. </h4>
  342. <aside class="phpdocumentor-element-found-in">
  343. <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>
  344. :
  345. <span class="phpdocumentor-element-found-in__line">37</span>
  346. </aside>
  347. <p class="phpdocumentor-summary">The main draw instance</p>
  348. <code class="phpdocumentor-code phpdocumentor-signature ">
  349. <span class="phpdocumentor-signature__visibility">protected</span>
  350. <span class="phpdocumentor-signature__type"><abbr title="\ImagickDraw">ImagickDraw</abbr></span>
  351. <span class="phpdocumentor-signature__name">$imagickDraw</span>
  352. </code>
  353. <section class="phpdocumentor-description"></section>
  354. </article>
  355. <article
  356. class="
  357. phpdocumentor-element
  358. -property
  359. -protected
  360. "
  361. >
  362. <h4 class="phpdocumentor-element__name" id="property_length">
  363. $length
  364. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  365. <span class="phpdocumentor-element__modifiers">
  366. </span>
  367. </h4>
  368. <aside class="phpdocumentor-element-found-in">
  369. <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>
  370. :
  371. <span class="phpdocumentor-element-found-in__line">40</span>
  372. </aside>
  373. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  374. <code class="phpdocumentor-code phpdocumentor-signature ">
  375. <span class="phpdocumentor-signature__visibility">protected</span>
  376. <span class="phpdocumentor-signature__type">int</span>
  377. <span class="phpdocumentor-signature__name">$length</span>
  378. </code>
  379. <section class="phpdocumentor-description"></section>
  380. </article>
  381. <article
  382. class="
  383. phpdocumentor-element
  384. -property
  385. -protected
  386. "
  387. >
  388. <h4 class="phpdocumentor-element__name" id="property_matrix">
  389. $matrix
  390. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  391. <span class="phpdocumentor-element__modifiers">
  392. </span>
  393. </h4>
  394. <aside class="phpdocumentor-element-found-in">
  395. <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>
  396. :
  397. <span class="phpdocumentor-element-found-in__line">50</span>
  398. </aside>
  399. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  400. <code class="phpdocumentor-code phpdocumentor-signature ">
  401. <span class="phpdocumentor-signature__visibility">protected</span>
  402. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  403. <span class="phpdocumentor-signature__name">$matrix</span>
  404. </code>
  405. <section class="phpdocumentor-description"></section>
  406. </article>
  407. <article
  408. class="
  409. phpdocumentor-element
  410. -property
  411. -protected
  412. "
  413. >
  414. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  415. $moduleCount
  416. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  417. <span class="phpdocumentor-element__modifiers">
  418. </span>
  419. </h4>
  420. <aside class="phpdocumentor-element-found-in">
  421. <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>
  422. :
  423. <span class="phpdocumentor-element-found-in__line">28</span>
  424. </aside>
  425. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  426. <code class="phpdocumentor-code phpdocumentor-signature ">
  427. <span class="phpdocumentor-signature__visibility">protected</span>
  428. <span class="phpdocumentor-signature__type">int</span>
  429. <span class="phpdocumentor-signature__name">$moduleCount</span>
  430. </code>
  431. <section class="phpdocumentor-description"></section>
  432. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  433. Tags
  434. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  435. </h5>
  436. <dl class="phpdocumentor-tag-list">
  437. <dt class="phpdocumentor-tag-list__entry">
  438. <span class="phpdocumentor-tag__name">see</span>
  439. </dt>
  440. <dd class="phpdocumentor-tag-list__definition">
  441. <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>
  442. </dd>
  443. </dl>
  444. </article>
  445. <article
  446. class="
  447. phpdocumentor-element
  448. -property
  449. -protected
  450. "
  451. >
  452. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  453. $moduleValues
  454. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  455. <span class="phpdocumentor-element__modifiers">
  456. </span>
  457. </h4>
  458. <aside class="phpdocumentor-element-found-in">
  459. <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>
  460. :
  461. <span class="phpdocumentor-element-found-in__line">45</span>
  462. </aside>
  463. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  464. <code class="phpdocumentor-code phpdocumentor-signature ">
  465. <span class="phpdocumentor-signature__visibility">protected</span>
  466. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  467. <span class="phpdocumentor-signature__name">$moduleValues</span>
  468. </code>
  469. <section class="phpdocumentor-description"></section>
  470. </article>
  471. <article
  472. class="
  473. phpdocumentor-element
  474. -property
  475. -protected
  476. "
  477. >
  478. <h4 class="phpdocumentor-element__name" id="property_options">
  479. $options
  480. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  481. <span class="phpdocumentor-element__modifiers">
  482. </span>
  483. </h4>
  484. <aside class="phpdocumentor-element-found-in">
  485. <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>
  486. :
  487. <span class="phpdocumentor-element-found-in__line">55</span>
  488. </aside>
  489. <code class="phpdocumentor-code phpdocumentor-signature ">
  490. <span class="phpdocumentor-signature__visibility">protected</span>
  491. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  492. <span class="phpdocumentor-signature__name">$options</span>
  493. </code>
  494. </article>
  495. <article
  496. class="
  497. phpdocumentor-element
  498. -property
  499. -protected
  500. "
  501. >
  502. <h4 class="phpdocumentor-element__name" id="property_scale">
  503. $scale
  504. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  505. <span class="phpdocumentor-element__modifiers">
  506. </span>
  507. </h4>
  508. <aside class="phpdocumentor-element-found-in">
  509. <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>
  510. :
  511. <span class="phpdocumentor-element-found-in__line">35</span>
  512. </aside>
  513. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  514. <code class="phpdocumentor-code phpdocumentor-signature ">
  515. <span class="phpdocumentor-signature__visibility">protected</span>
  516. <span class="phpdocumentor-signature__type">int</span>
  517. <span class="phpdocumentor-signature__name">$scale</span>
  518. </code>
  519. <section class="phpdocumentor-description"></section>
  520. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  521. Tags
  522. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  523. </h5>
  524. <dl class="phpdocumentor-tag-list">
  525. <dt class="phpdocumentor-tag-list__entry">
  526. <span class="phpdocumentor-tag__name">see</span>
  527. </dt>
  528. <dd class="phpdocumentor-tag-list__definition">
  529. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  530. </dd>
  531. </dl>
  532. </article>
  533. </section>
  534. <section class="phpdocumentor-methods">
  535. <h3 class="phpdocumentor-elements__header" id="methods">
  536. Methods
  537. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  538. </h3>
  539. <article
  540. class="phpdocumentor-element
  541. -method
  542. -public
  543. "
  544. >
  545. <h4 class="phpdocumentor-element__name" id="method___construct">
  546. __construct()
  547. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  548. </h4>
  549. <aside class="phpdocumentor-element-found-in">
  550. <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>
  551. :
  552. <span class="phpdocumentor-element-found-in__line">49</span>
  553. </aside>
  554. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  555. <code class="phpdocumentor-code phpdocumentor-signature ">
  556. <span class="phpdocumentor-signature__visibility">public</span>
  557. <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>
  558. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  559. <dl class="phpdocumentor-argument-list">
  560. <dt class="phpdocumentor-argument-list__entry">
  561. <span class="phpdocumentor-signature__argument__name">$options</span>
  562. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  563. </dt>
  564. <dd class="phpdocumentor-argument-list__definition">
  565. <section class="phpdocumentor-description"></section>
  566. </dd>
  567. <dt class="phpdocumentor-argument-list__entry">
  568. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  569. : <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>
  570. </dt>
  571. <dd class="phpdocumentor-argument-list__definition">
  572. <section class="phpdocumentor-description"></section>
  573. </dd>
  574. </dl>
  575. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  576. Tags
  577. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  578. </h5>
  579. <dl class="phpdocumentor-tag-list">
  580. <dt class="phpdocumentor-tag-list__entry">
  581. <span class="phpdocumentor-tag__name">inheritDoc</span>
  582. </dt>
  583. <dd class="phpdocumentor-tag-list__definition">
  584. </dd>
  585. <dt class="phpdocumentor-tag-list__entry">
  586. <span class="phpdocumentor-tag__name">throws</span>
  587. </dt>
  588. <dd class="phpdocumentor-tag-list__definition">
  589. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  590. </dd>
  591. </dl>
  592. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  593. <span class="phpdocumentor-signature__response_type">mixed</span>
  594. &mdash;
  595. </article>
  596. <article
  597. class="phpdocumentor-element
  598. -method
  599. -public
  600. "
  601. >
  602. <h4 class="phpdocumentor-element__name" id="method_dump">
  603. dump()
  604. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  605. </h4>
  606. <aside class="phpdocumentor-element-found-in">
  607. <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>
  608. :
  609. <span class="phpdocumentor-element-found-in__line">118</span>
  610. </aside>
  611. <code class="phpdocumentor-code phpdocumentor-signature ">
  612. <span class="phpdocumentor-signature__visibility">public</span>
  613. <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>
  614. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  615. <dl class="phpdocumentor-argument-list">
  616. <dt class="phpdocumentor-argument-list__entry">
  617. <span class="phpdocumentor-signature__argument__name">$file</span>
  618. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  619. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  620. <dd class="phpdocumentor-argument-list__definition">
  621. <section class="phpdocumentor-description"></section>
  622. </dd>
  623. </dl>
  624. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  625. Tags
  626. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  627. </h5>
  628. <dl class="phpdocumentor-tag-list">
  629. <dt class="phpdocumentor-tag-list__entry">
  630. <span class="phpdocumentor-tag__name">inheritDoc</span>
  631. </dt>
  632. <dd class="phpdocumentor-tag-list__definition">
  633. </dd>
  634. </dl>
  635. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  636. <span class="phpdocumentor-signature__response_type">string|<abbr title="\Imagick">Imagick</abbr></span>
  637. &mdash;
  638. </article>
  639. <article
  640. class="phpdocumentor-element
  641. -method
  642. -public
  643. -static "
  644. >
  645. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  646. moduleValueIsValid()
  647. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  648. </h4>
  649. <aside class="phpdocumentor-element-found-in">
  650. <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>
  651. :
  652. <span class="phpdocumentor-element-found-in__line">68</span>
  653. </aside>
  654. <p class="phpdocumentor-summary">note: we&#039;re not necessarily validating the several values, just checking the general syntax</p>
  655. <code class="phpdocumentor-code phpdocumentor-signature ">
  656. <span class="phpdocumentor-signature__visibility">public</span>
  657. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">moduleValueIsValid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  658. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  659. <dl class="phpdocumentor-argument-list">
  660. <dt class="phpdocumentor-argument-list__entry">
  661. <span class="phpdocumentor-signature__argument__name">$value</span>
  662. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  663. </dt>
  664. <dd class="phpdocumentor-argument-list__definition">
  665. <section class="phpdocumentor-description"></section>
  666. </dd>
  667. </dl>
  668. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  669. Tags
  670. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  671. </h5>
  672. <dl class="phpdocumentor-tag-list">
  673. <dt class="phpdocumentor-tag-list__entry">
  674. <span class="phpdocumentor-tag__name">see</span>
  675. </dt>
  676. <dd class="phpdocumentor-tag-list__definition">
  677. <span class="phpdocumentor-tag-link"><a href="https://www.php.net/manual/imagickpixel.construct.php"><abbr title="https://www.php.net/manual/imagickpixel.construct.php">https://www.php.net/manual/imagickpixel.construct.php</abbr></a></span>
  678. </dd>
  679. <dt class="phpdocumentor-tag-list__entry">
  680. <span class="phpdocumentor-tag__name">inheritDoc</span>
  681. </dt>
  682. <dd class="phpdocumentor-tag-list__definition">
  683. </dd>
  684. </dl>
  685. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  686. <span class="phpdocumentor-signature__response_type">bool</span>
  687. &mdash;
  688. </article>
  689. <article
  690. class="phpdocumentor-element
  691. -method
  692. -protected
  693. "
  694. >
  695. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  696. collectModules()
  697. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  698. </h4>
  699. <aside class="phpdocumentor-element-found-in">
  700. <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>
  701. :
  702. <span class="phpdocumentor-element-found-in__line">151</span>
  703. </aside>
  704. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  705. returns an array with the transformed modules</p>
  706. <code class="phpdocumentor-code phpdocumentor-signature ">
  707. <span class="phpdocumentor-signature__visibility">protected</span>
  708. <span class="phpdocumentor-signature__name">collectModules</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$transform</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  709. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  710. <p>$x - current column
  711. $y - current row
  712. $M_TYPE - field value
  713. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  714. </section>
  715. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  716. <dl class="phpdocumentor-argument-list">
  717. <dt class="phpdocumentor-argument-list__entry">
  718. <span class="phpdocumentor-signature__argument__name">$transform</span>
  719. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  720. </dt>
  721. <dd class="phpdocumentor-argument-list__definition">
  722. <section class="phpdocumentor-description"></section>
  723. </dd>
  724. </dl>
  725. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  726. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  727. &mdash;
  728. </article>
  729. <article
  730. class="phpdocumentor-element
  731. -method
  732. -protected
  733. "
  734. >
  735. <h4 class="phpdocumentor-element__name" id="method_drawImage">
  736. drawImage()
  737. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage" class="headerlink"><i class="fas fa-link"></i></a>
  738. </h4>
  739. <aside class="phpdocumentor-element-found-in">
  740. <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>
  741. :
  742. <span class="phpdocumentor-element-found-in__line">185</span>
  743. </aside>
  744. <p class="phpdocumentor-summary">Creates the QR image via ImagickDraw</p>
  745. <code class="phpdocumentor-code phpdocumentor-signature ">
  746. <span class="phpdocumentor-signature__visibility">protected</span>
  747. <span class="phpdocumentor-signature__name">drawImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  748. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  749. <span class="phpdocumentor-signature__response_type">void</span>
  750. &mdash;
  751. </article>
  752. <article
  753. class="phpdocumentor-element
  754. -method
  755. -protected
  756. "
  757. >
  758. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  759. getDefaultModuleValue()
  760. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  761. </h4>
  762. <aside class="phpdocumentor-element-found-in">
  763. <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>
  764. :
  765. <span class="phpdocumentor-element-found-in__line">109</span>
  766. </aside>
  767. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output module)</p>
  768. <code class="phpdocumentor-code phpdocumentor-signature ">
  769. <span class="phpdocumentor-signature__visibility">protected</span>
  770. <span class="phpdocumentor-signature__name">getDefaultModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$isDark</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  771. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  772. <dl class="phpdocumentor-argument-list">
  773. <dt class="phpdocumentor-argument-list__entry">
  774. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  775. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  776. </dt>
  777. <dd class="phpdocumentor-argument-list__definition">
  778. <section class="phpdocumentor-description"></section>
  779. </dd>
  780. </dl>
  781. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  782. Tags
  783. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  784. </h5>
  785. <dl class="phpdocumentor-tag-list">
  786. <dt class="phpdocumentor-tag-list__entry">
  787. <span class="phpdocumentor-tag__name">inheritDoc</span>
  788. </dt>
  789. <dd class="phpdocumentor-tag-list__definition">
  790. </dd>
  791. </dl>
  792. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  793. <span class="phpdocumentor-signature__response_type">mixed</span>
  794. &mdash;
  795. </article>
  796. <article
  797. class="phpdocumentor-element
  798. -method
  799. -protected
  800. "
  801. >
  802. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  803. getModuleValue()
  804. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  805. </h4>
  806. <aside class="phpdocumentor-element-found-in">
  807. <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>
  808. :
  809. <span class="phpdocumentor-element-found-in__line">102</span>
  810. </aside>
  811. <p class="phpdocumentor-summary">Returns the final value for the given input (return value depends on the output module)</p>
  812. <code class="phpdocumentor-code phpdocumentor-signature ">
  813. <span class="phpdocumentor-signature__visibility">protected</span>
  814. <span class="phpdocumentor-signature__name">getModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  815. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  816. <dl class="phpdocumentor-argument-list">
  817. <dt class="phpdocumentor-argument-list__entry">
  818. <span class="phpdocumentor-signature__argument__name">$value</span>
  819. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  820. </dt>
  821. <dd class="phpdocumentor-argument-list__definition">
  822. </dd>
  823. </dl>
  824. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  825. Tags
  826. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  827. </h5>
  828. <dl class="phpdocumentor-tag-list">
  829. <dt class="phpdocumentor-tag-list__entry">
  830. <span class="phpdocumentor-tag__name">inheritDoc</span>
  831. </dt>
  832. <dd class="phpdocumentor-tag-list__definition">
  833. </dd>
  834. <dt class="phpdocumentor-tag-list__entry">
  835. <span class="phpdocumentor-tag__name">throws</span>
  836. </dt>
  837. <dd class="phpdocumentor-tag-list__definition">
  838. <span class="phpdocumentor-tag-link"><abbr title="\ImagickPixelException">ImagickPixelException</abbr></span>
  839. </dd>
  840. </dl>
  841. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  842. <span class="phpdocumentor-signature__response_type">mixed</span>
  843. &mdash;
  844. </article>
  845. <article
  846. class="phpdocumentor-element
  847. -method
  848. -protected
  849. "
  850. >
  851. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  852. saveToFile()
  853. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  854. </h4>
  855. <aside class="phpdocumentor-element-found-in">
  856. <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>
  857. :
  858. <span class="phpdocumentor-element-found-in__line">125</span>
  859. </aside>
  860. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  861. <code class="phpdocumentor-code phpdocumentor-signature ">
  862. <span class="phpdocumentor-signature__visibility">protected</span>
  863. <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>, </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">void</span></code>
  864. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  865. <dl class="phpdocumentor-argument-list">
  866. <dt class="phpdocumentor-argument-list__entry">
  867. <span class="phpdocumentor-signature__argument__name">$data</span>
  868. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  869. </dt>
  870. <dd class="phpdocumentor-argument-list__definition">
  871. <section class="phpdocumentor-description"></section>
  872. </dd>
  873. <dt class="phpdocumentor-argument-list__entry">
  874. <span class="phpdocumentor-signature__argument__name">$file</span>
  875. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  876. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  877. <dd class="phpdocumentor-argument-list__definition">
  878. <section class="phpdocumentor-description"></section>
  879. </dd>
  880. </dl>
  881. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  882. Tags
  883. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  884. </h5>
  885. <dl class="phpdocumentor-tag-list">
  886. <dt class="phpdocumentor-tag-list__entry">
  887. <span class="phpdocumentor-tag__name">see</span>
  888. </dt>
  889. <dd class="phpdocumentor-tag-list__definition">
  890. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  891. </dd>
  892. <dt class="phpdocumentor-tag-list__entry">
  893. <span class="phpdocumentor-tag__name">see</span>
  894. </dt>
  895. <dd class="phpdocumentor-tag-list__definition">
  896. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  897. </dd>
  898. <dt class="phpdocumentor-tag-list__entry">
  899. <span class="phpdocumentor-tag__name">throws</span>
  900. </dt>
  901. <dd class="phpdocumentor-tag-list__definition">
  902. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  903. </dd>
  904. </dl>
  905. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  906. <span class="phpdocumentor-signature__response_type">void</span>
  907. &mdash;
  908. </article>
  909. <article
  910. class="phpdocumentor-element
  911. -method
  912. -protected
  913. "
  914. >
  915. <h4 class="phpdocumentor-element__name" id="method_setBgColor">
  916. setBgColor()
  917. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setBgColor" class="headerlink"><i class="fas fa-link"></i></a>
  918. </h4>
  919. <aside class="phpdocumentor-element-found-in">
  920. <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>
  921. :
  922. <span class="phpdocumentor-element-found-in__line">149</span>
  923. </aside>
  924. <p class="phpdocumentor-summary">Sets the background color</p>
  925. <code class="phpdocumentor-code phpdocumentor-signature ">
  926. <span class="phpdocumentor-signature__visibility">protected</span>
  927. <span class="phpdocumentor-signature__name">setBgColor</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  928. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  929. <span class="phpdocumentor-signature__response_type">void</span>
  930. &mdash;
  931. </article>
  932. <article
  933. class="phpdocumentor-element
  934. -method
  935. -protected
  936. "
  937. >
  938. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  939. setMatrixDimensions()
  940. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  941. </h4>
  942. <aside class="phpdocumentor-element-found-in">
  943. <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>
  944. :
  945. <span class="phpdocumentor-element-found-in__line">73</span>
  946. </aside>
  947. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  948. <code class="phpdocumentor-code phpdocumentor-signature ">
  949. <span class="phpdocumentor-signature__visibility">protected</span>
  950. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  951. <section class="phpdocumentor-description"><p>Call this method if you modify the matrix from within your custom module in case the dimensions have been changed</p>
  952. </section>
  953. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  954. <span class="phpdocumentor-signature__response_type">void</span>
  955. &mdash;
  956. </article>
  957. <article
  958. class="phpdocumentor-element
  959. -method
  960. -protected
  961. "
  962. >
  963. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  964. setModuleValues()
  965. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  966. </h4>
  967. <aside class="phpdocumentor-element-found-in">
  968. <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>
  969. :
  970. <span class="phpdocumentor-element-found-in__line">82</span>
  971. </aside>
  972. <p class="phpdocumentor-summary">Sets the initial module values</p>
  973. <code class="phpdocumentor-code phpdocumentor-signature ">
  974. <span class="phpdocumentor-signature__visibility">protected</span>
  975. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  976. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  977. <span class="phpdocumentor-signature__response_type">void</span>
  978. &mdash;
  979. </article>
  980. <article
  981. class="phpdocumentor-element
  982. -method
  983. -protected
  984. "
  985. >
  986. <h4 class="phpdocumentor-element__name" id="method_setPixel">
  987. setPixel()
  988. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setPixel" class="headerlink"><i class="fas fa-link"></i></a>
  989. </h4>
  990. <aside class="phpdocumentor-element-found-in">
  991. <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>
  992. :
  993. <span class="phpdocumentor-element-found-in__line">201</span>
  994. </aside>
  995. <p class="phpdocumentor-summary">draws a single pixel at the given position</p>
  996. <code class="phpdocumentor-code phpdocumentor-signature ">
  997. <span class="phpdocumentor-signature__visibility">protected</span>
  998. <span class="phpdocumentor-signature__name">setPixel</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>
  999. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1000. <dl class="phpdocumentor-argument-list">
  1001. <dt class="phpdocumentor-argument-list__entry">
  1002. <span class="phpdocumentor-signature__argument__name">$x</span>
  1003. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1004. </dt>
  1005. <dd class="phpdocumentor-argument-list__definition">
  1006. <section class="phpdocumentor-description"></section>
  1007. </dd>
  1008. <dt class="phpdocumentor-argument-list__entry">
  1009. <span class="phpdocumentor-signature__argument__name">$y</span>
  1010. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1011. </dt>
  1012. <dd class="phpdocumentor-argument-list__definition">
  1013. <section class="phpdocumentor-description"></section>
  1014. </dd>
  1015. <dt class="phpdocumentor-argument-list__entry">
  1016. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1017. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1018. </dt>
  1019. <dd class="phpdocumentor-argument-list__definition">
  1020. <section class="phpdocumentor-description"></section>
  1021. </dd>
  1022. </dl>
  1023. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1024. <span class="phpdocumentor-signature__response_type">void</span>
  1025. &mdash;
  1026. </article>
  1027. <article
  1028. class="phpdocumentor-element
  1029. -method
  1030. -protected
  1031. "
  1032. >
  1033. <h4 class="phpdocumentor-element__name" id="method_setTransparencyColor">
  1034. setTransparencyColor()
  1035. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setTransparencyColor" class="headerlink"><i class="fas fa-link"></i></a>
  1036. </h4>
  1037. <aside class="phpdocumentor-element-found-in">
  1038. <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>
  1039. :
  1040. <span class="phpdocumentor-element-found-in__line">167</span>
  1041. </aside>
  1042. <p class="phpdocumentor-summary">Sets the transparency color</p>
  1043. <code class="phpdocumentor-code phpdocumentor-signature ">
  1044. <span class="phpdocumentor-signature__visibility">protected</span>
  1045. <span class="phpdocumentor-signature__name">setTransparencyColor</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1046. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1047. <span class="phpdocumentor-signature__response_type">void</span>
  1048. &mdash;
  1049. </article>
  1050. <article
  1051. class="phpdocumentor-element
  1052. -method
  1053. -protected
  1054. "
  1055. >
  1056. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1057. toBase64DataURI()
  1058. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1059. </h4>
  1060. <aside class="phpdocumentor-element-found-in">
  1061. <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>
  1062. :
  1063. <span class="phpdocumentor-element-found-in__line">113</span>
  1064. </aside>
  1065. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1066. <code class="phpdocumentor-code phpdocumentor-signature ">
  1067. <span class="phpdocumentor-signature__visibility">protected</span>
  1068. <span class="phpdocumentor-signature__name">toBase64DataURI</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>
  1069. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1070. <dl class="phpdocumentor-argument-list">
  1071. <dt class="phpdocumentor-argument-list__entry">
  1072. <span class="phpdocumentor-signature__argument__name">$data</span>
  1073. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1074. </dt>
  1075. <dd class="phpdocumentor-argument-list__definition">
  1076. <section class="phpdocumentor-description"></section>
  1077. </dd>
  1078. <dt class="phpdocumentor-argument-list__entry">
  1079. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1080. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1081. </dt>
  1082. <dd class="phpdocumentor-argument-list__definition">
  1083. <section class="phpdocumentor-description"></section>
  1084. </dd>
  1085. </dl>
  1086. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1087. <span class="phpdocumentor-signature__response_type">string</span>
  1088. &mdash;
  1089. </article>
  1090. </section>
  1091. <script type="text/javascript">
  1092. function loadExternalCodeSnippets(line) {
  1093. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1094. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  1095. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  1096. var language = 'php';
  1097. var code = document.createElement('code');
  1098. code.className = 'language-' + language;
  1099. pre.textContent = '';
  1100. pre.setAttribute('data-line', line)
  1101. code.textContent = 'Loading…';
  1102. pre.appendChild(code);
  1103. var xhr = new XMLHttpRequest();
  1104. xhr.open('GET', src, true);
  1105. xhr.onreadystatechange = function () {
  1106. if (xhr.readyState == 4) {
  1107. if (xhr.status < 400 && xhr.responseText) {
  1108. code.textContent = xhr.responseText;
  1109. Prism.highlightElement(code);
  1110. }
  1111. else if (xhr.status >= 400) {
  1112. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1113. }
  1114. else {
  1115. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  1116. }
  1117. }
  1118. };
  1119. xhr.send(null);
  1120. });
  1121. }
  1122. var modals = document.querySelectorAll("[data-modal]");
  1123. modals.forEach(function (trigger) {
  1124. trigger.addEventListener("click", function (event) {
  1125. //event.preventDefault();
  1126. const modal = document.getElementById(trigger.dataset.modal);
  1127. modal.classList.add("phpdocumentor-modal__open");
  1128. loadExternalCodeSnippets(trigger.dataset.line)
  1129. const exits = modal.querySelectorAll("[data-exit-button]");
  1130. exits.forEach(function (exit) {
  1131. exit.addEventListener("click", function (event) {
  1132. event.preventDefault();
  1133. modal.classList.remove("phpdocumentor-modal__open");
  1134. });
  1135. });
  1136. });
  1137. });
  1138. </script>
  1139. </article>
  1140. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1141. <section class="phpdocumentor-search-results__dialog">
  1142. <header class="phpdocumentor-search-results__header">
  1143. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1144. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1145. </header>
  1146. <section class="phpdocumentor-search-results__body">
  1147. <ul class="phpdocumentor-search-results__entries"></ul>
  1148. </section>
  1149. </section>
  1150. </section>
  1151. </div>
  1152. </div>
  1153. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1154. </main>
  1155. <script>
  1156. cssVars({});
  1157. </script>
  1158. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1159. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1160. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1161. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1162. </body>
  1163. </html>