chillerlan-QRCode-Output-QRImagick.html 64 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356
  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_imagick">$imagick</a>
  134. <span>
  135. &nbsp;: <abbr title="\Imagick">Imagick</abbr> </span>
  136. </dt>
  137. <dd></dd>
  138. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  139. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw">$imagickDraw</a>
  140. <span>
  141. &nbsp;: <abbr title="\ImagickDraw">ImagickDraw</abbr> </span>
  142. </dt>
  143. <dd></dd>
  144. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  145. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  146. <span>
  147. &nbsp;: int </span>
  148. </dt>
  149. <dd>the side length of the QR image (modules * scale)</dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  151. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  152. <span>
  153. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  154. </dt>
  155. <dd>the (filled) data matrix object</dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  157. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  158. <span>
  159. &nbsp;: int </span>
  160. </dt>
  161. <dd>the current size of the QR matrix</dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  163. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  164. <span>
  165. &nbsp;: array&lt;string|int, mixed&gt; </span>
  166. </dt>
  167. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  168. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  170. <span>
  171. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  172. </dt>
  173. <dd></dd>
  174. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  175. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  176. <span>
  177. &nbsp;: int </span>
  178. </dt>
  179. <dd>the current scaling for a QR pixel</dd>
  180. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  181. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct">__construct()</a>
  182. <span>
  183. &nbsp;: mixed </span>
  184. </dt>
  185. <dd>QROutputAbstract constructor.</dd>
  186. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  187. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump">dump()</a>
  188. <span>
  189. &nbsp;: string|<abbr title="\Imagick">Imagick</abbr> </span>
  190. </dt>
  191. <dd></dd>
  192. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  193. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  194. <span>
  195. &nbsp;: array&lt;string|int, mixed&gt; </span>
  196. </dt>
  197. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  198. returns an array with the transformed modules</dd>
  199. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  200. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage">drawImage()</a>
  201. <span>
  202. &nbsp;: void </span>
  203. </dt>
  204. <dd>Creates the QR image via ImagickDraw</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  206. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  207. <span>
  208. &nbsp;: mixed </span>
  209. </dt>
  210. <dd>Returns a default value for either dark or light modules (return value depends on the output module)</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  212. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getModuleValue">getModuleValue()</a>
  213. <span>
  214. &nbsp;: mixed </span>
  215. </dt>
  216. <dd>Returns the final value for the given input (return value depends on the output module)</dd>
  217. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  218. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  219. <span>
  220. &nbsp;: bool </span>
  221. </dt>
  222. <dd>Determines whether the given value is valid</dd>
  223. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  224. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  225. <span>
  226. &nbsp;: void </span>
  227. </dt>
  228. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  229. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  230. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  231. <span>
  232. &nbsp;: void </span>
  233. </dt>
  234. <dd>Sets/updates the matrix dimensions</dd>
  235. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  236. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  237. <span>
  238. &nbsp;: void </span>
  239. </dt>
  240. <dd>Sets the initial module values</dd>
  241. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  242. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setPixel">setPixel()</a>
  243. <span>
  244. &nbsp;: void </span>
  245. </dt>
  246. <dd>draws a single pixel at the given position</dd>
  247. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  248. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  249. <span>
  250. &nbsp;: string </span>
  251. </dt>
  252. <dd>Returns a base64 data URI for the given string and mime type</dd>
  253. </dl>
  254. <section class="phpdocumentor-properties">
  255. <h3 class="phpdocumentor-elements__header" id="properties">
  256. Properties
  257. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  258. </h3>
  259. <article
  260. class="
  261. phpdocumentor-element
  262. -property
  263. -protected
  264. "
  265. >
  266. <h4 class="phpdocumentor-element__name" id="property_imagick">
  267. $imagick
  268. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagick" class="headerlink"><i class="fas fa-link"></i></a>
  269. <span class="phpdocumentor-element__modifiers">
  270. </span>
  271. </h4>
  272. <aside class="phpdocumentor-element-found-in">
  273. <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>
  274. :
  275. <span class="phpdocumentor-element-found-in__line">29</span>
  276. </aside>
  277. <code class="phpdocumentor-code phpdocumentor-signature ">
  278. <span class="phpdocumentor-signature__visibility">protected</span>
  279. <span class="phpdocumentor-signature__type"><abbr title="\Imagick">Imagick</abbr></span>
  280. <span class="phpdocumentor-signature__name">$imagick</span>
  281. </code>
  282. <section class="phpdocumentor-description"></section>
  283. <section class="phpdocumentor-description"></section>
  284. </article>
  285. <article
  286. class="
  287. phpdocumentor-element
  288. -property
  289. -protected
  290. "
  291. >
  292. <h4 class="phpdocumentor-element__name" id="property_imagickDraw">
  293. $imagickDraw
  294. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#property_imagickDraw" class="headerlink"><i class="fas fa-link"></i></a>
  295. <span class="phpdocumentor-element__modifiers">
  296. </span>
  297. </h4>
  298. <aside class="phpdocumentor-element-found-in">
  299. <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>
  300. :
  301. <span class="phpdocumentor-element-found-in__line">30</span>
  302. </aside>
  303. <code class="phpdocumentor-code phpdocumentor-signature ">
  304. <span class="phpdocumentor-signature__visibility">protected</span>
  305. <span class="phpdocumentor-signature__type"><abbr title="\ImagickDraw">ImagickDraw</abbr></span>
  306. <span class="phpdocumentor-signature__name">$imagickDraw</span>
  307. </code>
  308. <section class="phpdocumentor-description"></section>
  309. <section class="phpdocumentor-description"></section>
  310. </article>
  311. <article
  312. class="
  313. phpdocumentor-element
  314. -property
  315. -protected
  316. "
  317. >
  318. <h4 class="phpdocumentor-element__name" id="property_length">
  319. $length
  320. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  321. <span class="phpdocumentor-element__modifiers">
  322. </span>
  323. </h4>
  324. <aside class="phpdocumentor-element-found-in">
  325. <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>
  326. :
  327. <span class="phpdocumentor-element-found-in__line">40</span>
  328. </aside>
  329. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  330. <code class="phpdocumentor-code phpdocumentor-signature ">
  331. <span class="phpdocumentor-signature__visibility">protected</span>
  332. <span class="phpdocumentor-signature__type">int</span>
  333. <span class="phpdocumentor-signature__name">$length</span>
  334. </code>
  335. <section class="phpdocumentor-description"></section>
  336. </article>
  337. <article
  338. class="
  339. phpdocumentor-element
  340. -property
  341. -protected
  342. "
  343. >
  344. <h4 class="phpdocumentor-element__name" id="property_matrix">
  345. $matrix
  346. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  347. <span class="phpdocumentor-element__modifiers">
  348. </span>
  349. </h4>
  350. <aside class="phpdocumentor-element-found-in">
  351. <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>
  352. :
  353. <span class="phpdocumentor-element-found-in__line">50</span>
  354. </aside>
  355. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  356. <code class="phpdocumentor-code phpdocumentor-signature ">
  357. <span class="phpdocumentor-signature__visibility">protected</span>
  358. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  359. <span class="phpdocumentor-signature__name">$matrix</span>
  360. </code>
  361. <section class="phpdocumentor-description"></section>
  362. </article>
  363. <article
  364. class="
  365. phpdocumentor-element
  366. -property
  367. -protected
  368. "
  369. >
  370. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  371. $moduleCount
  372. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  373. <span class="phpdocumentor-element__modifiers">
  374. </span>
  375. </h4>
  376. <aside class="phpdocumentor-element-found-in">
  377. <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>
  378. :
  379. <span class="phpdocumentor-element-found-in__line">28</span>
  380. </aside>
  381. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  382. <code class="phpdocumentor-code phpdocumentor-signature ">
  383. <span class="phpdocumentor-signature__visibility">protected</span>
  384. <span class="phpdocumentor-signature__type">int</span>
  385. <span class="phpdocumentor-signature__name">$moduleCount</span>
  386. </code>
  387. <section class="phpdocumentor-description"></section>
  388. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  389. Tags
  390. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  391. </h5>
  392. <dl class="phpdocumentor-tag-list">
  393. <dt class="phpdocumentor-tag-list__entry">
  394. <span class="phpdocumentor-tag__name">see</span>
  395. </dt>
  396. <dd class="phpdocumentor-tag-list__definition">
  397. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size"><abbr title="\chillerlan\QRCode\Data\QRMatrix::size()">QRMatrix::size()</abbr></a></span>
  398. </dd>
  399. </dl>
  400. </article>
  401. <article
  402. class="
  403. phpdocumentor-element
  404. -property
  405. -protected
  406. "
  407. >
  408. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  409. $moduleValues
  410. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  411. <span class="phpdocumentor-element__modifiers">
  412. </span>
  413. </h4>
  414. <aside class="phpdocumentor-element-found-in">
  415. <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>
  416. :
  417. <span class="phpdocumentor-element-found-in__line">45</span>
  418. </aside>
  419. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  420. <code class="phpdocumentor-code phpdocumentor-signature ">
  421. <span class="phpdocumentor-signature__visibility">protected</span>
  422. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  423. <span class="phpdocumentor-signature__name">$moduleValues</span>
  424. </code>
  425. <section class="phpdocumentor-description"></section>
  426. </article>
  427. <article
  428. class="
  429. phpdocumentor-element
  430. -property
  431. -protected
  432. "
  433. >
  434. <h4 class="phpdocumentor-element__name" id="property_options">
  435. $options
  436. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  437. <span class="phpdocumentor-element__modifiers">
  438. </span>
  439. </h4>
  440. <aside class="phpdocumentor-element-found-in">
  441. <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>
  442. :
  443. <span class="phpdocumentor-element-found-in__line">55</span>
  444. </aside>
  445. <code class="phpdocumentor-code phpdocumentor-signature ">
  446. <span class="phpdocumentor-signature__visibility">protected</span>
  447. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  448. <span class="phpdocumentor-signature__name">$options</span>
  449. </code>
  450. </article>
  451. <article
  452. class="
  453. phpdocumentor-element
  454. -property
  455. -protected
  456. "
  457. >
  458. <h4 class="phpdocumentor-element__name" id="property_scale">
  459. $scale
  460. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  461. <span class="phpdocumentor-element__modifiers">
  462. </span>
  463. </h4>
  464. <aside class="phpdocumentor-element-found-in">
  465. <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>
  466. :
  467. <span class="phpdocumentor-element-found-in__line">35</span>
  468. </aside>
  469. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  470. <code class="phpdocumentor-code phpdocumentor-signature ">
  471. <span class="phpdocumentor-signature__visibility">protected</span>
  472. <span class="phpdocumentor-signature__type">int</span>
  473. <span class="phpdocumentor-signature__name">$scale</span>
  474. </code>
  475. <section class="phpdocumentor-description"></section>
  476. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  477. Tags
  478. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  479. </h5>
  480. <dl class="phpdocumentor-tag-list">
  481. <dt class="phpdocumentor-tag-list__entry">
  482. <span class="phpdocumentor-tag__name">see</span>
  483. </dt>
  484. <dd class="phpdocumentor-tag-list__definition">
  485. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  486. </dd>
  487. </dl>
  488. </article>
  489. </section>
  490. <section class="phpdocumentor-methods">
  491. <h3 class="phpdocumentor-elements__header" id="methods">
  492. Methods
  493. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  494. </h3>
  495. <article
  496. class="phpdocumentor-element
  497. -method
  498. -public
  499. "
  500. >
  501. <h4 class="phpdocumentor-element__name" id="method___construct">
  502. __construct()
  503. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  504. </h4>
  505. <aside class="phpdocumentor-element-found-in">
  506. <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>
  507. :
  508. <span class="phpdocumentor-element-found-in__line">37</span>
  509. </aside>
  510. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  511. <code class="phpdocumentor-code phpdocumentor-signature ">
  512. <span class="phpdocumentor-signature__visibility">public</span>
  513. <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>
  514. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  515. <dl class="phpdocumentor-argument-list">
  516. <dt class="phpdocumentor-argument-list__entry">
  517. <span class="phpdocumentor-signature__argument__name">$options</span>
  518. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  519. </dt>
  520. <dd class="phpdocumentor-argument-list__definition">
  521. <section class="phpdocumentor-description"></section>
  522. </dd>
  523. <dt class="phpdocumentor-argument-list__entry">
  524. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  525. : <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>
  526. </dt>
  527. <dd class="phpdocumentor-argument-list__definition">
  528. <section class="phpdocumentor-description"></section>
  529. </dd>
  530. </dl>
  531. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  532. Tags
  533. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  534. </h5>
  535. <dl class="phpdocumentor-tag-list">
  536. <dt class="phpdocumentor-tag-list__entry">
  537. <span class="phpdocumentor-tag__name">inheritDoc</span>
  538. </dt>
  539. <dd class="phpdocumentor-tag-list__definition">
  540. </dd>
  541. <dt class="phpdocumentor-tag-list__entry">
  542. <span class="phpdocumentor-tag__name">throws</span>
  543. </dt>
  544. <dd class="phpdocumentor-tag-list__definition">
  545. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  546. </dd>
  547. </dl>
  548. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  549. <span class="phpdocumentor-signature__response_type">mixed</span>
  550. &mdash;
  551. </article>
  552. <article
  553. class="phpdocumentor-element
  554. -method
  555. -public
  556. "
  557. >
  558. <h4 class="phpdocumentor-element__name" id="method_dump">
  559. dump()
  560. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  561. </h4>
  562. <aside class="phpdocumentor-element-found-in">
  563. <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>
  564. :
  565. <span class="phpdocumentor-element-found-in__line">76</span>
  566. </aside>
  567. <code class="phpdocumentor-code phpdocumentor-signature ">
  568. <span class="phpdocumentor-signature__visibility">public</span>
  569. <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>
  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">$file</span>
  574. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  575. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  576. <dd class="phpdocumentor-argument-list__definition">
  577. <section class="phpdocumentor-description"></section>
  578. </dd>
  579. </dl>
  580. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  581. Tags
  582. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  583. </h5>
  584. <dl class="phpdocumentor-tag-list">
  585. <dt class="phpdocumentor-tag-list__entry">
  586. <span class="phpdocumentor-tag__name">inheritDoc</span>
  587. </dt>
  588. <dd class="phpdocumentor-tag-list__definition">
  589. </dd>
  590. </dl>
  591. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  592. <span class="phpdocumentor-signature__response_type">string|<abbr title="\Imagick">Imagick</abbr></span>
  593. &mdash;
  594. </article>
  595. <article
  596. class="phpdocumentor-element
  597. -method
  598. -protected
  599. "
  600. >
  601. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  602. collectModules()
  603. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  604. </h4>
  605. <aside class="phpdocumentor-element-found-in">
  606. <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>
  607. :
  608. <span class="phpdocumentor-element-found-in__line">158</span>
  609. </aside>
  610. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  611. returns an array with the transformed modules</p>
  612. <code class="phpdocumentor-code phpdocumentor-signature ">
  613. <span class="phpdocumentor-signature__visibility">protected</span>
  614. <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>
  615. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  616. <p>$x - current column
  617. $y - current row
  618. $M_TYPE - field value
  619. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  620. </section>
  621. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  622. <dl class="phpdocumentor-argument-list">
  623. <dt class="phpdocumentor-argument-list__entry">
  624. <span class="phpdocumentor-signature__argument__name">$transform</span>
  625. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  626. </dt>
  627. <dd class="phpdocumentor-argument-list__definition">
  628. <section class="phpdocumentor-description"></section>
  629. </dd>
  630. </dl>
  631. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  632. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  633. &mdash;
  634. </article>
  635. <article
  636. class="phpdocumentor-element
  637. -method
  638. -protected
  639. "
  640. >
  641. <h4 class="phpdocumentor-element__name" id="method_drawImage">
  642. drawImage()
  643. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_drawImage" class="headerlink"><i class="fas fa-link"></i></a>
  644. </h4>
  645. <aside class="phpdocumentor-element-found-in">
  646. <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>
  647. :
  648. <span class="phpdocumentor-element-found-in__line">110</span>
  649. </aside>
  650. <p class="phpdocumentor-summary">Creates the QR image via ImagickDraw</p>
  651. <code class="phpdocumentor-code phpdocumentor-signature ">
  652. <span class="phpdocumentor-signature__visibility">protected</span>
  653. <span class="phpdocumentor-signature__name">drawImage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  654. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  655. <span class="phpdocumentor-signature__response_type">void</span>
  656. &mdash;
  657. </article>
  658. <article
  659. class="phpdocumentor-element
  660. -method
  661. -protected
  662. "
  663. >
  664. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  665. getDefaultModuleValue()
  666. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  667. </h4>
  668. <aside class="phpdocumentor-element-found-in">
  669. <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>
  670. :
  671. <span class="phpdocumentor-element-found-in__line">67</span>
  672. </aside>
  673. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output module)</p>
  674. <code class="phpdocumentor-code phpdocumentor-signature ">
  675. <span class="phpdocumentor-signature__visibility">protected</span>
  676. <span class="phpdocumentor-signature__name">getDefaultModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$isDark</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  677. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  678. <dl class="phpdocumentor-argument-list">
  679. <dt class="phpdocumentor-argument-list__entry">
  680. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  681. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  682. </dt>
  683. <dd class="phpdocumentor-argument-list__definition">
  684. <section class="phpdocumentor-description"></section>
  685. </dd>
  686. </dl>
  687. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  688. Tags
  689. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  690. </h5>
  691. <dl class="phpdocumentor-tag-list">
  692. <dt class="phpdocumentor-tag-list__entry">
  693. <span class="phpdocumentor-tag__name">inheritDoc</span>
  694. </dt>
  695. <dd class="phpdocumentor-tag-list__definition">
  696. </dd>
  697. </dl>
  698. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  699. <span class="phpdocumentor-signature__response_type">mixed</span>
  700. &mdash;
  701. </article>
  702. <article
  703. class="phpdocumentor-element
  704. -method
  705. -protected
  706. "
  707. >
  708. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  709. getModuleValue()
  710. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  711. </h4>
  712. <aside class="phpdocumentor-element-found-in">
  713. <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>
  714. :
  715. <span class="phpdocumentor-element-found-in__line">60</span>
  716. </aside>
  717. <p class="phpdocumentor-summary">Returns the final value for the given input (return value depends on the output module)</p>
  718. <code class="phpdocumentor-code phpdocumentor-signature ">
  719. <span class="phpdocumentor-signature__visibility">protected</span>
  720. <span class="phpdocumentor-signature__name">getModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  721. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  722. <dl class="phpdocumentor-argument-list">
  723. <dt class="phpdocumentor-argument-list__entry">
  724. <span class="phpdocumentor-signature__argument__name">$value</span>
  725. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  726. </dt>
  727. <dd class="phpdocumentor-argument-list__definition">
  728. </dd>
  729. </dl>
  730. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  731. Tags
  732. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  733. </h5>
  734. <dl class="phpdocumentor-tag-list">
  735. <dt class="phpdocumentor-tag-list__entry">
  736. <span class="phpdocumentor-tag__name">inheritDoc</span>
  737. </dt>
  738. <dd class="phpdocumentor-tag-list__definition">
  739. </dd>
  740. </dl>
  741. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  742. <span class="phpdocumentor-signature__response_type">mixed</span>
  743. &mdash;
  744. </article>
  745. <article
  746. class="phpdocumentor-element
  747. -method
  748. -protected
  749. "
  750. >
  751. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  752. moduleValueIsValid()
  753. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  754. </h4>
  755. <aside class="phpdocumentor-element-found-in">
  756. <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>
  757. :
  758. <span class="phpdocumentor-element-found-in__line">53</span>
  759. </aside>
  760. <p class="phpdocumentor-summary">Determines whether the given value is valid</p>
  761. <code class="phpdocumentor-code phpdocumentor-signature ">
  762. <span class="phpdocumentor-signature__visibility">protected</span>
  763. <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>
  764. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  765. <dl class="phpdocumentor-argument-list">
  766. <dt class="phpdocumentor-argument-list__entry">
  767. <span class="phpdocumentor-signature__argument__name">$value</span>
  768. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  769. </dt>
  770. <dd class="phpdocumentor-argument-list__definition">
  771. </dd>
  772. </dl>
  773. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  774. Tags
  775. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  776. </h5>
  777. <dl class="phpdocumentor-tag-list">
  778. <dt class="phpdocumentor-tag-list__entry">
  779. <span class="phpdocumentor-tag__name">inheritDoc</span>
  780. </dt>
  781. <dd class="phpdocumentor-tag-list__definition">
  782. </dd>
  783. </dl>
  784. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  785. <span class="phpdocumentor-signature__response_type">bool</span>
  786. &mdash;
  787. </article>
  788. <article
  789. class="phpdocumentor-element
  790. -method
  791. -protected
  792. "
  793. >
  794. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  795. saveToFile()
  796. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  797. </h4>
  798. <aside class="phpdocumentor-element-found-in">
  799. <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>
  800. :
  801. <span class="phpdocumentor-element-found-in__line">132</span>
  802. </aside>
  803. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  804. <code class="phpdocumentor-code phpdocumentor-signature ">
  805. <span class="phpdocumentor-signature__visibility">protected</span>
  806. <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>
  807. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  808. <dl class="phpdocumentor-argument-list">
  809. <dt class="phpdocumentor-argument-list__entry">
  810. <span class="phpdocumentor-signature__argument__name">$data</span>
  811. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  812. </dt>
  813. <dd class="phpdocumentor-argument-list__definition">
  814. <section class="phpdocumentor-description"></section>
  815. </dd>
  816. <dt class="phpdocumentor-argument-list__entry">
  817. <span class="phpdocumentor-signature__argument__name">$file</span>
  818. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  819. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  820. <dd class="phpdocumentor-argument-list__definition">
  821. <section class="phpdocumentor-description"></section>
  822. </dd>
  823. </dl>
  824. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  825. Tags
  826. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  827. </h5>
  828. <dl class="phpdocumentor-tag-list">
  829. <dt class="phpdocumentor-tag-list__entry">
  830. <span class="phpdocumentor-tag__name">see</span>
  831. </dt>
  832. <dd class="phpdocumentor-tag-list__definition">
  833. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  834. </dd>
  835. <dt class="phpdocumentor-tag-list__entry">
  836. <span class="phpdocumentor-tag__name">see</span>
  837. </dt>
  838. <dd class="phpdocumentor-tag-list__definition">
  839. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  840. </dd>
  841. <dt class="phpdocumentor-tag-list__entry">
  842. <span class="phpdocumentor-tag__name">throws</span>
  843. </dt>
  844. <dd class="phpdocumentor-tag-list__definition">
  845. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  846. </dd>
  847. </dl>
  848. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  849. <span class="phpdocumentor-signature__response_type">void</span>
  850. &mdash;
  851. </article>
  852. <article
  853. class="phpdocumentor-element
  854. -method
  855. -protected
  856. "
  857. >
  858. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  859. setMatrixDimensions()
  860. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  861. </h4>
  862. <aside class="phpdocumentor-element-found-in">
  863. <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>
  864. :
  865. <span class="phpdocumentor-element-found-in__line">73</span>
  866. </aside>
  867. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  868. <code class="phpdocumentor-code phpdocumentor-signature ">
  869. <span class="phpdocumentor-signature__visibility">protected</span>
  870. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  871. <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>
  872. </section>
  873. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  874. <span class="phpdocumentor-signature__response_type">void</span>
  875. &mdash;
  876. </article>
  877. <article
  878. class="phpdocumentor-element
  879. -method
  880. -protected
  881. "
  882. >
  883. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  884. setModuleValues()
  885. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  886. </h4>
  887. <aside class="phpdocumentor-element-found-in">
  888. <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>
  889. :
  890. <span class="phpdocumentor-element-found-in__line">82</span>
  891. </aside>
  892. <p class="phpdocumentor-summary">Sets the initial module values</p>
  893. <code class="phpdocumentor-code phpdocumentor-signature ">
  894. <span class="phpdocumentor-signature__visibility">protected</span>
  895. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  896. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  897. <span class="phpdocumentor-signature__response_type">void</span>
  898. &mdash;
  899. </article>
  900. <article
  901. class="phpdocumentor-element
  902. -method
  903. -protected
  904. "
  905. >
  906. <h4 class="phpdocumentor-element__name" id="method_setPixel">
  907. setPixel()
  908. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#method_setPixel" class="headerlink"><i class="fas fa-link"></i></a>
  909. </h4>
  910. <aside class="phpdocumentor-element-found-in">
  911. <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>
  912. :
  913. <span class="phpdocumentor-element-found-in__line">126</span>
  914. </aside>
  915. <p class="phpdocumentor-summary">draws a single pixel at the given position</p>
  916. <code class="phpdocumentor-code phpdocumentor-signature ">
  917. <span class="phpdocumentor-signature__visibility">protected</span>
  918. <span class="phpdocumentor-signature__name">setPixel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  919. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  920. <dl class="phpdocumentor-argument-list">
  921. <dt class="phpdocumentor-argument-list__entry">
  922. <span class="phpdocumentor-signature__argument__name">$x</span>
  923. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  924. </dt>
  925. <dd class="phpdocumentor-argument-list__definition">
  926. <section class="phpdocumentor-description"></section>
  927. </dd>
  928. <dt class="phpdocumentor-argument-list__entry">
  929. <span class="phpdocumentor-signature__argument__name">$y</span>
  930. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  931. </dt>
  932. <dd class="phpdocumentor-argument-list__definition">
  933. <section class="phpdocumentor-description"></section>
  934. </dd>
  935. <dt class="phpdocumentor-argument-list__entry">
  936. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  937. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  938. </dt>
  939. <dd class="phpdocumentor-argument-list__definition">
  940. <section class="phpdocumentor-description"></section>
  941. </dd>
  942. </dl>
  943. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  944. <span class="phpdocumentor-signature__response_type">void</span>
  945. &mdash;
  946. </article>
  947. <article
  948. class="phpdocumentor-element
  949. -method
  950. -protected
  951. "
  952. >
  953. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  954. toBase64DataURI()
  955. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  956. </h4>
  957. <aside class="phpdocumentor-element-found-in">
  958. <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>
  959. :
  960. <span class="phpdocumentor-element-found-in__line">120</span>
  961. </aside>
  962. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  963. <code class="phpdocumentor-code phpdocumentor-signature ">
  964. <span class="phpdocumentor-signature__visibility">protected</span>
  965. <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>
  966. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  967. <dl class="phpdocumentor-argument-list">
  968. <dt class="phpdocumentor-argument-list__entry">
  969. <span class="phpdocumentor-signature__argument__name">$data</span>
  970. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  971. </dt>
  972. <dd class="phpdocumentor-argument-list__definition">
  973. <section class="phpdocumentor-description"></section>
  974. </dd>
  975. <dt class="phpdocumentor-argument-list__entry">
  976. <span class="phpdocumentor-signature__argument__name">$mime</span>
  977. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  978. </dt>
  979. <dd class="phpdocumentor-argument-list__definition">
  980. <section class="phpdocumentor-description"></section>
  981. </dd>
  982. </dl>
  983. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  984. <span class="phpdocumentor-signature__response_type">string</span>
  985. &mdash;
  986. </article>
  987. </section>
  988. <script type="text/javascript">
  989. function loadExternalCodeSnippets(line) {
  990. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  991. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  992. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  993. var language = 'php';
  994. var code = document.createElement('code');
  995. code.className = 'language-' + language;
  996. pre.textContent = '';
  997. pre.setAttribute('data-line', line)
  998. code.textContent = 'Loading…';
  999. pre.appendChild(code);
  1000. var xhr = new XMLHttpRequest();
  1001. xhr.open('GET', src, true);
  1002. xhr.onreadystatechange = function () {
  1003. if (xhr.readyState == 4) {
  1004. if (xhr.status < 400 && xhr.responseText) {
  1005. code.textContent = xhr.responseText;
  1006. Prism.highlightElement(code);
  1007. }
  1008. else if (xhr.status >= 400) {
  1009. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1010. }
  1011. else {
  1012. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  1013. }
  1014. }
  1015. };
  1016. xhr.send(null);
  1017. });
  1018. }
  1019. var modals = document.querySelectorAll("[data-modal]");
  1020. modals.forEach(function (trigger) {
  1021. trigger.addEventListener("click", function (event) {
  1022. //event.preventDefault();
  1023. const modal = document.getElementById(trigger.dataset.modal);
  1024. modal.classList.add("phpdocumentor-modal__open");
  1025. loadExternalCodeSnippets(trigger.dataset.line)
  1026. const exits = modal.querySelectorAll("[data-exit-button]");
  1027. exits.forEach(function (exit) {
  1028. exit.addEventListener("click", function (event) {
  1029. event.preventDefault();
  1030. modal.classList.remove("phpdocumentor-modal__open");
  1031. });
  1032. });
  1033. });
  1034. });
  1035. </script>
  1036. </article>
  1037. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1038. <section class="phpdocumentor-search-results__dialog">
  1039. <header class="phpdocumentor-search-results__header">
  1040. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1041. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1042. </header>
  1043. <section class="phpdocumentor-search-results__body">
  1044. <ul class="phpdocumentor-search-results__entries"></ul>
  1045. </section>
  1046. </section>
  1047. </section>
  1048. </div>
  1049. </div>
  1050. <a href="classes/chillerlan-QRCode-Output-QRImagick.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1051. </main>
  1052. <script>
  1053. cssVars({});
  1054. </script>
  1055. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1056. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1057. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1058. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1059. </body>
  1060. </html>