chillerlan-QRCode-Output-QRImagick.html 111 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. </ul>
  59. </nav>
  60. </header>
  61. <main class="phpdocumentor">
  62. <div class="phpdocumentor-section">
  63. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  64. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  65. Menu
  66. </label>
  67. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  68. <section class="phpdocumentor-sidebar__category">
  69. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  70. <h4 class="phpdocumentor-sidebar__root-namespace">
  71. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  72. </h4>
  73. <ul class="phpdocumentor-list">
  74. <li>
  75. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  76. </li>
  77. <li>
  78. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  79. </li>
  80. </ul>
  81. <h4 class="phpdocumentor-sidebar__root-namespace">
  82. <a href="namespaces/output.html" class="">Output</a>
  83. </h4>
  84. </section>
  85. <section class="phpdocumentor-sidebar__category">
  86. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  87. <h4 class="phpdocumentor-sidebar__root-namespace">
  88. <a href="packages/Application.html" class="">Application</a>
  89. </h4>
  90. </section>
  91. <section class="phpdocumentor-sidebar__category">
  92. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  93. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  94. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  95. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  96. </section>
  97. <section class="phpdocumentor-sidebar__category">
  98. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  99. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  100. </section>
  101. </aside>
  102. <div class="phpdocumentor-column -nine phpdocumentor-content">
  103. <section>
  104. <ul class="phpdocumentor-breadcrumbs">
  105. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  106. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  107. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  108. </ul>
  109. <article class="phpdocumentor-element -class">
  110. <h2 class="phpdocumentor-content__title">
  111. QRImagick
  112. <span class="phpdocumentor-element__extends">
  113. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  114. </span>
  115. <div class="phpdocumentor-element__package">
  116. in package
  117. <ul class="phpdocumentor-breadcrumbs">
  118. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  119. </ul>
  120. </div>
  121. </h2>
  122. <div class="phpdocumentor-label-line">
  123. </div>
  124. <aside class="phpdocumentor-element-found-in">
  125. <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>
  126. :
  127. <span class="phpdocumentor-element-found-in__line">28</span>
  128. </aside>
  129. <p class="phpdocumentor-summary">ImageMagick output module (requires ext-imagick)</p>
  130. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  131. Tags
  132. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  133. </h5>
  134. <dl class="phpdocumentor-tag-list">
  135. <dt class="phpdocumentor-tag-list__entry">
  136. <span class="phpdocumentor-tag__name">see</span>
  137. </dt>
  138. <dd class="phpdocumentor-tag-list__definition">
  139. <span class="phpdocumentor-tag-link"><a href="https://php.net/manual/book.imagick.php">https://php.net/manual/book.imagick.php</a></span>
  140. </dd>
  141. <dt class="phpdocumentor-tag-list__entry">
  142. <span class="phpdocumentor-tag__name">see</span>
  143. </dt>
  144. <dd class="phpdocumentor-tag-list__definition">
  145. <span class="phpdocumentor-tag-link"><a href="https://phpimagick.com">https://phpimagick.com</a></span>
  146. </dd>
  147. </dl>
  148. <h3 id="toc">
  149. Table of Contents
  150. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  151. </h3>
  152. <h4 id="toc-properties">
  153. Properties
  154. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  155. </h4>
  156. <dl class="phpdocumentor-table-of-contents">
  157. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  158. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_backgroundColor">$backgroundColor</a>
  159. <span>
  160. &nbsp;: <abbr title="\ImagickPixel">ImagickPixel</abbr> </span>
  161. </dt>
  162. <dd>The allocated background color</dd>
  163. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  164. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter</a>
  165. <span>
  166. &nbsp;: float </span>
  167. </dt>
  168. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius</a>
  170. <span>
  171. &nbsp;: float </span>
  172. </dt>
  173. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  174. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths</a>
  175. <span>
  176. &nbsp;: bool </span>
  177. </dt>
  178. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  179. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules</a>
  180. <span>
  181. &nbsp;: bool </span>
  182. </dt>
  183. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  184. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules</a>
  185. <span>
  186. &nbsp;: bool </span>
  187. </dt>
  188. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  189. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol</a>
  190. <span>
  191. &nbsp;: string </span>
  192. </dt>
  193. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  194. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect</a>
  195. <span>
  196. &nbsp;: array&lt;string|int, mixed&gt; </span>
  197. </dt>
  198. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  199. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick">$imagick</a>
  200. <span>
  201. &nbsp;: <abbr title="\Imagick">Imagick</abbr> </span>
  202. </dt>
  203. <dd>The main image instance</dd>
  204. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  205. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw">$imagickDraw</a>
  206. <span>
  207. &nbsp;: <abbr title="\ImagickDraw">ImagickDraw</abbr> </span>
  208. </dt>
  209. <dd>The main draw instance</dd>
  210. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  211. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare</a>
  212. <span>
  213. &nbsp;: array&lt;string|int, mixed&gt; </span>
  214. </dt>
  215. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  216. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  217. <span>
  218. &nbsp;: int </span>
  219. </dt>
  220. <dd>the side length of the QR image (modules * scale)</dd>
  221. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  222. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  223. <span>
  224. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  225. </dt>
  226. <dd>the (filled) data matrix object</dd>
  227. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  228. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  229. <span>
  230. &nbsp;: int </span>
  231. </dt>
  232. <dd>the current size of the QR matrix</dd>
  233. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  234. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  235. <span>
  236. &nbsp;: array&lt;string|int, mixed&gt; </span>
  237. </dt>
  238. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  239. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  240. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  241. <span>
  242. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  243. </dt>
  244. <dd>the options instance</dd>
  245. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  246. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  247. <span>
  248. &nbsp;: int </span>
  249. </dt>
  250. </dl>
  251. <h4 id="toc-methods">
  252. Methods
  253. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  254. </h4>
  255. <dl class="phpdocumentor-table-of-contents">
  256. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  257. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct">__construct()</a>
  258. <span>
  259. &nbsp;: mixed </span>
  260. </dt>
  261. <dd>QROutputAbstract constructor.</dd>
  262. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  263. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump">dump()</a>
  264. <span>
  265. &nbsp;: string|<abbr title="\Imagick">Imagick</abbr> </span>
  266. </dt>
  267. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  268. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  269. <span>
  270. &nbsp;: bool </span>
  271. </dt>
  272. <dd>note: we&#039;re not necessarily validating the several values, just checking the general syntax</dd>
  273. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  274. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  275. <span>
  276. &nbsp;: array&lt;string|int, mixed&gt; </span>
  277. </dt>
  278. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  279. returns an array with the transformed modules</dd>
  280. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  281. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a>
  282. <span>
  283. &nbsp;: void </span>
  284. </dt>
  285. <dd>Creates copies of several QROptions values to avoid calling the magic getters
  286. in long loops for a significant performance increase.</dd>
  287. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  288. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_createImage">createImage()</a>
  289. <span>
  290. &nbsp;: <abbr title="\Imagick">Imagick</abbr> </span>
  291. </dt>
  292. <dd>Creates a new Imagick instance</dd>
  293. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  294. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage">drawImage()</a>
  295. <span>
  296. &nbsp;: void </span>
  297. </dt>
  298. <dd>Creates the QR image via ImagickDraw</dd>
  299. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  300. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  301. <span>
  302. &nbsp;: <abbr title="\ImagickPixel">ImagickPixel</abbr> </span>
  303. </dt>
  304. <dd>Returns a default value for either dark or light modules (return value depends on the output class)</dd>
  305. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  306. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  307. <span>
  308. &nbsp;: mixed </span>
  309. </dt>
  310. <dd>Returns the prepared value for the given $M_TYPE</dd>
  311. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  312. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  313. <span>
  314. &nbsp;: mixed </span>
  315. </dt>
  316. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  317. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  318. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a>
  319. <span>
  320. &nbsp;: array&lt;string|int, mixed&gt; </span>
  321. </dt>
  322. <dd>Returns a 2 element array with the current output width and height</dd>
  323. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  324. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_module">module()</a>
  325. <span>
  326. &nbsp;: void </span>
  327. </dt>
  328. <dd>draws a single pixel at the given position</dd>
  329. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  330. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_prepareModuleValue">prepareModuleValue()</a>
  331. <span>
  332. &nbsp;: <abbr title="\ImagickPixel">ImagickPixel</abbr> </span>
  333. </dt>
  334. <dd>Prepares the value for the given input (return value depends on the output class)</dd>
  335. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  336. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  337. <span>
  338. &nbsp;: void </span>
  339. </dt>
  340. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  341. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  342. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setBgColor">setBgColor()</a>
  343. <span>
  344. &nbsp;: void </span>
  345. </dt>
  346. <dd>Sets the background color</dd>
  347. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  348. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  349. <span>
  350. &nbsp;: void </span>
  351. </dt>
  352. <dd>Sets/updates the matrix dimensions</dd>
  353. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  354. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  355. <span>
  356. &nbsp;: void </span>
  357. </dt>
  358. <dd>Sets the initial module values</dd>
  359. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  360. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setTransparencyColor">setTransparencyColor()</a>
  361. <span>
  362. &nbsp;: void </span>
  363. </dt>
  364. <dd>Sets the transparency color</dd>
  365. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  366. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  367. <span>
  368. &nbsp;: string </span>
  369. </dt>
  370. <dd>Returns a base64 data URI for the given string and mime type</dd>
  371. </dl>
  372. <section class="phpdocumentor-properties">
  373. <h3 class="phpdocumentor-elements__header" id="properties">
  374. Properties
  375. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  376. </h3>
  377. <article
  378. class="
  379. phpdocumentor-element
  380. -property
  381. -protected
  382. "
  383. >
  384. <h4 class="phpdocumentor-element__name" id="property_backgroundColor">
  385. $backgroundColor
  386. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_backgroundColor" class="headerlink"><i class="fas fa-link"></i></a>
  387. <span class="phpdocumentor-element__modifiers">
  388. </span>
  389. </h4>
  390. <aside class="phpdocumentor-element-found-in">
  391. <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>
  392. :
  393. <span class="phpdocumentor-element-found-in__line">43</span>
  394. </aside>
  395. <p class="phpdocumentor-summary">The allocated background color</p>
  396. <code class="phpdocumentor-code phpdocumentor-signature ">
  397. <span class="phpdocumentor-signature__visibility">protected</span>
  398. <span class="phpdocumentor-signature__type"><abbr title="\ImagickPixel">ImagickPixel</abbr></span>
  399. <span class="phpdocumentor-signature__name">$backgroundColor</span>
  400. </code>
  401. </article>
  402. <article
  403. class="
  404. phpdocumentor-element
  405. -property
  406. -protected
  407. "
  408. >
  409. <h4 class="phpdocumentor-element__name" id="property_circleDiameter">
  410. $circleDiameter
  411. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter" class="headerlink"><i class="fas fa-link"></i></a>
  412. <span class="phpdocumentor-element__modifiers">
  413. </span>
  414. </h4>
  415. <aside class="phpdocumentor-element-found-in">
  416. <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>
  417. :
  418. <span class="phpdocumentor-element-found-in__line">67</span>
  419. </aside>
  420. <code class="phpdocumentor-code phpdocumentor-signature ">
  421. <span class="phpdocumentor-signature__visibility">protected</span>
  422. <span class="phpdocumentor-signature__type">float</span>
  423. <span class="phpdocumentor-signature__name">$circleDiameter</span>
  424. </code>
  425. </article>
  426. <article
  427. class="
  428. phpdocumentor-element
  429. -property
  430. -protected
  431. "
  432. >
  433. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  434. $circleRadius
  435. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  436. <span class="phpdocumentor-element__modifiers">
  437. </span>
  438. </h4>
  439. <aside class="phpdocumentor-element-found-in">
  440. <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>
  441. :
  442. <span class="phpdocumentor-element-found-in__line">66</span>
  443. </aside>
  444. <code class="phpdocumentor-code phpdocumentor-signature ">
  445. <span class="phpdocumentor-signature__visibility">protected</span>
  446. <span class="phpdocumentor-signature__type">float</span>
  447. <span class="phpdocumentor-signature__name">$circleRadius</span>
  448. </code>
  449. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  450. Tags
  451. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius#tags" class="headerlink"><i class="fas fa-link"></i></a>
  452. </h5>
  453. <dl class="phpdocumentor-tag-list">
  454. <dt class="phpdocumentor-tag-list__entry">
  455. <span class="phpdocumentor-tag__name">see</span>
  456. </dt>
  457. <dd class="phpdocumentor-tag-list__definition">
  458. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$circleRadius">QROptions::$circleRadius</abbr></span>
  459. </dd>
  460. </dl>
  461. </article>
  462. <article
  463. class="
  464. phpdocumentor-element
  465. -property
  466. -protected
  467. "
  468. >
  469. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  470. $connectPaths
  471. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  472. <span class="phpdocumentor-element__modifiers">
  473. </span>
  474. </h4>
  475. <aside class="phpdocumentor-element-found-in">
  476. <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>
  477. :
  478. <span class="phpdocumentor-element-found-in__line">54</span>
  479. </aside>
  480. <code class="phpdocumentor-code phpdocumentor-signature ">
  481. <span class="phpdocumentor-signature__visibility">protected</span>
  482. <span class="phpdocumentor-signature__type">bool</span>
  483. <span class="phpdocumentor-signature__name">$connectPaths</span>
  484. </code>
  485. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  486. Tags
  487. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  488. </h5>
  489. <dl class="phpdocumentor-tag-list">
  490. <dt class="phpdocumentor-tag-list__entry">
  491. <span class="phpdocumentor-tag__name">see</span>
  492. </dt>
  493. <dd class="phpdocumentor-tag-list__definition">
  494. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$connectPaths">QROptions::$connectPaths</abbr></span>
  495. </dd>
  496. </dl>
  497. </article>
  498. <article
  499. class="
  500. phpdocumentor-element
  501. -property
  502. -protected
  503. "
  504. >
  505. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  506. $drawCircularModules
  507. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  508. <span class="phpdocumentor-element__modifiers">
  509. </span>
  510. </h4>
  511. <aside class="phpdocumentor-element-found-in">
  512. <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>
  513. :
  514. <span class="phpdocumentor-element-found-in__line">62</span>
  515. </aside>
  516. <code class="phpdocumentor-code phpdocumentor-signature ">
  517. <span class="phpdocumentor-signature__visibility">protected</span>
  518. <span class="phpdocumentor-signature__type">bool</span>
  519. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  520. </code>
  521. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  522. Tags
  523. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  524. </h5>
  525. <dl class="phpdocumentor-tag-list">
  526. <dt class="phpdocumentor-tag-list__entry">
  527. <span class="phpdocumentor-tag__name">see</span>
  528. </dt>
  529. <dd class="phpdocumentor-tag-list__definition">
  530. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawCircularModules">QROptions::$drawCircularModules</abbr></span>
  531. </dd>
  532. </dl>
  533. </article>
  534. <article
  535. class="
  536. phpdocumentor-element
  537. -property
  538. -protected
  539. "
  540. >
  541. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  542. $drawLightModules
  543. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  544. <span class="phpdocumentor-element__modifiers">
  545. </span>
  546. </h4>
  547. <aside class="phpdocumentor-element-found-in">
  548. <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>
  549. :
  550. <span class="phpdocumentor-element-found-in__line">60</span>
  551. </aside>
  552. <code class="phpdocumentor-code phpdocumentor-signature ">
  553. <span class="phpdocumentor-signature__visibility">protected</span>
  554. <span class="phpdocumentor-signature__type">bool</span>
  555. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  556. </code>
  557. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  558. Tags
  559. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  560. </h5>
  561. <dl class="phpdocumentor-tag-list">
  562. <dt class="phpdocumentor-tag-list__entry">
  563. <span class="phpdocumentor-tag__name">see</span>
  564. </dt>
  565. <dd class="phpdocumentor-tag-list__definition">
  566. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawLightModules">QROptions::$drawLightModules</abbr></span>
  567. </dd>
  568. </dl>
  569. </article>
  570. <article
  571. class="
  572. phpdocumentor-element
  573. -property
  574. -protected
  575. "
  576. >
  577. <h4 class="phpdocumentor-element__name" id="property_eol">
  578. $eol
  579. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  580. <span class="phpdocumentor-element__modifiers">
  581. </span>
  582. </h4>
  583. <aside class="phpdocumentor-element-found-in">
  584. <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>
  585. :
  586. <span class="phpdocumentor-element-found-in__line">58</span>
  587. </aside>
  588. <code class="phpdocumentor-code phpdocumentor-signature ">
  589. <span class="phpdocumentor-signature__visibility">protected</span>
  590. <span class="phpdocumentor-signature__type">string</span>
  591. <span class="phpdocumentor-signature__name">$eol</span>
  592. </code>
  593. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  594. Tags
  595. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol#tags" class="headerlink"><i class="fas fa-link"></i></a>
  596. </h5>
  597. <dl class="phpdocumentor-tag-list">
  598. <dt class="phpdocumentor-tag-list__entry">
  599. <span class="phpdocumentor-tag__name">see</span>
  600. </dt>
  601. <dd class="phpdocumentor-tag-list__definition">
  602. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$eol">QROptions::$eol</abbr></span>
  603. </dd>
  604. </dl>
  605. </article>
  606. <article
  607. class="
  608. phpdocumentor-element
  609. -property
  610. -protected
  611. "
  612. >
  613. <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
  614. $excludeFromConnect
  615. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  616. <span class="phpdocumentor-element__modifiers">
  617. </span>
  618. </h4>
  619. <aside class="phpdocumentor-element-found-in">
  620. <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>
  621. :
  622. <span class="phpdocumentor-element-found-in__line">56</span>
  623. </aside>
  624. <code class="phpdocumentor-code phpdocumentor-signature ">
  625. <span class="phpdocumentor-signature__visibility">protected</span>
  626. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  627. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  628. </code>
  629. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  630. Tags
  631. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect#tags" class="headerlink"><i class="fas fa-link"></i></a>
  632. </h5>
  633. <dl class="phpdocumentor-tag-list">
  634. <dt class="phpdocumentor-tag-list__entry">
  635. <span class="phpdocumentor-tag__name">see</span>
  636. </dt>
  637. <dd class="phpdocumentor-tag-list__definition">
  638. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$excludeFromConnect">QROptions::$excludeFromConnect</abbr></span>
  639. </dd>
  640. </dl>
  641. </article>
  642. <article
  643. class="
  644. phpdocumentor-element
  645. -property
  646. -protected
  647. "
  648. >
  649. <h4 class="phpdocumentor-element__name" id="property_imagick">
  650. $imagick
  651. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick" class="headerlink"><i class="fas fa-link"></i></a>
  652. <span class="phpdocumentor-element__modifiers">
  653. </span>
  654. </h4>
  655. <aside class="phpdocumentor-element-found-in">
  656. <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>
  657. :
  658. <span class="phpdocumentor-element-found-in__line">33</span>
  659. </aside>
  660. <p class="phpdocumentor-summary">The main image instance</p>
  661. <code class="phpdocumentor-code phpdocumentor-signature ">
  662. <span class="phpdocumentor-signature__visibility">protected</span>
  663. <span class="phpdocumentor-signature__type"><abbr title="\Imagick">Imagick</abbr></span>
  664. <span class="phpdocumentor-signature__name">$imagick</span>
  665. </code>
  666. </article>
  667. <article
  668. class="
  669. phpdocumentor-element
  670. -property
  671. -protected
  672. "
  673. >
  674. <h4 class="phpdocumentor-element__name" id="property_imagickDraw">
  675. $imagickDraw
  676. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw" class="headerlink"><i class="fas fa-link"></i></a>
  677. <span class="phpdocumentor-element__modifiers">
  678. </span>
  679. </h4>
  680. <aside class="phpdocumentor-element-found-in">
  681. <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>
  682. :
  683. <span class="phpdocumentor-element-found-in__line">38</span>
  684. </aside>
  685. <p class="phpdocumentor-summary">The main draw instance</p>
  686. <code class="phpdocumentor-code phpdocumentor-signature ">
  687. <span class="phpdocumentor-signature__visibility">protected</span>
  688. <span class="phpdocumentor-signature__type"><abbr title="\ImagickDraw">ImagickDraw</abbr></span>
  689. <span class="phpdocumentor-signature__name">$imagickDraw</span>
  690. </code>
  691. </article>
  692. <article
  693. class="
  694. phpdocumentor-element
  695. -property
  696. -protected
  697. "
  698. >
  699. <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
  700. $keepAsSquare
  701. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  702. <span class="phpdocumentor-element__modifiers">
  703. </span>
  704. </h4>
  705. <aside class="phpdocumentor-element-found-in">
  706. <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>
  707. :
  708. <span class="phpdocumentor-element-found-in__line">64</span>
  709. </aside>
  710. <code class="phpdocumentor-code phpdocumentor-signature ">
  711. <span class="phpdocumentor-signature__visibility">protected</span>
  712. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  713. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  714. </code>
  715. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  716. Tags
  717. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare#tags" class="headerlink"><i class="fas fa-link"></i></a>
  718. </h5>
  719. <dl class="phpdocumentor-tag-list">
  720. <dt class="phpdocumentor-tag-list__entry">
  721. <span class="phpdocumentor-tag__name">see</span>
  722. </dt>
  723. <dd class="phpdocumentor-tag-list__definition">
  724. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$keepAsSquare">QROptions::$keepAsSquare</abbr></span>
  725. </dd>
  726. </dl>
  727. </article>
  728. <article
  729. class="
  730. phpdocumentor-element
  731. -property
  732. -protected
  733. "
  734. >
  735. <h4 class="phpdocumentor-element__name" id="property_length">
  736. $length
  737. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  738. <span class="phpdocumentor-element__modifiers">
  739. </span>
  740. </h4>
  741. <aside class="phpdocumentor-element-found-in">
  742. <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>
  743. :
  744. <span class="phpdocumentor-element-found-in__line">34</span>
  745. </aside>
  746. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  747. <code class="phpdocumentor-code phpdocumentor-signature ">
  748. <span class="phpdocumentor-signature__visibility">protected</span>
  749. <span class="phpdocumentor-signature__type">int</span>
  750. <span class="phpdocumentor-signature__name">$length</span>
  751. </code>
  752. </article>
  753. <article
  754. class="
  755. phpdocumentor-element
  756. -property
  757. -protected
  758. "
  759. >
  760. <h4 class="phpdocumentor-element__name" id="property_matrix">
  761. $matrix
  762. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  763. <span class="phpdocumentor-element__modifiers">
  764. </span>
  765. </h4>
  766. <aside class="phpdocumentor-element-found-in">
  767. <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>
  768. :
  769. <span class="phpdocumentor-element-found-in__line">44</span>
  770. </aside>
  771. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  772. <code class="phpdocumentor-code phpdocumentor-signature ">
  773. <span class="phpdocumentor-signature__visibility">protected</span>
  774. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  775. <span class="phpdocumentor-signature__name">$matrix</span>
  776. </code>
  777. </article>
  778. <article
  779. class="
  780. phpdocumentor-element
  781. -property
  782. -protected
  783. "
  784. >
  785. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  786. $moduleCount
  787. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  788. <span class="phpdocumentor-element__modifiers">
  789. </span>
  790. </h4>
  791. <aside class="phpdocumentor-element-found-in">
  792. <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>
  793. :
  794. <span class="phpdocumentor-element-found-in__line">29</span>
  795. </aside>
  796. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  797. <code class="phpdocumentor-code phpdocumentor-signature ">
  798. <span class="phpdocumentor-signature__visibility">protected</span>
  799. <span class="phpdocumentor-signature__type">int</span>
  800. <span class="phpdocumentor-signature__name">$moduleCount</span>
  801. </code>
  802. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  803. Tags
  804. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  805. </h5>
  806. <dl class="phpdocumentor-tag-list">
  807. <dt class="phpdocumentor-tag-list__entry">
  808. <span class="phpdocumentor-tag__name">see</span>
  809. </dt>
  810. <dd class="phpdocumentor-tag-list__definition">
  811. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getSize()">QRMatrix::getSize()</abbr></a></span>
  812. </dd>
  813. </dl>
  814. </article>
  815. <article
  816. class="
  817. phpdocumentor-element
  818. -property
  819. -protected
  820. "
  821. >
  822. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  823. $moduleValues
  824. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  825. <span class="phpdocumentor-element__modifiers">
  826. </span>
  827. </h4>
  828. <aside class="phpdocumentor-element-found-in">
  829. <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>
  830. :
  831. <span class="phpdocumentor-element-found-in__line">39</span>
  832. </aside>
  833. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  834. <code class="phpdocumentor-code phpdocumentor-signature ">
  835. <span class="phpdocumentor-signature__visibility">protected</span>
  836. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  837. <span class="phpdocumentor-signature__name">$moduleValues</span>
  838. </code>
  839. </article>
  840. <article
  841. class="
  842. phpdocumentor-element
  843. -property
  844. -protected
  845. "
  846. >
  847. <h4 class="phpdocumentor-element__name" id="property_options">
  848. $options
  849. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  850. <span class="phpdocumentor-element__modifiers">
  851. </span>
  852. </h4>
  853. <aside class="phpdocumentor-element-found-in">
  854. <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>
  855. :
  856. <span class="phpdocumentor-element-found-in__line">49</span>
  857. </aside>
  858. <p class="phpdocumentor-summary">the options instance</p>
  859. <code class="phpdocumentor-code phpdocumentor-signature ">
  860. <span class="phpdocumentor-signature__visibility">protected</span>
  861. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  862. <span class="phpdocumentor-signature__name">$options</span>
  863. </code>
  864. </article>
  865. <article
  866. class="
  867. phpdocumentor-element
  868. -property
  869. -protected
  870. "
  871. >
  872. <h4 class="phpdocumentor-element__name" id="property_scale">
  873. $scale
  874. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  875. <span class="phpdocumentor-element__modifiers">
  876. </span>
  877. </h4>
  878. <aside class="phpdocumentor-element-found-in">
  879. <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>
  880. :
  881. <span class="phpdocumentor-element-found-in__line">52</span>
  882. </aside>
  883. <code class="phpdocumentor-code phpdocumentor-signature ">
  884. <span class="phpdocumentor-signature__visibility">protected</span>
  885. <span class="phpdocumentor-signature__type">int</span>
  886. <span class="phpdocumentor-signature__name">$scale</span>
  887. </code>
  888. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  889. Tags
  890. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  891. </h5>
  892. <dl class="phpdocumentor-tag-list">
  893. <dt class="phpdocumentor-tag-list__entry">
  894. <span class="phpdocumentor-tag__name">see</span>
  895. </dt>
  896. <dd class="phpdocumentor-tag-list__definition">
  897. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  898. </dd>
  899. </dl>
  900. </article>
  901. </section>
  902. <section class="phpdocumentor-methods">
  903. <h3 class="phpdocumentor-elements__header" id="methods">
  904. Methods
  905. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  906. </h3>
  907. <article
  908. class="phpdocumentor-element
  909. -method
  910. -public
  911. "
  912. >
  913. <h4 class="phpdocumentor-element__name" id="method___construct">
  914. __construct()
  915. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  916. </h4>
  917. <aside class="phpdocumentor-element-found-in">
  918. <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>
  919. :
  920. <span class="phpdocumentor-element-found-in__line">50</span>
  921. </aside>
  922. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  923. <code class="phpdocumentor-code phpdocumentor-signature ">
  924. <span class="phpdocumentor-signature__visibility">public</span>
  925. <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>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a>&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>
  926. <div class="phpdocumentor-label-line">
  927. </div>
  928. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  929. <dl class="phpdocumentor-argument-list">
  930. <dt class="phpdocumentor-argument-list__entry">
  931. <span class="phpdocumentor-signature__argument__name">$options</span>
  932. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  933. </dt>
  934. <dd class="phpdocumentor-argument-list__definition">
  935. </dd>
  936. <dt class="phpdocumentor-argument-list__entry">
  937. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  938. : <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>
  939. </dt>
  940. <dd class="phpdocumentor-argument-list__definition">
  941. </dd>
  942. </dl>
  943. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  944. Tags
  945. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
  946. </h5>
  947. <dl class="phpdocumentor-tag-list">
  948. <dt class="phpdocumentor-tag-list__entry">
  949. <span class="phpdocumentor-tag__name">inheritDoc</span>
  950. </dt>
  951. <dd class="phpdocumentor-tag-list__definition">
  952. </dd>
  953. <dt class="phpdocumentor-tag-list__entry">
  954. <span class="phpdocumentor-tag__name">throws</span>
  955. </dt>
  956. <dd class="phpdocumentor-tag-list__definition">
  957. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  958. </dd>
  959. </dl>
  960. </article>
  961. <article
  962. class="phpdocumentor-element
  963. -method
  964. -public
  965. "
  966. >
  967. <h4 class="phpdocumentor-element__name" id="method_dump">
  968. dump()
  969. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  970. </h4>
  971. <aside class="phpdocumentor-element-found-in">
  972. <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>
  973. :
  974. <span class="phpdocumentor-element-found-in__line">114</span>
  975. </aside>
  976. <code class="phpdocumentor-code phpdocumentor-signature ">
  977. <span class="phpdocumentor-signature__visibility">public</span>
  978. <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>
  979. <div class="phpdocumentor-label-line">
  980. </div>
  981. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  982. <dl class="phpdocumentor-argument-list">
  983. <dt class="phpdocumentor-argument-list__entry">
  984. <span class="phpdocumentor-signature__argument__name">$file</span>
  985. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  986. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  987. <dd class="phpdocumentor-argument-list__definition">
  988. </dd>
  989. </dl>
  990. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  991. Tags
  992. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  993. </h5>
  994. <dl class="phpdocumentor-tag-list">
  995. <dt class="phpdocumentor-tag-list__entry">
  996. <span class="phpdocumentor-tag__name">inheritDoc</span>
  997. </dt>
  998. <dd class="phpdocumentor-tag-list__definition">
  999. </dd>
  1000. </dl>
  1001. <section>
  1002. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1003. <span class="phpdocumentor-signature__response_type">string|<abbr title="\Imagick">Imagick</abbr></span>
  1004. </section>
  1005. </article>
  1006. <article
  1007. class="phpdocumentor-element
  1008. -method
  1009. -public
  1010. -static "
  1011. >
  1012. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  1013. moduleValueIsValid()
  1014. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  1015. </h4>
  1016. <aside class="phpdocumentor-element-found-in">
  1017. <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>
  1018. :
  1019. <span class="phpdocumentor-element-found-in__line">67</span>
  1020. </aside>
  1021. <p class="phpdocumentor-summary">note: we&#039;re not necessarily validating the several values, just checking the general syntax</p>
  1022. <code class="phpdocumentor-code phpdocumentor-signature ">
  1023. <span class="phpdocumentor-signature__visibility">public</span>
  1024. <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>
  1025. <div class="phpdocumentor-label-line">
  1026. </div>
  1027. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1028. <dl class="phpdocumentor-argument-list">
  1029. <dt class="phpdocumentor-argument-list__entry">
  1030. <span class="phpdocumentor-signature__argument__name">$value</span>
  1031. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1032. </dt>
  1033. <dd class="phpdocumentor-argument-list__definition">
  1034. </dd>
  1035. </dl>
  1036. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1037. Tags
  1038. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1039. </h5>
  1040. <dl class="phpdocumentor-tag-list">
  1041. <dt class="phpdocumentor-tag-list__entry">
  1042. <span class="phpdocumentor-tag__name">see</span>
  1043. </dt>
  1044. <dd class="phpdocumentor-tag-list__definition">
  1045. <span class="phpdocumentor-tag-link"><a href="https://www.php.net/manual/imagickpixel.construct.php">https://www.php.net/manual/imagickpixel.construct.php</a></span>
  1046. </dd>
  1047. <dt class="phpdocumentor-tag-list__entry">
  1048. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1049. </dt>
  1050. <dd class="phpdocumentor-tag-list__definition">
  1051. </dd>
  1052. </dl>
  1053. <section>
  1054. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1055. <span class="phpdocumentor-signature__response_type">bool</span>
  1056. </section>
  1057. </article>
  1058. <article
  1059. class="phpdocumentor-element
  1060. -method
  1061. -protected
  1062. "
  1063. >
  1064. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  1065. collectModules()
  1066. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  1067. </h4>
  1068. <aside class="phpdocumentor-element-found-in">
  1069. <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>
  1070. :
  1071. <span class="phpdocumentor-element-found-in__line">221</span>
  1072. </aside>
  1073. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  1074. returns an array with the transformed modules</p>
  1075. <code class="phpdocumentor-code phpdocumentor-signature ">
  1076. <span class="phpdocumentor-signature__visibility">protected</span>
  1077. <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>
  1078. <div class="phpdocumentor-label-line">
  1079. </div>
  1080. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  1081. <p>$x - current column
  1082. $y - current row
  1083. $M_TYPE - field value
  1084. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  1085. </section>
  1086. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1087. <dl class="phpdocumentor-argument-list">
  1088. <dt class="phpdocumentor-argument-list__entry">
  1089. <span class="phpdocumentor-signature__argument__name">$transform</span>
  1090. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  1091. </dt>
  1092. <dd class="phpdocumentor-argument-list__definition">
  1093. </dd>
  1094. </dl>
  1095. <section>
  1096. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1097. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1098. </section>
  1099. </article>
  1100. <article
  1101. class="phpdocumentor-element
  1102. -method
  1103. -protected
  1104. "
  1105. >
  1106. <h4 class="phpdocumentor-element__name" id="method_copyVars">
  1107. copyVars()
  1108. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars" class="headerlink"><i class="fas fa-link"></i></a>
  1109. </h4>
  1110. <aside class="phpdocumentor-element-found-in">
  1111. <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>
  1112. :
  1113. <span class="phpdocumentor-element-found-in__line">91</span>
  1114. </aside>
  1115. <p class="phpdocumentor-summary">Creates copies of several QROptions values to avoid calling the magic getters
  1116. in long loops for a significant performance increase.</p>
  1117. <code class="phpdocumentor-code phpdocumentor-signature ">
  1118. <span class="phpdocumentor-signature__visibility">protected</span>
  1119. <span class="phpdocumentor-signature__name">copyVars</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1120. <div class="phpdocumentor-label-line">
  1121. </div>
  1122. <section class="phpdocumentor-description"><p>These variables are usually used in the &quot;module&quot; methods and are called up to 31329 times (at version 40).</p>
  1123. </section>
  1124. </article>
  1125. <article
  1126. class="phpdocumentor-element
  1127. -method
  1128. -protected
  1129. "
  1130. >
  1131. <h4 class="phpdocumentor-element__name" id="method_createImage">
  1132. createImage()
  1133. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_createImage" class="headerlink"><i class="fas fa-link"></i></a>
  1134. </h4>
  1135. <aside class="phpdocumentor-element-found-in">
  1136. <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>
  1137. :
  1138. <span class="phpdocumentor-element-found-in__line">157</span>
  1139. </aside>
  1140. <p class="phpdocumentor-summary">Creates a new Imagick instance</p>
  1141. <code class="phpdocumentor-code phpdocumentor-signature ">
  1142. <span class="phpdocumentor-signature__visibility">protected</span>
  1143. <span class="phpdocumentor-signature__name">createImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\Imagick">Imagick</abbr></span></code>
  1144. <div class="phpdocumentor-label-line">
  1145. </div>
  1146. <section>
  1147. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1148. <span class="phpdocumentor-signature__response_type"><abbr title="\Imagick">Imagick</abbr></span>
  1149. </section>
  1150. </article>
  1151. <article
  1152. class="phpdocumentor-element
  1153. -method
  1154. -protected
  1155. "
  1156. >
  1157. <h4 class="phpdocumentor-element__name" id="method_drawImage">
  1158. drawImage()
  1159. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage" class="headerlink"><i class="fas fa-link"></i></a>
  1160. </h4>
  1161. <aside class="phpdocumentor-element-found-in">
  1162. <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>
  1163. :
  1164. <span class="phpdocumentor-element-found-in__line">191</span>
  1165. </aside>
  1166. <p class="phpdocumentor-summary">Creates the QR image via ImagickDraw</p>
  1167. <code class="phpdocumentor-code phpdocumentor-signature ">
  1168. <span class="phpdocumentor-signature__visibility">protected</span>
  1169. <span class="phpdocumentor-signature__name">drawImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1170. <div class="phpdocumentor-label-line">
  1171. </div>
  1172. </article>
  1173. <article
  1174. class="phpdocumentor-element
  1175. -method
  1176. -protected
  1177. "
  1178. >
  1179. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  1180. getDefaultModuleValue()
  1181. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1182. </h4>
  1183. <aside class="phpdocumentor-element-found-in">
  1184. <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>
  1185. :
  1186. <span class="phpdocumentor-element-found-in__line">107</span>
  1187. </aside>
  1188. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output class)</p>
  1189. <code class="phpdocumentor-code phpdocumentor-signature ">
  1190. <span class="phpdocumentor-signature__visibility">protected</span>
  1191. <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"><abbr title="\ImagickPixel">ImagickPixel</abbr></span></code>
  1192. <div class="phpdocumentor-label-line">
  1193. </div>
  1194. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1195. <dl class="phpdocumentor-argument-list">
  1196. <dt class="phpdocumentor-argument-list__entry">
  1197. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  1198. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1199. </dt>
  1200. <dd class="phpdocumentor-argument-list__definition">
  1201. </dd>
  1202. </dl>
  1203. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1204. Tags
  1205. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1206. </h5>
  1207. <dl class="phpdocumentor-tag-list">
  1208. <dt class="phpdocumentor-tag-list__entry">
  1209. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1210. </dt>
  1211. <dd class="phpdocumentor-tag-list__definition">
  1212. </dd>
  1213. </dl>
  1214. <section>
  1215. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1216. <span class="phpdocumentor-signature__response_type"><abbr title="\ImagickPixel">ImagickPixel</abbr></span>
  1217. </section>
  1218. </article>
  1219. <article
  1220. class="phpdocumentor-element
  1221. -method
  1222. -protected
  1223. "
  1224. >
  1225. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  1226. getModuleValue()
  1227. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1228. </h4>
  1229. <aside class="phpdocumentor-element-found-in">
  1230. <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>
  1231. :
  1232. <span class="phpdocumentor-element-found-in__line">164</span>
  1233. </aside>
  1234. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  1235. <code class="phpdocumentor-code phpdocumentor-signature ">
  1236. <span class="phpdocumentor-signature__visibility">protected</span>
  1237. <span class="phpdocumentor-signature__name">getModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><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">mixed</span></code>
  1238. <div class="phpdocumentor-label-line">
  1239. </div>
  1240. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1241. <dl class="phpdocumentor-argument-list">
  1242. <dt class="phpdocumentor-argument-list__entry">
  1243. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1244. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1245. </dt>
  1246. <dd class="phpdocumentor-argument-list__definition">
  1247. </dd>
  1248. </dl>
  1249. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1250. Tags
  1251. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1252. </h5>
  1253. <dl class="phpdocumentor-tag-list">
  1254. <dt class="phpdocumentor-tag-list__entry">
  1255. <span class="phpdocumentor-tag__name">throws</span>
  1256. </dt>
  1257. <dd class="phpdocumentor-tag-list__definition">
  1258. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1259. <section class="phpdocumentor-description"><p>if $moduleValues[$M_TYPE] doesn't exist</p>
  1260. </section>
  1261. </dd>
  1262. </dl>
  1263. </article>
  1264. <article
  1265. class="phpdocumentor-element
  1266. -method
  1267. -protected
  1268. "
  1269. >
  1270. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  1271. getModuleValueAt()
  1272. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  1273. </h4>
  1274. <aside class="phpdocumentor-element-found-in">
  1275. <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>
  1276. :
  1277. <span class="phpdocumentor-element-found-in__line">176</span>
  1278. </aside>
  1279. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  1280. <code class="phpdocumentor-code phpdocumentor-signature ">
  1281. <span class="phpdocumentor-signature__visibility">protected</span>
  1282. <span class="phpdocumentor-signature__name">getModuleValueAt</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>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  1283. <div class="phpdocumentor-label-line">
  1284. </div>
  1285. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1286. <dl class="phpdocumentor-argument-list">
  1287. <dt class="phpdocumentor-argument-list__entry">
  1288. <span class="phpdocumentor-signature__argument__name">$x</span>
  1289. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1290. </dt>
  1291. <dd class="phpdocumentor-argument-list__definition">
  1292. </dd>
  1293. <dt class="phpdocumentor-argument-list__entry">
  1294. <span class="phpdocumentor-signature__argument__name">$y</span>
  1295. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1296. </dt>
  1297. <dd class="phpdocumentor-argument-list__definition">
  1298. </dd>
  1299. </dl>
  1300. </article>
  1301. <article
  1302. class="phpdocumentor-element
  1303. -method
  1304. -protected
  1305. "
  1306. >
  1307. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  1308. getOutputDimensions()
  1309. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1310. </h4>
  1311. <aside class="phpdocumentor-element-found-in">
  1312. <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>
  1313. :
  1314. <span class="phpdocumentor-element-found-in__line">126</span>
  1315. </aside>
  1316. <p class="phpdocumentor-summary">Returns a 2 element array with the current output width and height</p>
  1317. <code class="phpdocumentor-code phpdocumentor-signature ">
  1318. <span class="phpdocumentor-signature__visibility">protected</span>
  1319. <span class="phpdocumentor-signature__name">getOutputDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1320. <div class="phpdocumentor-label-line">
  1321. </div>
  1322. <section class="phpdocumentor-description"><p>The type and units of the values depend on the output class. The default value is the current module count * scale.</p>
  1323. </section>
  1324. <section>
  1325. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1326. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1327. </section>
  1328. </article>
  1329. <article
  1330. class="phpdocumentor-element
  1331. -method
  1332. -protected
  1333. "
  1334. >
  1335. <h4 class="phpdocumentor-element__name" id="method_module">
  1336. module()
  1337. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  1338. </h4>
  1339. <aside class="phpdocumentor-element-found-in">
  1340. <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>
  1341. :
  1342. <span class="phpdocumentor-element-found-in__line">207</span>
  1343. </aside>
  1344. <p class="phpdocumentor-summary">draws a single pixel at the given position</p>
  1345. <code class="phpdocumentor-code phpdocumentor-signature ">
  1346. <span class="phpdocumentor-signature__visibility">protected</span>
  1347. <span class="phpdocumentor-signature__name">module</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>
  1348. <div class="phpdocumentor-label-line">
  1349. </div>
  1350. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1351. <dl class="phpdocumentor-argument-list">
  1352. <dt class="phpdocumentor-argument-list__entry">
  1353. <span class="phpdocumentor-signature__argument__name">$x</span>
  1354. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1355. </dt>
  1356. <dd class="phpdocumentor-argument-list__definition">
  1357. </dd>
  1358. <dt class="phpdocumentor-argument-list__entry">
  1359. <span class="phpdocumentor-signature__argument__name">$y</span>
  1360. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1361. </dt>
  1362. <dd class="phpdocumentor-argument-list__definition">
  1363. </dd>
  1364. <dt class="phpdocumentor-argument-list__entry">
  1365. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1366. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1367. </dt>
  1368. <dd class="phpdocumentor-argument-list__definition">
  1369. </dd>
  1370. </dl>
  1371. </article>
  1372. <article
  1373. class="phpdocumentor-element
  1374. -method
  1375. -protected
  1376. "
  1377. >
  1378. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  1379. prepareModuleValue()
  1380. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1381. </h4>
  1382. <aside class="phpdocumentor-element-found-in">
  1383. <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>
  1384. :
  1385. <span class="phpdocumentor-element-found-in__line">100</span>
  1386. </aside>
  1387. <p class="phpdocumentor-summary">Prepares the value for the given input (return value depends on the output class)</p>
  1388. <code class="phpdocumentor-code phpdocumentor-signature ">
  1389. <span class="phpdocumentor-signature__visibility">protected</span>
  1390. <span class="phpdocumentor-signature__name">prepareModuleValue</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"><abbr title="\ImagickPixel">ImagickPixel</abbr></span></code>
  1391. <div class="phpdocumentor-label-line">
  1392. </div>
  1393. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1394. <dl class="phpdocumentor-argument-list">
  1395. <dt class="phpdocumentor-argument-list__entry">
  1396. <span class="phpdocumentor-signature__argument__name">$value</span>
  1397. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1398. </dt>
  1399. <dd class="phpdocumentor-argument-list__definition">
  1400. </dd>
  1401. </dl>
  1402. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1403. Tags
  1404. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_prepareModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1405. </h5>
  1406. <dl class="phpdocumentor-tag-list">
  1407. <dt class="phpdocumentor-tag-list__entry">
  1408. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1409. </dt>
  1410. <dd class="phpdocumentor-tag-list__definition">
  1411. </dd>
  1412. </dl>
  1413. <section>
  1414. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1415. <span class="phpdocumentor-signature__response_type"><abbr title="\ImagickPixel">ImagickPixel</abbr></span>
  1416. </section>
  1417. </article>
  1418. <article
  1419. class="phpdocumentor-element
  1420. -method
  1421. -protected
  1422. "
  1423. >
  1424. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1425. saveToFile()
  1426. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1427. </h4>
  1428. <aside class="phpdocumentor-element-found-in">
  1429. <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>
  1430. :
  1431. <span class="phpdocumentor-element-found-in__line">195</span>
  1432. </aside>
  1433. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1434. <code class="phpdocumentor-code phpdocumentor-signature ">
  1435. <span class="phpdocumentor-signature__visibility">protected</span>
  1436. <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>
  1437. <div class="phpdocumentor-label-line">
  1438. </div>
  1439. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1440. <dl class="phpdocumentor-argument-list">
  1441. <dt class="phpdocumentor-argument-list__entry">
  1442. <span class="phpdocumentor-signature__argument__name">$data</span>
  1443. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1444. </dt>
  1445. <dd class="phpdocumentor-argument-list__definition">
  1446. </dd>
  1447. <dt class="phpdocumentor-argument-list__entry">
  1448. <span class="phpdocumentor-signature__argument__name">$file</span>
  1449. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1450. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1451. <dd class="phpdocumentor-argument-list__definition">
  1452. </dd>
  1453. </dl>
  1454. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1455. Tags
  1456. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1457. </h5>
  1458. <dl class="phpdocumentor-tag-list">
  1459. <dt class="phpdocumentor-tag-list__entry">
  1460. <span class="phpdocumentor-tag__name">see</span>
  1461. </dt>
  1462. <dd class="phpdocumentor-tag-list__definition">
  1463. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1464. </dd>
  1465. <dt class="phpdocumentor-tag-list__entry">
  1466. <span class="phpdocumentor-tag__name">see</span>
  1467. </dt>
  1468. <dd class="phpdocumentor-tag-list__definition">
  1469. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1470. </dd>
  1471. <dt class="phpdocumentor-tag-list__entry">
  1472. <span class="phpdocumentor-tag__name">throws</span>
  1473. </dt>
  1474. <dd class="phpdocumentor-tag-list__definition">
  1475. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1476. </dd>
  1477. </dl>
  1478. </article>
  1479. <article
  1480. class="phpdocumentor-element
  1481. -method
  1482. -protected
  1483. "
  1484. >
  1485. <h4 class="phpdocumentor-element__name" id="method_setBgColor">
  1486. setBgColor()
  1487. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setBgColor" class="headerlink"><i class="fas fa-link"></i></a>
  1488. </h4>
  1489. <aside class="phpdocumentor-element-found-in">
  1490. <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>
  1491. :
  1492. <span class="phpdocumentor-element-found-in__line">143</span>
  1493. </aside>
  1494. <p class="phpdocumentor-summary">Sets the background color</p>
  1495. <code class="phpdocumentor-code phpdocumentor-signature ">
  1496. <span class="phpdocumentor-signature__visibility">protected</span>
  1497. <span class="phpdocumentor-signature__name">setBgColor</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1498. <div class="phpdocumentor-label-line">
  1499. </div>
  1500. </article>
  1501. <article
  1502. class="phpdocumentor-element
  1503. -method
  1504. -protected
  1505. "
  1506. >
  1507. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1508. setMatrixDimensions()
  1509. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1510. </h4>
  1511. <aside class="phpdocumentor-element-found-in">
  1512. <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>
  1513. :
  1514. <span class="phpdocumentor-element-found-in__line">115</span>
  1515. </aside>
  1516. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1517. <code class="phpdocumentor-code phpdocumentor-signature ">
  1518. <span class="phpdocumentor-signature__visibility">protected</span>
  1519. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1520. <div class="phpdocumentor-label-line">
  1521. </div>
  1522. <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>
  1523. </section>
  1524. </article>
  1525. <article
  1526. class="phpdocumentor-element
  1527. -method
  1528. -protected
  1529. "
  1530. >
  1531. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1532. setModuleValues()
  1533. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1534. </h4>
  1535. <aside class="phpdocumentor-element-found-in">
  1536. <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>
  1537. :
  1538. <span class="phpdocumentor-element-found-in__line">133</span>
  1539. </aside>
  1540. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1541. <code class="phpdocumentor-code phpdocumentor-signature ">
  1542. <span class="phpdocumentor-signature__visibility">protected</span>
  1543. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1544. <div class="phpdocumentor-label-line">
  1545. </div>
  1546. </article>
  1547. <article
  1548. class="phpdocumentor-element
  1549. -method
  1550. -protected
  1551. "
  1552. >
  1553. <h4 class="phpdocumentor-element__name" id="method_setTransparencyColor">
  1554. setTransparencyColor()
  1555. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setTransparencyColor" class="headerlink"><i class="fas fa-link"></i></a>
  1556. </h4>
  1557. <aside class="phpdocumentor-element-found-in">
  1558. <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>
  1559. :
  1560. <span class="phpdocumentor-element-found-in__line">173</span>
  1561. </aside>
  1562. <p class="phpdocumentor-summary">Sets the transparency color</p>
  1563. <code class="phpdocumentor-code phpdocumentor-signature ">
  1564. <span class="phpdocumentor-signature__visibility">protected</span>
  1565. <span class="phpdocumentor-signature__name">setTransparencyColor</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1566. <div class="phpdocumentor-label-line">
  1567. </div>
  1568. </article>
  1569. <article
  1570. class="phpdocumentor-element
  1571. -method
  1572. -protected
  1573. "
  1574. >
  1575. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1576. toBase64DataURI()
  1577. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1578. </h4>
  1579. <aside class="phpdocumentor-element-found-in">
  1580. <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>
  1581. :
  1582. <span class="phpdocumentor-element-found-in__line">183</span>
  1583. </aside>
  1584. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1585. <code class="phpdocumentor-code phpdocumentor-signature ">
  1586. <span class="phpdocumentor-signature__visibility">protected</span>
  1587. <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>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</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</span></code>
  1588. <div class="phpdocumentor-label-line">
  1589. </div>
  1590. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1591. <dl class="phpdocumentor-argument-list">
  1592. <dt class="phpdocumentor-argument-list__entry">
  1593. <span class="phpdocumentor-signature__argument__name">$data</span>
  1594. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1595. </dt>
  1596. <dd class="phpdocumentor-argument-list__definition">
  1597. </dd>
  1598. <dt class="phpdocumentor-argument-list__entry">
  1599. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1600. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1601. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1602. <dd class="phpdocumentor-argument-list__definition">
  1603. </dd>
  1604. </dl>
  1605. <section>
  1606. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1607. <span class="phpdocumentor-signature__response_type">string</span>
  1608. </section>
  1609. </article>
  1610. </section>
  1611. <div class="phpdocumentor-modal" id="source-view">
  1612. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1613. <div class="phpdocumentor-modal-container">
  1614. <div class="phpdocumentor-modal-content">
  1615. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Output/QRImagick.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  1616. </div>
  1617. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1618. </div>
  1619. </div>
  1620. <script type="text/javascript">
  1621. (function () {
  1622. function loadExternalCodeSnippet(el, url, line) {
  1623. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1624. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1625. const language = 'php';
  1626. const code = document.createElement('code');
  1627. code.className = 'language-' + language;
  1628. pre.textContent = '';
  1629. pre.setAttribute('data-line', line)
  1630. code.textContent = 'Loading…';
  1631. pre.appendChild(code);
  1632. var xhr = new XMLHttpRequest();
  1633. xhr.open('GET', src, true);
  1634. xhr.onreadystatechange = function () {
  1635. if (xhr.readyState !== 4) {
  1636. return;
  1637. }
  1638. if (xhr.status < 400 && xhr.responseText) {
  1639. code.textContent = xhr.responseText;
  1640. Prism.highlightElement(code);
  1641. return;
  1642. }
  1643. if (xhr.status === 404) {
  1644. code.textContent = '✖ Error: File could not be found';
  1645. return;
  1646. }
  1647. if (xhr.status >= 400) {
  1648. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1649. return;
  1650. }
  1651. code.textContent = '✖ Error: An unknown error occurred';
  1652. };
  1653. xhr.send(null);
  1654. });
  1655. }
  1656. const modalButtons = document.querySelectorAll("[data-modal]");
  1657. const openedAsLocalFile = window.location.protocol === 'file:';
  1658. if (modalButtons.length > 0 && openedAsLocalFile) {
  1659. console.warn(
  1660. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1661. 'browsers block XHR requests when a page is opened this way'
  1662. );
  1663. }
  1664. modalButtons.forEach(function (trigger) {
  1665. if (openedAsLocalFile) {
  1666. trigger.setAttribute("hidden", "hidden");
  1667. }
  1668. trigger.addEventListener("click", function (event) {
  1669. event.preventDefault();
  1670. const modal = document.getElementById(trigger.dataset.modal);
  1671. if (!modal) {
  1672. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1673. return;
  1674. }
  1675. modal.classList.add("phpdocumentor-modal__open");
  1676. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1677. const exits = modal.querySelectorAll("[data-exit-button]");
  1678. exits.forEach(function (exit) {
  1679. exit.addEventListener("click", function (event) {
  1680. event.preventDefault();
  1681. modal.classList.remove("phpdocumentor-modal__open");
  1682. });
  1683. });
  1684. });
  1685. });
  1686. })();
  1687. </script>
  1688. </article>
  1689. </section>
  1690. <section class="phpdocumentor-on-this-page__sidebar">
  1691. <section class="phpdocumentor-on-this-page__content">
  1692. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1693. <ul class="phpdocumentor-list -clean">
  1694. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1695. <li>
  1696. <ul class="phpdocumentor-list -clean">
  1697. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#toc-properties">Properties</a></li>
  1698. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#toc-methods">Methods</a></li>
  1699. </ul>
  1700. </li>
  1701. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1702. <li>
  1703. <ul class="phpdocumentor-list -clean">
  1704. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_backgroundColor">$backgroundColor<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1705. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1706. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1707. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1708. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1709. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1710. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1711. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1712. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick">$imagick<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1713. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw">$imagickDraw<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1714. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1715. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1716. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1717. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1718. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1719. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1720. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QRImagick.html"></li>
  1721. </ul>
  1722. </li>
  1723. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1724. <li>
  1725. <ul class="phpdocumentor-list -clean">
  1726. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct">__construct()</a></li>
  1727. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump">dump()</a></li>
  1728. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  1729. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1730. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a></li>
  1731. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_createImage">createImage()</a></li>
  1732. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage">drawImage()</a></li>
  1733. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1734. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1735. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1736. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1737. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_module">module()</a></li>
  1738. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1739. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1740. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setBgColor">setBgColor()</a></li>
  1741. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1742. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1743. <li><a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setTransparencyColor">setTransparencyColor()</a></li>
  1744. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1745. </ul>
  1746. </li>
  1747. </ul>
  1748. </section>
  1749. </section>
  1750. </div>
  1751. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1752. <section class="phpdocumentor-search-results__dialog">
  1753. <header class="phpdocumentor-search-results__header">
  1754. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1755. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1756. </header>
  1757. <section class="phpdocumentor-search-results__body">
  1758. <ul class="phpdocumentor-search-results__entries"></ul>
  1759. </section>
  1760. </section>
  1761. </section>
  1762. </div>
  1763. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1764. </main>
  1765. <script>
  1766. cssVars({});
  1767. </script>
  1768. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1769. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1770. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1771. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1772. </body>
  1773. </html>