chillerlan-QRCode-Output-QRImagick.html 62 KB

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