chillerlan-QRCode-Output-QRImagick.html 111 KB

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