chillerlan-QRCode-Output-QREps.html 59 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221
  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. QREps
  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/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">23</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">Encapsulated Postscript (EPS) output</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="https://github.com/t0k4rt/phpqrcode/blob/bb29e6eb77e0a2a85bb0eb62725e0adc11ff5a90/qrvect.php#L52-L137"><abbr title="https://github.com/t0k4rt/phpqrcode/blob/bb29e6eb77e0a2a85bb0eb62725e0adc11ff5a90/qrvect.php#L52-L137">https://github.com/t0k4rt/phpqrcode/blob/bb29e6eb77e0a2a85bb0eb62725e0adc11ff5a90/qrvect.php#L52-L137</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="https://web.archive.org/web/20170818010030/http://wwwimages.adobe.com/content/dam/Adobe/en/devnet/postscript/pdfs/5002.EPSF_Spec.pdf"><abbr title="https://web.archive.org/web/20170818010030/http://wwwimages.adobe.com/content/dam/Adobe/en/devnet/postscript/pdfs/5002.EPSF_Spec.pdf">https://web.archive.org/web/20170818010030/http://wwwimages.adobe.com/content/dam/Adobe/en/devnet/postscript/pdfs/5002.EPSF_Spec.pdf</abbr></a></span>
  125. </dd>
  126. <dt class="phpdocumentor-tag-list__entry">
  127. <span class="phpdocumentor-tag__name">see</span>
  128. </dt>
  129. <dd class="phpdocumentor-tag-list__definition">
  130. <span class="phpdocumentor-tag-link"><a href="https://web.archive.org/web/20210419003859/https://www.adobe.com/content/dam/acom/en/devnet/actionscript/articles/PLRM.pdf"><abbr title="https://web.archive.org/web/20210419003859/https://www.adobe.com/content/dam/acom/en/devnet/actionscript/articles/PLRM.pdf">https://web.archive.org/web/20210419003859/https://www.adobe.com/content/dam/acom/en/devnet/actionscript/articles/PLRM.pdf</abbr></a></span>
  131. </dd>
  132. <dt class="phpdocumentor-tag-list__entry">
  133. <span class="phpdocumentor-tag__name">see</span>
  134. </dt>
  135. <dd class="phpdocumentor-tag-list__definition">
  136. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/discussions/148"><abbr title="https://github.com/chillerlan/php-qrcode/discussions/148">https://github.com/chillerlan/php-qrcode/discussions/148</abbr></a></span>
  137. </dd>
  138. </dl>
  139. <h3 id="toc">
  140. Table of Contents
  141. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  142. </h3>
  143. <dl class="phpdocumentor-table-of-contents">
  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-QROutputAbstract.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-QREps.html#method_dump">dump()</a>
  188. <span>
  189. &nbsp;: string </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-QREps.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  201. <span>
  202. &nbsp;: mixed </span>
  203. </dt>
  204. <dd>Returns a default value for either dark or light modules (return value depends on the output module)</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  206. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getModuleValue">getModuleValue()</a>
  207. <span>
  208. &nbsp;: mixed </span>
  209. </dt>
  210. <dd>Returns the final value for the given input (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-QREps.html#method_module">module()</a>
  213. <span>
  214. &nbsp;: string </span>
  215. </dt>
  216. <dd>returns a path segment for a single module</dd>
  217. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  218. <a href="classes/chillerlan-QRCode-Output-QREps.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-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  243. <span>
  244. &nbsp;: string </span>
  245. </dt>
  246. <dd>Returns a base64 data URI for the given string and mime type</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-QREps.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_length">
  261. $length
  262. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  268. :
  269. <span class="phpdocumentor-element-found-in__line">40</span>
  270. </aside>
  271. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  272. <code class="phpdocumentor-code phpdocumentor-signature ">
  273. <span class="phpdocumentor-signature__visibility">protected</span>
  274. <span class="phpdocumentor-signature__type">int</span>
  275. <span class="phpdocumentor-signature__name">$length</span>
  276. </code>
  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_matrix">
  287. $matrix
  288. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  294. :
  295. <span class="phpdocumentor-element-found-in__line">50</span>
  296. </aside>
  297. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  298. <code class="phpdocumentor-code phpdocumentor-signature ">
  299. <span class="phpdocumentor-signature__visibility">protected</span>
  300. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  301. <span class="phpdocumentor-signature__name">$matrix</span>
  302. </code>
  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_moduleCount">
  313. $moduleCount
  314. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" 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">28</span>
  322. </aside>
  323. <p class="phpdocumentor-summary">the current size of the QR matrix</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">$moduleCount</span>
  328. </code>
  329. <section class="phpdocumentor-description"></section>
  330. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  331. Tags
  332. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  333. </h5>
  334. <dl class="phpdocumentor-tag-list">
  335. <dt class="phpdocumentor-tag-list__entry">
  336. <span class="phpdocumentor-tag__name">see</span>
  337. </dt>
  338. <dd class="phpdocumentor-tag-list__definition">
  339. <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>
  340. </dd>
  341. </dl>
  342. </article>
  343. <article
  344. class="
  345. phpdocumentor-element
  346. -property
  347. -protected
  348. "
  349. >
  350. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  351. $moduleValues
  352. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  353. <span class="phpdocumentor-element__modifiers">
  354. </span>
  355. </h4>
  356. <aside class="phpdocumentor-element-found-in">
  357. <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>
  358. :
  359. <span class="phpdocumentor-element-found-in__line">45</span>
  360. </aside>
  361. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  362. <code class="phpdocumentor-code phpdocumentor-signature ">
  363. <span class="phpdocumentor-signature__visibility">protected</span>
  364. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  365. <span class="phpdocumentor-signature__name">$moduleValues</span>
  366. </code>
  367. <section class="phpdocumentor-description"></section>
  368. </article>
  369. <article
  370. class="
  371. phpdocumentor-element
  372. -property
  373. -protected
  374. "
  375. >
  376. <h4 class="phpdocumentor-element__name" id="property_options">
  377. $options
  378. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  379. <span class="phpdocumentor-element__modifiers">
  380. </span>
  381. </h4>
  382. <aside class="phpdocumentor-element-found-in">
  383. <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>
  384. :
  385. <span class="phpdocumentor-element-found-in__line">55</span>
  386. </aside>
  387. <code class="phpdocumentor-code phpdocumentor-signature ">
  388. <span class="phpdocumentor-signature__visibility">protected</span>
  389. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  390. <span class="phpdocumentor-signature__name">$options</span>
  391. </code>
  392. </article>
  393. <article
  394. class="
  395. phpdocumentor-element
  396. -property
  397. -protected
  398. "
  399. >
  400. <h4 class="phpdocumentor-element__name" id="property_scale">
  401. $scale
  402. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  403. <span class="phpdocumentor-element__modifiers">
  404. </span>
  405. </h4>
  406. <aside class="phpdocumentor-element-found-in">
  407. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  408. :
  409. <span class="phpdocumentor-element-found-in__line">35</span>
  410. </aside>
  411. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  412. <code class="phpdocumentor-code phpdocumentor-signature ">
  413. <span class="phpdocumentor-signature__visibility">protected</span>
  414. <span class="phpdocumentor-signature__type">int</span>
  415. <span class="phpdocumentor-signature__name">$scale</span>
  416. </code>
  417. <section class="phpdocumentor-description"></section>
  418. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  419. Tags
  420. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  421. </h5>
  422. <dl class="phpdocumentor-tag-list">
  423. <dt class="phpdocumentor-tag-list__entry">
  424. <span class="phpdocumentor-tag__name">see</span>
  425. </dt>
  426. <dd class="phpdocumentor-tag-list__definition">
  427. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  428. </dd>
  429. </dl>
  430. </article>
  431. </section>
  432. <section class="phpdocumentor-methods">
  433. <h3 class="phpdocumentor-elements__header" id="methods">
  434. Methods
  435. <a href="classes/chillerlan-QRCode-Output-QREps.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  436. </h3>
  437. <article
  438. class="phpdocumentor-element
  439. -method
  440. -public
  441. "
  442. >
  443. <h4 class="phpdocumentor-element__name" id="method___construct">
  444. __construct()
  445. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  446. </h4>
  447. <aside class="phpdocumentor-element-found-in">
  448. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  449. :
  450. <span class="phpdocumentor-element-found-in__line">60</span>
  451. </aside>
  452. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  453. <code class="phpdocumentor-code phpdocumentor-signature ">
  454. <span class="phpdocumentor-signature__visibility">public</span>
  455. <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>
  456. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  457. <dl class="phpdocumentor-argument-list">
  458. <dt class="phpdocumentor-argument-list__entry">
  459. <span class="phpdocumentor-signature__argument__name">$options</span>
  460. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  461. </dt>
  462. <dd class="phpdocumentor-argument-list__definition">
  463. <section class="phpdocumentor-description"></section>
  464. </dd>
  465. <dt class="phpdocumentor-argument-list__entry">
  466. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  467. : <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>
  468. </dt>
  469. <dd class="phpdocumentor-argument-list__definition">
  470. <section class="phpdocumentor-description"></section>
  471. </dd>
  472. </dl>
  473. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  474. <span class="phpdocumentor-signature__response_type">mixed</span>
  475. &mdash;
  476. </article>
  477. <article
  478. class="phpdocumentor-element
  479. -method
  480. -public
  481. "
  482. >
  483. <h4 class="phpdocumentor-element__name" id="method_dump">
  484. dump()
  485. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  486. </h4>
  487. <aside class="phpdocumentor-element-found-in">
  488. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  489. :
  490. <span class="phpdocumentor-element-found-in__line">68</span>
  491. </aside>
  492. <code class="phpdocumentor-code phpdocumentor-signature ">
  493. <span class="phpdocumentor-signature__visibility">public</span>
  494. <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</span></code>
  495. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  496. <dl class="phpdocumentor-argument-list">
  497. <dt class="phpdocumentor-argument-list__entry">
  498. <span class="phpdocumentor-signature__argument__name">$file</span>
  499. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  500. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  501. <dd class="phpdocumentor-argument-list__definition">
  502. <section class="phpdocumentor-description"></section>
  503. </dd>
  504. </dl>
  505. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  506. Tags
  507. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  508. </h5>
  509. <dl class="phpdocumentor-tag-list">
  510. <dt class="phpdocumentor-tag-list__entry">
  511. <span class="phpdocumentor-tag__name">inheritDoc</span>
  512. </dt>
  513. <dd class="phpdocumentor-tag-list__definition">
  514. </dd>
  515. </dl>
  516. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  517. <span class="phpdocumentor-signature__response_type">string</span>
  518. &mdash;
  519. </article>
  520. <article
  521. class="phpdocumentor-element
  522. -method
  523. -protected
  524. "
  525. >
  526. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  527. collectModules()
  528. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  529. </h4>
  530. <aside class="phpdocumentor-element-found-in">
  531. <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>
  532. :
  533. <span class="phpdocumentor-element-found-in__line">158</span>
  534. </aside>
  535. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  536. returns an array with the transformed modules</p>
  537. <code class="phpdocumentor-code phpdocumentor-signature ">
  538. <span class="phpdocumentor-signature__visibility">protected</span>
  539. <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>
  540. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  541. <p>$x - current column
  542. $y - current row
  543. $M_TYPE - field value
  544. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  545. </section>
  546. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  547. <dl class="phpdocumentor-argument-list">
  548. <dt class="phpdocumentor-argument-list__entry">
  549. <span class="phpdocumentor-signature__argument__name">$transform</span>
  550. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  551. </dt>
  552. <dd class="phpdocumentor-argument-list__definition">
  553. <section class="phpdocumentor-description"></section>
  554. </dd>
  555. </dl>
  556. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  557. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  558. &mdash;
  559. </article>
  560. <article
  561. class="phpdocumentor-element
  562. -method
  563. -protected
  564. "
  565. >
  566. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  567. getDefaultModuleValue()
  568. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  569. </h4>
  570. <aside class="phpdocumentor-element-found-in">
  571. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  572. :
  573. <span class="phpdocumentor-element-found-in__line">61</span>
  574. </aside>
  575. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output module)</p>
  576. <code class="phpdocumentor-code phpdocumentor-signature ">
  577. <span class="phpdocumentor-signature__visibility">protected</span>
  578. <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>
  579. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  580. <dl class="phpdocumentor-argument-list">
  581. <dt class="phpdocumentor-argument-list__entry">
  582. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  583. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  584. </dt>
  585. <dd class="phpdocumentor-argument-list__definition">
  586. <section class="phpdocumentor-description"></section>
  587. </dd>
  588. </dl>
  589. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  590. Tags
  591. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  592. </h5>
  593. <dl class="phpdocumentor-tag-list">
  594. <dt class="phpdocumentor-tag-list__entry">
  595. <span class="phpdocumentor-tag__name">inheritDoc</span>
  596. </dt>
  597. <dd class="phpdocumentor-tag-list__definition">
  598. </dd>
  599. </dl>
  600. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  601. <span class="phpdocumentor-signature__response_type">mixed</span>
  602. &mdash;
  603. </article>
  604. <article
  605. class="phpdocumentor-element
  606. -method
  607. -protected
  608. "
  609. >
  610. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  611. getModuleValue()
  612. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  613. </h4>
  614. <aside class="phpdocumentor-element-found-in">
  615. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  616. :
  617. <span class="phpdocumentor-element-found-in__line">47</span>
  618. </aside>
  619. <p class="phpdocumentor-summary">Returns the final value for the given input (return value depends on the output module)</p>
  620. <code class="phpdocumentor-code phpdocumentor-signature ">
  621. <span class="phpdocumentor-signature__visibility">protected</span>
  622. <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>
  623. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  624. <dl class="phpdocumentor-argument-list">
  625. <dt class="phpdocumentor-argument-list__entry">
  626. <span class="phpdocumentor-signature__argument__name">$value</span>
  627. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  628. </dt>
  629. <dd class="phpdocumentor-argument-list__definition">
  630. </dd>
  631. </dl>
  632. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  633. Tags
  634. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  635. </h5>
  636. <dl class="phpdocumentor-tag-list">
  637. <dt class="phpdocumentor-tag-list__entry">
  638. <span class="phpdocumentor-tag__name">inheritDoc</span>
  639. </dt>
  640. <dd class="phpdocumentor-tag-list__definition">
  641. </dd>
  642. </dl>
  643. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  644. <span class="phpdocumentor-signature__response_type">mixed</span>
  645. &mdash;
  646. </article>
  647. <article
  648. class="phpdocumentor-element
  649. -method
  650. -protected
  651. "
  652. >
  653. <h4 class="phpdocumentor-element__name" id="method_module">
  654. module()
  655. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  656. </h4>
  657. <aside class="phpdocumentor-element-found-in">
  658. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  659. :
  660. <span class="phpdocumentor-element-found-in__line">113</span>
  661. </aside>
  662. <p class="phpdocumentor-summary">returns a path segment for a single module</p>
  663. <code class="phpdocumentor-code phpdocumentor-signature ">
  664. <span class="phpdocumentor-signature__visibility">protected</span>
  665. <span class="phpdocumentor-signature__name">module</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  666. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  667. <dl class="phpdocumentor-argument-list">
  668. <dt class="phpdocumentor-argument-list__entry">
  669. <span class="phpdocumentor-signature__argument__name">$x</span>
  670. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  671. </dt>
  672. <dd class="phpdocumentor-argument-list__definition">
  673. <section class="phpdocumentor-description"></section>
  674. </dd>
  675. <dt class="phpdocumentor-argument-list__entry">
  676. <span class="phpdocumentor-signature__argument__name">$y</span>
  677. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  678. </dt>
  679. <dd class="phpdocumentor-argument-list__definition">
  680. <section class="phpdocumentor-description"></section>
  681. </dd>
  682. </dl>
  683. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  684. <span class="phpdocumentor-signature__response_type">string</span>
  685. &mdash;
  686. </article>
  687. <article
  688. class="phpdocumentor-element
  689. -method
  690. -protected
  691. "
  692. >
  693. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  694. moduleValueIsValid()
  695. <a href="classes/chillerlan-QRCode-Output-QREps.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  696. </h4>
  697. <aside class="phpdocumentor-element-found-in">
  698. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QREps.php"><a href="files/src-output-qreps.html"><abbr title="src/Output/QREps.php">QREps.php</abbr></a></abbr>
  699. :
  700. <span class="phpdocumentor-element-found-in__line">28</span>
  701. </aside>
  702. <p class="phpdocumentor-summary">Determines whether the given value is valid</p>
  703. <code class="phpdocumentor-code phpdocumentor-signature ">
  704. <span class="phpdocumentor-signature__visibility">protected</span>
  705. <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>
  706. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  707. <dl class="phpdocumentor-argument-list">
  708. <dt class="phpdocumentor-argument-list__entry">
  709. <span class="phpdocumentor-signature__argument__name">$value</span>
  710. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  711. </dt>
  712. <dd class="phpdocumentor-argument-list__definition">
  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">bool</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_saveToFile">
  737. saveToFile()
  738. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" 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/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  742. :
  743. <span class="phpdocumentor-element-found-in__line">132</span>
  744. </aside>
  745. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  746. <code class="phpdocumentor-code phpdocumentor-signature ">
  747. <span class="phpdocumentor-signature__visibility">protected</span>
  748. <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>
  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">$data</span>
  753. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  754. </dt>
  755. <dd class="phpdocumentor-argument-list__definition">
  756. <section class="phpdocumentor-description"></section>
  757. </dd>
  758. <dt class="phpdocumentor-argument-list__entry">
  759. <span class="phpdocumentor-signature__argument__name">$file</span>
  760. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  761. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  762. <dd class="phpdocumentor-argument-list__definition">
  763. <section class="phpdocumentor-description"></section>
  764. </dd>
  765. </dl>
  766. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  767. Tags
  768. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  769. </h5>
  770. <dl class="phpdocumentor-tag-list">
  771. <dt class="phpdocumentor-tag-list__entry">
  772. <span class="phpdocumentor-tag__name">see</span>
  773. </dt>
  774. <dd class="phpdocumentor-tag-list__definition">
  775. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  776. </dd>
  777. <dt class="phpdocumentor-tag-list__entry">
  778. <span class="phpdocumentor-tag__name">see</span>
  779. </dt>
  780. <dd class="phpdocumentor-tag-list__definition">
  781. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  782. </dd>
  783. <dt class="phpdocumentor-tag-list__entry">
  784. <span class="phpdocumentor-tag__name">throws</span>
  785. </dt>
  786. <dd class="phpdocumentor-tag-list__definition">
  787. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  788. </dd>
  789. </dl>
  790. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  791. <span class="phpdocumentor-signature__response_type">void</span>
  792. &mdash;
  793. </article>
  794. <article
  795. class="phpdocumentor-element
  796. -method
  797. -protected
  798. "
  799. >
  800. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  801. setMatrixDimensions()
  802. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  803. </h4>
  804. <aside class="phpdocumentor-element-found-in">
  805. <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>
  806. :
  807. <span class="phpdocumentor-element-found-in__line">73</span>
  808. </aside>
  809. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  810. <code class="phpdocumentor-code phpdocumentor-signature ">
  811. <span class="phpdocumentor-signature__visibility">protected</span>
  812. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  813. <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>
  814. </section>
  815. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  816. <span class="phpdocumentor-signature__response_type">void</span>
  817. &mdash;
  818. </article>
  819. <article
  820. class="phpdocumentor-element
  821. -method
  822. -protected
  823. "
  824. >
  825. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  826. setModuleValues()
  827. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  828. </h4>
  829. <aside class="phpdocumentor-element-found-in">
  830. <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>
  831. :
  832. <span class="phpdocumentor-element-found-in__line">82</span>
  833. </aside>
  834. <p class="phpdocumentor-summary">Sets the initial module values</p>
  835. <code class="phpdocumentor-code phpdocumentor-signature ">
  836. <span class="phpdocumentor-signature__visibility">protected</span>
  837. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  838. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  839. <span class="phpdocumentor-signature__response_type">void</span>
  840. &mdash;
  841. </article>
  842. <article
  843. class="phpdocumentor-element
  844. -method
  845. -protected
  846. "
  847. >
  848. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  849. toBase64DataURI()
  850. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  851. </h4>
  852. <aside class="phpdocumentor-element-found-in">
  853. <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>
  854. :
  855. <span class="phpdocumentor-element-found-in__line">120</span>
  856. </aside>
  857. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  858. <code class="phpdocumentor-code phpdocumentor-signature ">
  859. <span class="phpdocumentor-signature__visibility">protected</span>
  860. <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>
  861. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  862. <dl class="phpdocumentor-argument-list">
  863. <dt class="phpdocumentor-argument-list__entry">
  864. <span class="phpdocumentor-signature__argument__name">$data</span>
  865. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  866. </dt>
  867. <dd class="phpdocumentor-argument-list__definition">
  868. <section class="phpdocumentor-description"></section>
  869. </dd>
  870. <dt class="phpdocumentor-argument-list__entry">
  871. <span class="phpdocumentor-signature__argument__name">$mime</span>
  872. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  873. </dt>
  874. <dd class="phpdocumentor-argument-list__definition">
  875. <section class="phpdocumentor-description"></section>
  876. </dd>
  877. </dl>
  878. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  879. <span class="phpdocumentor-signature__response_type">string</span>
  880. &mdash;
  881. </article>
  882. </section>
  883. <script type="text/javascript">
  884. function loadExternalCodeSnippets(line) {
  885. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  886. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  887. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  888. var language = 'php';
  889. var code = document.createElement('code');
  890. code.className = 'language-' + language;
  891. pre.textContent = '';
  892. pre.setAttribute('data-line', line)
  893. code.textContent = 'Loading…';
  894. pre.appendChild(code);
  895. var xhr = new XMLHttpRequest();
  896. xhr.open('GET', src, true);
  897. xhr.onreadystatechange = function () {
  898. if (xhr.readyState == 4) {
  899. if (xhr.status < 400 && xhr.responseText) {
  900. code.textContent = xhr.responseText;
  901. Prism.highlightElement(code);
  902. }
  903. else if (xhr.status >= 400) {
  904. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  905. }
  906. else {
  907. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  908. }
  909. }
  910. };
  911. xhr.send(null);
  912. });
  913. }
  914. var modals = document.querySelectorAll("[data-modal]");
  915. modals.forEach(function (trigger) {
  916. trigger.addEventListener("click", function (event) {
  917. //event.preventDefault();
  918. const modal = document.getElementById(trigger.dataset.modal);
  919. modal.classList.add("phpdocumentor-modal__open");
  920. loadExternalCodeSnippets(trigger.dataset.line)
  921. const exits = modal.querySelectorAll("[data-exit-button]");
  922. exits.forEach(function (exit) {
  923. exit.addEventListener("click", function (event) {
  924. event.preventDefault();
  925. modal.classList.remove("phpdocumentor-modal__open");
  926. });
  927. });
  928. });
  929. });
  930. </script>
  931. </article>
  932. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  933. <section class="phpdocumentor-search-results__dialog">
  934. <header class="phpdocumentor-search-results__header">
  935. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  936. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  937. </header>
  938. <section class="phpdocumentor-search-results__body">
  939. <ul class="phpdocumentor-search-results__entries"></ul>
  940. </section>
  941. </section>
  942. </section>
  943. </div>
  944. </div>
  945. <a href="classes/chillerlan-QRCode-Output-QREps.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  946. </main>
  947. <script>
  948. cssVars({});
  949. </script>
  950. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  951. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  952. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  953. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  954. </body>
  955. </html>