chillerlan-QRCode-Output-QRMarkupSVG.html 67 KB

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