chillerlan-QRCode-Output-QRImagick.html 76 KB

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