chillerlan-QRCode-Output-QRImagick.html 112 KB

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