chillerlan-QRCode-Output-QRMarkupSVG.html 69 KB

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