chillerlan-QRCode-Output-QRMarkupSVG.html 116 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377
  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=Open+Sans:wght@100;200;300;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/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. </ul>
  59. </nav>
  60. </header>
  61. <main class="phpdocumentor">
  62. <div class="phpdocumentor-section">
  63. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  64. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  65. Menu
  66. </label>
  67. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  68. <section class="phpdocumentor-sidebar__category">
  69. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  70. <h4 class="phpdocumentor-sidebar__root-namespace">
  71. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  72. </h4>
  73. <ul class="phpdocumentor-list">
  74. <li>
  75. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  76. </li>
  77. <li>
  78. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  79. </li>
  80. </ul>
  81. </section>
  82. <section class="phpdocumentor-sidebar__category">
  83. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  84. <h4 class="phpdocumentor-sidebar__root-namespace">
  85. <a href="packages/Application.html" class="">Application</a>
  86. </h4>
  87. </section>
  88. <section class="phpdocumentor-sidebar__category">
  89. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  92. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  93. </section>
  94. <section class="phpdocumentor-sidebar__category">
  95. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  96. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  97. </section>
  98. </aside>
  99. <div class="phpdocumentor-column -nine phpdocumentor-content">
  100. <section>
  101. <ul class="phpdocumentor-breadcrumbs">
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  103. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  104. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  105. </ul>
  106. <article class="phpdocumentor-element -class">
  107. <h2 class="phpdocumentor-content__title">
  108. QRMarkupSVG
  109. <span class="phpdocumentor-element__extends">
  110. extends <a href="classes/chillerlan-QRCode-Output-QRMarkup.html"><abbr title="\chillerlan\QRCode\Output\QRMarkup">QRMarkup</abbr></a>
  111. </span>
  112. <div class="phpdocumentor-element__package">
  113. in package
  114. <ul class="phpdocumentor-breadcrumbs">
  115. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  116. </ul>
  117. </div>
  118. </h2>
  119. <div class="phpdocumentor-label-line">
  120. </div>
  121. <aside class="phpdocumentor-element-found-in">
  122. <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>
  123. :
  124. <span class="phpdocumentor-element-found-in__line">24</span>
  125. </aside>
  126. <p class="phpdocumentor-summary">SVG output</p>
  127. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  128. Tags
  129. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  130. </h5>
  131. <dl class="phpdocumentor-tag-list">
  132. <dt class="phpdocumentor-tag-list__entry">
  133. <span class="phpdocumentor-tag__name">see</span>
  134. </dt>
  135. <dd class="phpdocumentor-tag-list__definition">
  136. <span class="phpdocumentor-tag-link"><a href="https://github.com/codemasher/php-qrcode/pull/5">https://github.com/codemasher/php-qrcode/pull/5</a></span>
  137. </dd>
  138. <dt class="phpdocumentor-tag-list__entry">
  139. <span class="phpdocumentor-tag__name">see</span>
  140. </dt>
  141. <dd class="phpdocumentor-tag-list__definition">
  142. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG">https://developer.mozilla.org/en-US/docs/Web/SVG</a></span>
  143. </dd>
  144. <dt class="phpdocumentor-tag-list__entry">
  145. <span class="phpdocumentor-tag__name">see</span>
  146. </dt>
  147. <dd class="phpdocumentor-tag-list__definition">
  148. <span class="phpdocumentor-tag-link"><a href="https://www.sarasoueidan.com/demos/interactive-svg-coordinate-system/">https://www.sarasoueidan.com/demos/interactive-svg-coordinate-system/</a></span>
  149. </dd>
  150. <dt class="phpdocumentor-tag-list__entry">
  151. <span class="phpdocumentor-tag__name">see</span>
  152. </dt>
  153. <dd class="phpdocumentor-tag-list__definition">
  154. <span class="phpdocumentor-tag-link"><a href="http://apex.infogridpacific.com/SVG/svg-tutorial-contents.html">http://apex.infogridpacific.com/SVG/svg-tutorial-contents.html</a></span>
  155. </dd>
  156. </dl>
  157. <h3 id="toc">
  158. Table of Contents
  159. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  160. </h3>
  161. <h4 id="toc-properties">
  162. Properties
  163. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  164. </h4>
  165. <dl class="phpdocumentor-table-of-contents">
  166. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  167. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius</a>
  168. <span>
  169. &nbsp;: float </span>
  170. </dt>
  171. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  172. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths</a>
  173. <span>
  174. &nbsp;: bool </span>
  175. </dt>
  176. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  177. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules</a>
  178. <span>
  179. &nbsp;: bool </span>
  180. </dt>
  181. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  182. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules</a>
  183. <span>
  184. &nbsp;: bool </span>
  185. </dt>
  186. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  187. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol</a>
  188. <span>
  189. &nbsp;: string </span>
  190. </dt>
  191. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  192. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect</a>
  193. <span>
  194. &nbsp;: array&lt;string|int, mixed&gt; </span>
  195. </dt>
  196. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  197. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare</a>
  198. <span>
  199. &nbsp;: array&lt;string|int, mixed&gt; </span>
  200. </dt>
  201. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  202. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  203. <span>
  204. &nbsp;: int </span>
  205. </dt>
  206. <dd>the side length of the QR image (modules * scale)</dd>
  207. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  208. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  209. <span>
  210. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  211. </dt>
  212. <dd>the (filled) data matrix object</dd>
  213. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  214. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  215. <span>
  216. &nbsp;: int </span>
  217. </dt>
  218. <dd>the current size of the QR matrix</dd>
  219. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  220. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  221. <span>
  222. &nbsp;: array&lt;string|int, mixed&gt; </span>
  223. </dt>
  224. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  225. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  226. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  227. <span>
  228. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  229. </dt>
  230. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  231. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  232. <span>
  233. &nbsp;: int </span>
  234. </dt>
  235. </dl>
  236. <h4 id="toc-methods">
  237. Methods
  238. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  239. </h4>
  240. <dl class="phpdocumentor-table-of-contents">
  241. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  242. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  243. <span>
  244. &nbsp;: mixed </span>
  245. </dt>
  246. <dd>QROutputAbstract constructor.</dd>
  247. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  248. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump">dump()</a>
  249. <span>
  250. &nbsp;: string </span>
  251. </dt>
  252. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  253. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  254. <span>
  255. &nbsp;: bool </span>
  256. </dt>
  257. <dd>note: we&#039;re not necessarily validating the several values, just checking the general syntax
  258. note: css4 colors are not included</dd>
  259. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  260. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  261. <span>
  262. &nbsp;: array&lt;string|int, mixed&gt; </span>
  263. </dt>
  264. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  265. returns an array with the transformed modules</dd>
  266. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  267. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a>
  268. <span>
  269. &nbsp;: void </span>
  270. </dt>
  271. <dd>Creates copies of several QROptions values to avoid calling the magic getters
  272. in long loops for a significant performance increase.</dd>
  273. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  274. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_createMarkup">createMarkup()</a>
  275. <span>
  276. &nbsp;: string </span>
  277. </dt>
  278. <dd>returns the fully parsed and rendered markup string for the given input</dd>
  279. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  280. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getCssClass">getCssClass()</a>
  281. <span>
  282. &nbsp;: string </span>
  283. </dt>
  284. <dd>returns a string with all css classes for the current element</dd>
  285. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  286. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  287. <span>
  288. &nbsp;: mixed|null </span>
  289. </dt>
  290. <dd>Returns a default value for either dark or light modules</dd>
  291. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  292. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  293. <span>
  294. &nbsp;: mixed </span>
  295. </dt>
  296. <dd>Returns the prepared value for the given $M_TYPE</dd>
  297. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  298. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  299. <span>
  300. &nbsp;: mixed|null </span>
  301. </dt>
  302. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  303. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  304. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getOutputDimensions">getOutputDimensions()</a>
  305. <span>
  306. &nbsp;: array&lt;string|int, mixed&gt; </span>
  307. </dt>
  308. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  309. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getViewBox">getViewBox()</a>
  310. <span>
  311. &nbsp;: string </span>
  312. </dt>
  313. <dd>returns the value for the SVG viewBox attribute</dd>
  314. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  315. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_header">header()</a>
  316. <span>
  317. &nbsp;: string </span>
  318. </dt>
  319. <dd>returns the &lt;svg&gt; header with the given options parsed</dd>
  320. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  321. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_module">module()</a>
  322. <span>
  323. &nbsp;: string </span>
  324. </dt>
  325. <dd>returns a path segment for a single module</dd>
  326. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  327. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_path">path()</a>
  328. <span>
  329. &nbsp;: string </span>
  330. </dt>
  331. <dd>renders and returns a single &lt;path&gt; element</dd>
  332. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  333. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_paths">paths()</a>
  334. <span>
  335. &nbsp;: string </span>
  336. </dt>
  337. <dd>returns one or more SVG &lt;path&gt; elements</dd>
  338. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  339. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a>
  340. <span>
  341. &nbsp;: mixed|null </span>
  342. </dt>
  343. <dd>Prepares the value for the given input ()</dd>
  344. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  345. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  346. <span>
  347. &nbsp;: void </span>
  348. </dt>
  349. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  350. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  351. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  352. <span>
  353. &nbsp;: void </span>
  354. </dt>
  355. <dd>Sets/updates the matrix dimensions</dd>
  356. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  357. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  358. <span>
  359. &nbsp;: void </span>
  360. </dt>
  361. <dd>Sets the initial module values</dd>
  362. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  363. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  364. <span>
  365. &nbsp;: string </span>
  366. </dt>
  367. <dd>Returns a base64 data URI for the given string and mime type</dd>
  368. </dl>
  369. <section class="phpdocumentor-properties">
  370. <h3 class="phpdocumentor-elements__header" id="properties">
  371. Properties
  372. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  373. </h3>
  374. <article
  375. class="
  376. phpdocumentor-element
  377. -property
  378. -protected
  379. "
  380. >
  381. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  382. $circleRadius
  383. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  384. <span class="phpdocumentor-element__modifiers">
  385. </span>
  386. </h4>
  387. <aside class="phpdocumentor-element-found-in">
  388. <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>
  389. :
  390. <span class="phpdocumentor-element-found-in__line">65</span>
  391. </aside>
  392. <code class="phpdocumentor-code phpdocumentor-signature ">
  393. <span class="phpdocumentor-signature__visibility">protected</span>
  394. <span class="phpdocumentor-signature__type">float</span>
  395. <span class="phpdocumentor-signature__name">$circleRadius</span>
  396. </code>
  397. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  398. Tags
  399. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius#tags" class="headerlink"><i class="fas fa-link"></i></a>
  400. </h5>
  401. <dl class="phpdocumentor-tag-list">
  402. <dt class="phpdocumentor-tag-list__entry">
  403. <span class="phpdocumentor-tag__name">see</span>
  404. </dt>
  405. <dd class="phpdocumentor-tag-list__definition">
  406. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$circleRadius">QROptions::$circleRadius</abbr></span>
  407. </dd>
  408. </dl>
  409. </article>
  410. <article
  411. class="
  412. phpdocumentor-element
  413. -property
  414. -protected
  415. "
  416. >
  417. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  418. $connectPaths
  419. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  420. <span class="phpdocumentor-element__modifiers">
  421. </span>
  422. </h4>
  423. <aside class="phpdocumentor-element-found-in">
  424. <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>
  425. :
  426. <span class="phpdocumentor-element-found-in__line">53</span>
  427. </aside>
  428. <code class="phpdocumentor-code phpdocumentor-signature ">
  429. <span class="phpdocumentor-signature__visibility">protected</span>
  430. <span class="phpdocumentor-signature__type">bool</span>
  431. <span class="phpdocumentor-signature__name">$connectPaths</span>
  432. </code>
  433. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  434. Tags
  435. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  436. </h5>
  437. <dl class="phpdocumentor-tag-list">
  438. <dt class="phpdocumentor-tag-list__entry">
  439. <span class="phpdocumentor-tag__name">see</span>
  440. </dt>
  441. <dd class="phpdocumentor-tag-list__definition">
  442. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$connectPaths">QROptions::$connectPaths</abbr></span>
  443. </dd>
  444. </dl>
  445. </article>
  446. <article
  447. class="
  448. phpdocumentor-element
  449. -property
  450. -protected
  451. "
  452. >
  453. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  454. $drawCircularModules
  455. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  456. <span class="phpdocumentor-element__modifiers">
  457. </span>
  458. </h4>
  459. <aside class="phpdocumentor-element-found-in">
  460. <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>
  461. :
  462. <span class="phpdocumentor-element-found-in__line">61</span>
  463. </aside>
  464. <code class="phpdocumentor-code phpdocumentor-signature ">
  465. <span class="phpdocumentor-signature__visibility">protected</span>
  466. <span class="phpdocumentor-signature__type">bool</span>
  467. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  468. </code>
  469. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  470. Tags
  471. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  472. </h5>
  473. <dl class="phpdocumentor-tag-list">
  474. <dt class="phpdocumentor-tag-list__entry">
  475. <span class="phpdocumentor-tag__name">see</span>
  476. </dt>
  477. <dd class="phpdocumentor-tag-list__definition">
  478. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawCircularModules">QROptions::$drawCircularModules</abbr></span>
  479. </dd>
  480. </dl>
  481. </article>
  482. <article
  483. class="
  484. phpdocumentor-element
  485. -property
  486. -protected
  487. "
  488. >
  489. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  490. $drawLightModules
  491. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  492. <span class="phpdocumentor-element__modifiers">
  493. </span>
  494. </h4>
  495. <aside class="phpdocumentor-element-found-in">
  496. <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>
  497. :
  498. <span class="phpdocumentor-element-found-in__line">59</span>
  499. </aside>
  500. <code class="phpdocumentor-code phpdocumentor-signature ">
  501. <span class="phpdocumentor-signature__visibility">protected</span>
  502. <span class="phpdocumentor-signature__type">bool</span>
  503. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  504. </code>
  505. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  506. Tags
  507. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  508. </h5>
  509. <dl class="phpdocumentor-tag-list">
  510. <dt class="phpdocumentor-tag-list__entry">
  511. <span class="phpdocumentor-tag__name">see</span>
  512. </dt>
  513. <dd class="phpdocumentor-tag-list__definition">
  514. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawLightModules">QROptions::$drawLightModules</abbr></span>
  515. </dd>
  516. </dl>
  517. </article>
  518. <article
  519. class="
  520. phpdocumentor-element
  521. -property
  522. -protected
  523. "
  524. >
  525. <h4 class="phpdocumentor-element__name" id="property_eol">
  526. $eol
  527. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  528. <span class="phpdocumentor-element__modifiers">
  529. </span>
  530. </h4>
  531. <aside class="phpdocumentor-element-found-in">
  532. <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>
  533. :
  534. <span class="phpdocumentor-element-found-in__line">57</span>
  535. </aside>
  536. <code class="phpdocumentor-code phpdocumentor-signature ">
  537. <span class="phpdocumentor-signature__visibility">protected</span>
  538. <span class="phpdocumentor-signature__type">string</span>
  539. <span class="phpdocumentor-signature__name">$eol</span>
  540. </code>
  541. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  542. Tags
  543. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol#tags" class="headerlink"><i class="fas fa-link"></i></a>
  544. </h5>
  545. <dl class="phpdocumentor-tag-list">
  546. <dt class="phpdocumentor-tag-list__entry">
  547. <span class="phpdocumentor-tag__name">see</span>
  548. </dt>
  549. <dd class="phpdocumentor-tag-list__definition">
  550. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$eol">QROptions::$eol</abbr></span>
  551. </dd>
  552. </dl>
  553. </article>
  554. <article
  555. class="
  556. phpdocumentor-element
  557. -property
  558. -protected
  559. "
  560. >
  561. <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
  562. $excludeFromConnect
  563. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  564. <span class="phpdocumentor-element__modifiers">
  565. </span>
  566. </h4>
  567. <aside class="phpdocumentor-element-found-in">
  568. <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>
  569. :
  570. <span class="phpdocumentor-element-found-in__line">55</span>
  571. </aside>
  572. <code class="phpdocumentor-code phpdocumentor-signature ">
  573. <span class="phpdocumentor-signature__visibility">protected</span>
  574. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  575. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  576. </code>
  577. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  578. Tags
  579. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect#tags" class="headerlink"><i class="fas fa-link"></i></a>
  580. </h5>
  581. <dl class="phpdocumentor-tag-list">
  582. <dt class="phpdocumentor-tag-list__entry">
  583. <span class="phpdocumentor-tag__name">see</span>
  584. </dt>
  585. <dd class="phpdocumentor-tag-list__definition">
  586. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$excludeFromConnect">QROptions::$excludeFromConnect</abbr></span>
  587. </dd>
  588. </dl>
  589. </article>
  590. <article
  591. class="
  592. phpdocumentor-element
  593. -property
  594. -protected
  595. "
  596. >
  597. <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
  598. $keepAsSquare
  599. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  600. <span class="phpdocumentor-element__modifiers">
  601. </span>
  602. </h4>
  603. <aside class="phpdocumentor-element-found-in">
  604. <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>
  605. :
  606. <span class="phpdocumentor-element-found-in__line">63</span>
  607. </aside>
  608. <code class="phpdocumentor-code phpdocumentor-signature ">
  609. <span class="phpdocumentor-signature__visibility">protected</span>
  610. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  611. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  612. </code>
  613. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  614. Tags
  615. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare#tags" class="headerlink"><i class="fas fa-link"></i></a>
  616. </h5>
  617. <dl class="phpdocumentor-tag-list">
  618. <dt class="phpdocumentor-tag-list__entry">
  619. <span class="phpdocumentor-tag__name">see</span>
  620. </dt>
  621. <dd class="phpdocumentor-tag-list__definition">
  622. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$keepAsSquare">QROptions::$keepAsSquare</abbr></span>
  623. </dd>
  624. </dl>
  625. </article>
  626. <article
  627. class="
  628. phpdocumentor-element
  629. -property
  630. -protected
  631. "
  632. >
  633. <h4 class="phpdocumentor-element__name" id="property_length">
  634. $length
  635. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  636. <span class="phpdocumentor-element__modifiers">
  637. </span>
  638. </h4>
  639. <aside class="phpdocumentor-element-found-in">
  640. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  641. :
  642. <span class="phpdocumentor-element-found-in__line">33</span>
  643. </aside>
  644. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  645. <code class="phpdocumentor-code phpdocumentor-signature ">
  646. <span class="phpdocumentor-signature__visibility">protected</span>
  647. <span class="phpdocumentor-signature__type">int</span>
  648. <span class="phpdocumentor-signature__name">$length</span>
  649. </code>
  650. </article>
  651. <article
  652. class="
  653. phpdocumentor-element
  654. -property
  655. -protected
  656. "
  657. >
  658. <h4 class="phpdocumentor-element__name" id="property_matrix">
  659. $matrix
  660. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  661. <span class="phpdocumentor-element__modifiers">
  662. </span>
  663. </h4>
  664. <aside class="phpdocumentor-element-found-in">
  665. <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>
  666. :
  667. <span class="phpdocumentor-element-found-in__line">43</span>
  668. </aside>
  669. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  670. <code class="phpdocumentor-code phpdocumentor-signature ">
  671. <span class="phpdocumentor-signature__visibility">protected</span>
  672. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  673. <span class="phpdocumentor-signature__name">$matrix</span>
  674. </code>
  675. </article>
  676. <article
  677. class="
  678. phpdocumentor-element
  679. -property
  680. -protected
  681. "
  682. >
  683. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  684. $moduleCount
  685. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  686. <span class="phpdocumentor-element__modifiers">
  687. </span>
  688. </h4>
  689. <aside class="phpdocumentor-element-found-in">
  690. <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>
  691. :
  692. <span class="phpdocumentor-element-found-in__line">28</span>
  693. </aside>
  694. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  695. <code class="phpdocumentor-code phpdocumentor-signature ">
  696. <span class="phpdocumentor-signature__visibility">protected</span>
  697. <span class="phpdocumentor-signature__type">int</span>
  698. <span class="phpdocumentor-signature__name">$moduleCount</span>
  699. </code>
  700. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  701. Tags
  702. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  703. </h5>
  704. <dl class="phpdocumentor-tag-list">
  705. <dt class="phpdocumentor-tag-list__entry">
  706. <span class="phpdocumentor-tag__name">see</span>
  707. </dt>
  708. <dd class="phpdocumentor-tag-list__definition">
  709. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getSize()">QRMatrix::getSize()</abbr></a></span>
  710. </dd>
  711. </dl>
  712. </article>
  713. <article
  714. class="
  715. phpdocumentor-element
  716. -property
  717. -protected
  718. "
  719. >
  720. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  721. $moduleValues
  722. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  723. <span class="phpdocumentor-element__modifiers">
  724. </span>
  725. </h4>
  726. <aside class="phpdocumentor-element-found-in">
  727. <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>
  728. :
  729. <span class="phpdocumentor-element-found-in__line">38</span>
  730. </aside>
  731. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  732. <code class="phpdocumentor-code phpdocumentor-signature ">
  733. <span class="phpdocumentor-signature__visibility">protected</span>
  734. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  735. <span class="phpdocumentor-signature__name">$moduleValues</span>
  736. </code>
  737. </article>
  738. <article
  739. class="
  740. phpdocumentor-element
  741. -property
  742. -protected
  743. "
  744. >
  745. <h4 class="phpdocumentor-element__name" id="property_options">
  746. $options
  747. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  748. <span class="phpdocumentor-element__modifiers">
  749. </span>
  750. </h4>
  751. <aside class="phpdocumentor-element-found-in">
  752. <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>
  753. :
  754. <span class="phpdocumentor-element-found-in__line">48</span>
  755. </aside>
  756. <code class="phpdocumentor-code phpdocumentor-signature ">
  757. <span class="phpdocumentor-signature__visibility">protected</span>
  758. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  759. <span class="phpdocumentor-signature__name">$options</span>
  760. </code>
  761. </article>
  762. <article
  763. class="
  764. phpdocumentor-element
  765. -property
  766. -protected
  767. "
  768. >
  769. <h4 class="phpdocumentor-element__name" id="property_scale">
  770. $scale
  771. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  772. <span class="phpdocumentor-element__modifiers">
  773. </span>
  774. </h4>
  775. <aside class="phpdocumentor-element-found-in">
  776. <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>
  777. :
  778. <span class="phpdocumentor-element-found-in__line">51</span>
  779. </aside>
  780. <code class="phpdocumentor-code phpdocumentor-signature ">
  781. <span class="phpdocumentor-signature__visibility">protected</span>
  782. <span class="phpdocumentor-signature__type">int</span>
  783. <span class="phpdocumentor-signature__name">$scale</span>
  784. </code>
  785. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  786. Tags
  787. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  788. </h5>
  789. <dl class="phpdocumentor-tag-list">
  790. <dt class="phpdocumentor-tag-list__entry">
  791. <span class="phpdocumentor-tag__name">see</span>
  792. </dt>
  793. <dd class="phpdocumentor-tag-list__definition">
  794. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  795. </dd>
  796. </dl>
  797. </article>
  798. </section>
  799. <section class="phpdocumentor-methods">
  800. <h3 class="phpdocumentor-elements__header" id="methods">
  801. Methods
  802. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  803. </h3>
  804. <article
  805. class="phpdocumentor-element
  806. -method
  807. -public
  808. "
  809. >
  810. <h4 class="phpdocumentor-element__name" id="method___construct">
  811. __construct()
  812. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  813. </h4>
  814. <aside class="phpdocumentor-element-found-in">
  815. <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>
  816. :
  817. <span class="phpdocumentor-element-found-in__line">70</span>
  818. </aside>
  819. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  820. <code class="phpdocumentor-code phpdocumentor-signature ">
  821. <span class="phpdocumentor-signature__visibility">public</span>
  822. <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>
  823. <div class="phpdocumentor-label-line">
  824. </div>
  825. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  826. <dl class="phpdocumentor-argument-list">
  827. <dt class="phpdocumentor-argument-list__entry">
  828. <span class="phpdocumentor-signature__argument__name">$options</span>
  829. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  830. </dt>
  831. <dd class="phpdocumentor-argument-list__definition">
  832. </dd>
  833. <dt class="phpdocumentor-argument-list__entry">
  834. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  835. : <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>
  836. </dt>
  837. <dd class="phpdocumentor-argument-list__definition">
  838. </dd>
  839. </dl>
  840. </article>
  841. <article
  842. class="phpdocumentor-element
  843. -method
  844. -public
  845. "
  846. >
  847. <h4 class="phpdocumentor-element__name" id="method_dump">
  848. dump()
  849. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  850. </h4>
  851. <aside class="phpdocumentor-element-found-in">
  852. <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>
  853. :
  854. <span class="phpdocumentor-element-found-in__line">74</span>
  855. </aside>
  856. <code class="phpdocumentor-code phpdocumentor-signature ">
  857. <span class="phpdocumentor-signature__visibility">public</span>
  858. <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>
  859. <div class="phpdocumentor-label-line">
  860. </div>
  861. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  862. <dl class="phpdocumentor-argument-list">
  863. <dt class="phpdocumentor-argument-list__entry">
  864. <span class="phpdocumentor-signature__argument__name">$file</span>
  865. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  866. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  867. <dd class="phpdocumentor-argument-list__definition">
  868. </dd>
  869. </dl>
  870. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  871. Tags
  872. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  873. </h5>
  874. <dl class="phpdocumentor-tag-list">
  875. <dt class="phpdocumentor-tag-list__entry">
  876. <span class="phpdocumentor-tag__name">inheritDoc</span>
  877. </dt>
  878. <dd class="phpdocumentor-tag-list__definition">
  879. </dd>
  880. </dl>
  881. <section>
  882. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  883. <span class="phpdocumentor-signature__response_type">string</span>
  884. </section>
  885. </article>
  886. <article
  887. class="phpdocumentor-element
  888. -method
  889. -public
  890. -static "
  891. >
  892. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  893. moduleValueIsValid()
  894. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  895. </h4>
  896. <aside class="phpdocumentor-element-found-in">
  897. <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>
  898. :
  899. <span class="phpdocumentor-element-found-in__line">32</span>
  900. </aside>
  901. <p class="phpdocumentor-summary">note: we&#039;re not necessarily validating the several values, just checking the general syntax
  902. note: css4 colors are not included</p>
  903. <code class="phpdocumentor-code phpdocumentor-signature ">
  904. <span class="phpdocumentor-signature__visibility">public</span>
  905. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">moduleValueIsValid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  906. <div class="phpdocumentor-label-line">
  907. </div>
  908. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  909. <dl class="phpdocumentor-argument-list">
  910. <dt class="phpdocumentor-argument-list__entry">
  911. <span class="phpdocumentor-signature__argument__name">$value</span>
  912. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  913. </dt>
  914. <dd class="phpdocumentor-argument-list__definition">
  915. </dd>
  916. </dl>
  917. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  918. Tags
  919. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_moduleValueIsValid#tags" class="headerlink"><i class="fas fa-link"></i></a>
  920. </h5>
  921. <dl class="phpdocumentor-tag-list">
  922. <dt class="phpdocumentor-tag-list__entry">
  923. <span class="phpdocumentor-tag__name">todo:</span>
  924. </dt>
  925. <dd class="phpdocumentor-tag-list__definition">
  926. <section class="phpdocumentor-description"><p>XSS proof</p>
  927. </section>
  928. </dd>
  929. <dt class="phpdocumentor-tag-list__entry">
  930. <span class="phpdocumentor-tag__name">see</span>
  931. </dt>
  932. <dd class="phpdocumentor-tag-list__definition">
  933. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill</a></span>
  934. </dd>
  935. <dt class="phpdocumentor-tag-list__entry">
  936. <span class="phpdocumentor-tag__name">inheritDoc</span>
  937. </dt>
  938. <dd class="phpdocumentor-tag-list__definition">
  939. </dd>
  940. </dl>
  941. <section>
  942. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  943. <span class="phpdocumentor-signature__response_type">bool</span>
  944. </section>
  945. </article>
  946. <article
  947. class="phpdocumentor-element
  948. -method
  949. -protected
  950. "
  951. >
  952. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  953. collectModules()
  954. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  955. </h4>
  956. <aside class="phpdocumentor-element-found-in">
  957. <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>
  958. :
  959. <span class="phpdocumentor-element-found-in__line">227</span>
  960. </aside>
  961. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  962. returns an array with the transformed modules</p>
  963. <code class="phpdocumentor-code phpdocumentor-signature ">
  964. <span class="phpdocumentor-signature__visibility">protected</span>
  965. <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>
  966. <div class="phpdocumentor-label-line">
  967. </div>
  968. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  969. <p>$x - current column
  970. $y - current row
  971. $M_TYPE - field value
  972. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  973. </section>
  974. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  975. <dl class="phpdocumentor-argument-list">
  976. <dt class="phpdocumentor-argument-list__entry">
  977. <span class="phpdocumentor-signature__argument__name">$transform</span>
  978. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  979. </dt>
  980. <dd class="phpdocumentor-argument-list__definition">
  981. </dd>
  982. </dl>
  983. <section>
  984. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  985. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  986. </section>
  987. </article>
  988. <article
  989. class="phpdocumentor-element
  990. -method
  991. -protected
  992. "
  993. >
  994. <h4 class="phpdocumentor-element__name" id="method_copyVars">
  995. copyVars()
  996. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars" class="headerlink"><i class="fas fa-link"></i></a>
  997. </h4>
  998. <aside class="phpdocumentor-element-found-in">
  999. <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>
  1000. :
  1001. <span class="phpdocumentor-element-found-in__line">89</span>
  1002. </aside>
  1003. <p class="phpdocumentor-summary">Creates copies of several QROptions values to avoid calling the magic getters
  1004. in long loops for a significant performance increase.</p>
  1005. <code class="phpdocumentor-code phpdocumentor-signature ">
  1006. <span class="phpdocumentor-signature__visibility">protected</span>
  1007. <span class="phpdocumentor-signature__name">copyVars</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1008. <div class="phpdocumentor-label-line">
  1009. </div>
  1010. <section class="phpdocumentor-description"><p>These variables are usually used in the &quot;module&quot; methods and are called up to 31329 times (at version 40).</p>
  1011. </section>
  1012. </article>
  1013. <article
  1014. class="phpdocumentor-element
  1015. -method
  1016. -protected
  1017. "
  1018. >
  1019. <h4 class="phpdocumentor-element__name" id="method_createMarkup">
  1020. createMarkup()
  1021. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_createMarkup" class="headerlink"><i class="fas fa-link"></i></a>
  1022. </h4>
  1023. <aside class="phpdocumentor-element-found-in">
  1024. <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>
  1025. :
  1026. <span class="phpdocumentor-element-found-in__line">59</span>
  1027. </aside>
  1028. <p class="phpdocumentor-summary">returns the fully parsed and rendered markup string for the given input</p>
  1029. <code class="phpdocumentor-code phpdocumentor-signature ">
  1030. <span class="phpdocumentor-signature__visibility">protected</span>
  1031. <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>
  1032. <div class="phpdocumentor-label-line">
  1033. </div>
  1034. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1035. <dl class="phpdocumentor-argument-list">
  1036. <dt class="phpdocumentor-argument-list__entry">
  1037. <span class="phpdocumentor-signature__argument__name">$saveToFile</span>
  1038. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1039. </dt>
  1040. <dd class="phpdocumentor-argument-list__definition">
  1041. </dd>
  1042. </dl>
  1043. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1044. Tags
  1045. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_createMarkup#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1046. </h5>
  1047. <dl class="phpdocumentor-tag-list">
  1048. <dt class="phpdocumentor-tag-list__entry">
  1049. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1050. </dt>
  1051. <dd class="phpdocumentor-tag-list__definition">
  1052. </dd>
  1053. </dl>
  1054. <section>
  1055. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1056. <span class="phpdocumentor-signature__response_type">string</span>
  1057. </section>
  1058. </article>
  1059. <article
  1060. class="phpdocumentor-element
  1061. -method
  1062. -protected
  1063. "
  1064. >
  1065. <h4 class="phpdocumentor-element__name" id="method_getCssClass">
  1066. getCssClass()
  1067. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getCssClass" class="headerlink"><i class="fas fa-link"></i></a>
  1068. </h4>
  1069. <aside class="phpdocumentor-element-found-in">
  1070. <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>
  1071. :
  1072. <span class="phpdocumentor-element-found-in__line">164</span>
  1073. </aside>
  1074. <p class="phpdocumentor-summary">returns a string with all css classes for the current element</p>
  1075. <code class="phpdocumentor-code phpdocumentor-signature ">
  1076. <span class="phpdocumentor-signature__visibility">protected</span>
  1077. <span class="phpdocumentor-signature__name">getCssClass</span><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 class="phpdocumentor-signature__argument__default-value">0</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1078. <div class="phpdocumentor-label-line">
  1079. </div>
  1080. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1081. <dl class="phpdocumentor-argument-list">
  1082. <dt class="phpdocumentor-argument-list__entry">
  1083. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1084. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1085. = <span class="phpdocumentor-signature__argument__default-value">0</span> </dt>
  1086. <dd class="phpdocumentor-argument-list__definition">
  1087. </dd>
  1088. </dl>
  1089. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1090. Tags
  1091. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getCssClass#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1092. </h5>
  1093. <dl class="phpdocumentor-tag-list">
  1094. <dt class="phpdocumentor-tag-list__entry">
  1095. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1096. </dt>
  1097. <dd class="phpdocumentor-tag-list__definition">
  1098. </dd>
  1099. </dl>
  1100. <section>
  1101. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1102. <span class="phpdocumentor-signature__response_type">string</span>
  1103. </section>
  1104. </article>
  1105. <article
  1106. class="phpdocumentor-element
  1107. -method
  1108. -protected
  1109. -abstract "
  1110. >
  1111. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  1112. getDefaultModuleValue()
  1113. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1114. </h4>
  1115. <aside class="phpdocumentor-element-found-in">
  1116. <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>
  1117. :
  1118. <span class="phpdocumentor-element-found-in__line">184</span>
  1119. </aside>
  1120. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
  1121. <code class="phpdocumentor-code phpdocumentor-signature ">
  1122. <span class="phpdocumentor-signature__visibility">protected</span>
  1123. <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|null</span></code>
  1124. <div class="phpdocumentor-label-line">
  1125. </div>
  1126. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1127. <dl class="phpdocumentor-argument-list">
  1128. <dt class="phpdocumentor-argument-list__entry">
  1129. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  1130. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1131. </dt>
  1132. <dd class="phpdocumentor-argument-list__definition">
  1133. </dd>
  1134. </dl>
  1135. <section>
  1136. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1137. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  1138. &mdash;
  1139. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  1140. </section>
  1141. </section>
  1142. </article>
  1143. <article
  1144. class="phpdocumentor-element
  1145. -method
  1146. -protected
  1147. "
  1148. >
  1149. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  1150. getModuleValue()
  1151. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1152. </h4>
  1153. <aside class="phpdocumentor-element-found-in">
  1154. <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>
  1155. :
  1156. <span class="phpdocumentor-element-found-in__line">152</span>
  1157. </aside>
  1158. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  1159. <code class="phpdocumentor-code phpdocumentor-signature ">
  1160. <span class="phpdocumentor-signature__visibility">protected</span>
  1161. <span class="phpdocumentor-signature__name">getModuleValue</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">mixed</span></code>
  1162. <div class="phpdocumentor-label-line">
  1163. </div>
  1164. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1165. <dl class="phpdocumentor-argument-list">
  1166. <dt class="phpdocumentor-argument-list__entry">
  1167. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1168. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1169. </dt>
  1170. <dd class="phpdocumentor-argument-list__definition">
  1171. </dd>
  1172. </dl>
  1173. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1174. Tags
  1175. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1176. </h5>
  1177. <dl class="phpdocumentor-tag-list">
  1178. <dt class="phpdocumentor-tag-list__entry">
  1179. <span class="phpdocumentor-tag__name">throws</span>
  1180. </dt>
  1181. <dd class="phpdocumentor-tag-list__definition">
  1182. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1183. <section class="phpdocumentor-description"><p>if $moduleValues[$M_TYPE] doesn't exist</p>
  1184. </section>
  1185. </dd>
  1186. </dl>
  1187. <section>
  1188. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1189. <span class="phpdocumentor-signature__response_type">mixed</span>
  1190. &mdash;
  1191. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  1192. </section>
  1193. </section>
  1194. </article>
  1195. <article
  1196. class="phpdocumentor-element
  1197. -method
  1198. -protected
  1199. "
  1200. >
  1201. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  1202. getModuleValueAt()
  1203. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  1204. </h4>
  1205. <aside class="phpdocumentor-element-found-in">
  1206. <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>
  1207. :
  1208. <span class="phpdocumentor-element-found-in__line">166</span>
  1209. </aside>
  1210. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  1211. <code class="phpdocumentor-code phpdocumentor-signature ">
  1212. <span class="phpdocumentor-signature__visibility">protected</span>
  1213. <span class="phpdocumentor-signature__name">getModuleValueAt</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  1214. <div class="phpdocumentor-label-line">
  1215. </div>
  1216. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1217. <dl class="phpdocumentor-argument-list">
  1218. <dt class="phpdocumentor-argument-list__entry">
  1219. <span class="phpdocumentor-signature__argument__name">$x</span>
  1220. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1221. </dt>
  1222. <dd class="phpdocumentor-argument-list__definition">
  1223. </dd>
  1224. <dt class="phpdocumentor-argument-list__entry">
  1225. <span class="phpdocumentor-signature__argument__name">$y</span>
  1226. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1227. </dt>
  1228. <dd class="phpdocumentor-argument-list__definition">
  1229. </dd>
  1230. </dl>
  1231. <section>
  1232. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1233. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  1234. </section>
  1235. </article>
  1236. <article
  1237. class="phpdocumentor-element
  1238. -method
  1239. -protected
  1240. "
  1241. >
  1242. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  1243. getOutputDimensions()
  1244. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1245. </h4>
  1246. <aside class="phpdocumentor-element-found-in">
  1247. <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>
  1248. :
  1249. <span class="phpdocumentor-element-found-in__line">52</span>
  1250. </aside>
  1251. <code class="phpdocumentor-code phpdocumentor-signature ">
  1252. <span class="phpdocumentor-signature__visibility">protected</span>
  1253. <span class="phpdocumentor-signature__name">getOutputDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  1254. <div class="phpdocumentor-label-line">
  1255. </div>
  1256. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1257. Tags
  1258. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getOutputDimensions#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1259. </h5>
  1260. <dl class="phpdocumentor-tag-list">
  1261. <dt class="phpdocumentor-tag-list__entry">
  1262. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1263. </dt>
  1264. <dd class="phpdocumentor-tag-list__definition">
  1265. </dd>
  1266. </dl>
  1267. <section>
  1268. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1269. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1270. </section>
  1271. </article>
  1272. <article
  1273. class="phpdocumentor-element
  1274. -method
  1275. -protected
  1276. "
  1277. >
  1278. <h4 class="phpdocumentor-element__name" id="method_getViewBox">
  1279. getViewBox()
  1280. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getViewBox" class="headerlink"><i class="fas fa-link"></i></a>
  1281. </h4>
  1282. <aside class="phpdocumentor-element-found-in">
  1283. <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>
  1284. :
  1285. <span class="phpdocumentor-element-found-in__line">85</span>
  1286. </aside>
  1287. <p class="phpdocumentor-summary">returns the value for the SVG viewBox attribute</p>
  1288. <code class="phpdocumentor-code phpdocumentor-signature ">
  1289. <span class="phpdocumentor-signature__visibility">protected</span>
  1290. <span class="phpdocumentor-signature__name">getViewBox</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1291. <div class="phpdocumentor-label-line">
  1292. </div>
  1293. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1294. Tags
  1295. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getViewBox#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1296. </h5>
  1297. <dl class="phpdocumentor-tag-list">
  1298. <dt class="phpdocumentor-tag-list__entry">
  1299. <span class="phpdocumentor-tag__name">see</span>
  1300. </dt>
  1301. <dd class="phpdocumentor-tag-list__definition">
  1302. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox</a></span>
  1303. </dd>
  1304. <dt class="phpdocumentor-tag-list__entry">
  1305. <span class="phpdocumentor-tag__name">see</span>
  1306. </dt>
  1307. <dd class="phpdocumentor-tag-list__definition">
  1308. <span class="phpdocumentor-tag-link"><a href="https://css-tricks.com/scale-svg/#article-header-id-3">https://css-tricks.com/scale-svg/#article-header-id-3</a></span>
  1309. </dd>
  1310. </dl>
  1311. <section>
  1312. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1313. <span class="phpdocumentor-signature__response_type">string</span>
  1314. </section>
  1315. </article>
  1316. <article
  1317. class="phpdocumentor-element
  1318. -method
  1319. -protected
  1320. "
  1321. >
  1322. <h4 class="phpdocumentor-element__name" id="method_header">
  1323. header()
  1324. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_header" class="headerlink"><i class="fas fa-link"></i></a>
  1325. </h4>
  1326. <aside class="phpdocumentor-element-found-in">
  1327. <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>
  1328. :
  1329. <span class="phpdocumentor-element-found-in__line">96</span>
  1330. </aside>
  1331. <p class="phpdocumentor-summary">returns the &lt;svg&gt; header with the given options parsed</p>
  1332. <code class="phpdocumentor-code phpdocumentor-signature ">
  1333. <span class="phpdocumentor-signature__visibility">protected</span>
  1334. <span class="phpdocumentor-signature__name">header</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1335. <div class="phpdocumentor-label-line">
  1336. </div>
  1337. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1338. Tags
  1339. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_header#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1340. </h5>
  1341. <dl class="phpdocumentor-tag-list">
  1342. <dt class="phpdocumentor-tag-list__entry">
  1343. <span class="phpdocumentor-tag__name">see</span>
  1344. </dt>
  1345. <dd class="phpdocumentor-tag-list__definition">
  1346. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg</a></span>
  1347. </dd>
  1348. </dl>
  1349. <section>
  1350. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1351. <span class="phpdocumentor-signature__response_type">string</span>
  1352. </section>
  1353. </article>
  1354. <article
  1355. class="phpdocumentor-element
  1356. -method
  1357. -protected
  1358. "
  1359. >
  1360. <h4 class="phpdocumentor-element__name" id="method_module">
  1361. module()
  1362. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  1363. </h4>
  1364. <aside class="phpdocumentor-element-found-in">
  1365. <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>
  1366. :
  1367. <span class="phpdocumentor-element-found-in__line">177</span>
  1368. </aside>
  1369. <p class="phpdocumentor-summary">returns a path segment for a single module</p>
  1370. <code class="phpdocumentor-code phpdocumentor-signature ">
  1371. <span class="phpdocumentor-signature__visibility">protected</span>
  1372. <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>
  1373. <div class="phpdocumentor-label-line">
  1374. </div>
  1375. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1376. <dl class="phpdocumentor-argument-list">
  1377. <dt class="phpdocumentor-argument-list__entry">
  1378. <span class="phpdocumentor-signature__argument__name">$x</span>
  1379. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1380. </dt>
  1381. <dd class="phpdocumentor-argument-list__definition">
  1382. </dd>
  1383. <dt class="phpdocumentor-argument-list__entry">
  1384. <span class="phpdocumentor-signature__argument__name">$y</span>
  1385. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1386. </dt>
  1387. <dd class="phpdocumentor-argument-list__definition">
  1388. </dd>
  1389. <dt class="phpdocumentor-argument-list__entry">
  1390. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1391. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1392. </dt>
  1393. <dd class="phpdocumentor-argument-list__definition">
  1394. </dd>
  1395. </dl>
  1396. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1397. Tags
  1398. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_module#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1399. </h5>
  1400. <dl class="phpdocumentor-tag-list">
  1401. <dt class="phpdocumentor-tag-list__entry">
  1402. <span class="phpdocumentor-tag__name">see</span>
  1403. </dt>
  1404. <dd class="phpdocumentor-tag-list__definition">
  1405. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d</a></span>
  1406. </dd>
  1407. </dl>
  1408. <section>
  1409. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1410. <span class="phpdocumentor-signature__response_type">string</span>
  1411. </section>
  1412. </article>
  1413. <article
  1414. class="phpdocumentor-element
  1415. -method
  1416. -protected
  1417. "
  1418. >
  1419. <h4 class="phpdocumentor-element__name" id="method_path">
  1420. path()
  1421. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_path" class="headerlink"><i class="fas fa-link"></i></a>
  1422. </h4>
  1423. <aside class="phpdocumentor-element-found-in">
  1424. <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>
  1425. :
  1426. <span class="phpdocumentor-element-found-in__line">147</span>
  1427. </aside>
  1428. <p class="phpdocumentor-summary">renders and returns a single &lt;path&gt; element</p>
  1429. <code class="phpdocumentor-code phpdocumentor-signature ">
  1430. <span class="phpdocumentor-signature__visibility">protected</span>
  1431. <span class="phpdocumentor-signature__name">path</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$path</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>
  1432. <div class="phpdocumentor-label-line">
  1433. </div>
  1434. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1435. <dl class="phpdocumentor-argument-list">
  1436. <dt class="phpdocumentor-argument-list__entry">
  1437. <span class="phpdocumentor-signature__argument__name">$path</span>
  1438. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1439. </dt>
  1440. <dd class="phpdocumentor-argument-list__definition">
  1441. </dd>
  1442. <dt class="phpdocumentor-argument-list__entry">
  1443. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1444. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1445. </dt>
  1446. <dd class="phpdocumentor-argument-list__definition">
  1447. </dd>
  1448. </dl>
  1449. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1450. Tags
  1451. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_path#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1452. </h5>
  1453. <dl class="phpdocumentor-tag-list">
  1454. <dt class="phpdocumentor-tag-list__entry">
  1455. <span class="phpdocumentor-tag__name">see</span>
  1456. </dt>
  1457. <dd class="phpdocumentor-tag-list__definition">
  1458. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path</a></span>
  1459. </dd>
  1460. </dl>
  1461. <section>
  1462. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1463. <span class="phpdocumentor-signature__response_type">string</span>
  1464. </section>
  1465. </article>
  1466. <article
  1467. class="phpdocumentor-element
  1468. -method
  1469. -protected
  1470. "
  1471. >
  1472. <h4 class="phpdocumentor-element__name" id="method_paths">
  1473. paths()
  1474. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_paths" class="headerlink"><i class="fas fa-link"></i></a>
  1475. </h4>
  1476. <aside class="phpdocumentor-element-found-in">
  1477. <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>
  1478. :
  1479. <span class="phpdocumentor-element-found-in__line">116</span>
  1480. </aside>
  1481. <p class="phpdocumentor-summary">returns one or more SVG &lt;path&gt; elements</p>
  1482. <code class="phpdocumentor-code phpdocumentor-signature ">
  1483. <span class="phpdocumentor-signature__visibility">protected</span>
  1484. <span class="phpdocumentor-signature__name">paths</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1485. <div class="phpdocumentor-label-line">
  1486. </div>
  1487. <section>
  1488. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1489. <span class="phpdocumentor-signature__response_type">string</span>
  1490. </section>
  1491. </article>
  1492. <article
  1493. class="phpdocumentor-element
  1494. -method
  1495. -protected
  1496. -abstract "
  1497. >
  1498. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  1499. prepareModuleValue()
  1500. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1501. </h4>
  1502. <aside class="phpdocumentor-element-found-in">
  1503. <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>
  1504. :
  1505. <span class="phpdocumentor-element-found-in__line">177</span>
  1506. </aside>
  1507. <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
  1508. <code class="phpdocumentor-code phpdocumentor-signature ">
  1509. <span class="phpdocumentor-signature__visibility">protected</span>
  1510. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">prepareModuleValue</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|null</span></code>
  1511. <div class="phpdocumentor-label-line">
  1512. </div>
  1513. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1514. <dl class="phpdocumentor-argument-list">
  1515. <dt class="phpdocumentor-argument-list__entry">
  1516. <span class="phpdocumentor-signature__argument__name">$value</span>
  1517. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1518. </dt>
  1519. <dd class="phpdocumentor-argument-list__definition">
  1520. </dd>
  1521. </dl>
  1522. <section>
  1523. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1524. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  1525. &mdash;
  1526. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  1527. </section>
  1528. </section>
  1529. </article>
  1530. <article
  1531. class="phpdocumentor-element
  1532. -method
  1533. -protected
  1534. "
  1535. >
  1536. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1537. saveToFile()
  1538. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1539. </h4>
  1540. <aside class="phpdocumentor-element-found-in">
  1541. <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>
  1542. :
  1543. <span class="phpdocumentor-element-found-in__line">201</span>
  1544. </aside>
  1545. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1546. <code class="phpdocumentor-code phpdocumentor-signature ">
  1547. <span class="phpdocumentor-signature__visibility">protected</span>
  1548. <span class="phpdocumentor-signature__name">saveToFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1549. <div class="phpdocumentor-label-line">
  1550. </div>
  1551. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1552. <dl class="phpdocumentor-argument-list">
  1553. <dt class="phpdocumentor-argument-list__entry">
  1554. <span class="phpdocumentor-signature__argument__name">$data</span>
  1555. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1556. </dt>
  1557. <dd class="phpdocumentor-argument-list__definition">
  1558. </dd>
  1559. <dt class="phpdocumentor-argument-list__entry">
  1560. <span class="phpdocumentor-signature__argument__name">$file</span>
  1561. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1562. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1563. <dd class="phpdocumentor-argument-list__definition">
  1564. </dd>
  1565. </dl>
  1566. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1567. Tags
  1568. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1569. </h5>
  1570. <dl class="phpdocumentor-tag-list">
  1571. <dt class="phpdocumentor-tag-list__entry">
  1572. <span class="phpdocumentor-tag__name">see</span>
  1573. </dt>
  1574. <dd class="phpdocumentor-tag-list__definition">
  1575. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1576. </dd>
  1577. <dt class="phpdocumentor-tag-list__entry">
  1578. <span class="phpdocumentor-tag__name">see</span>
  1579. </dt>
  1580. <dd class="phpdocumentor-tag-list__definition">
  1581. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1582. </dd>
  1583. <dt class="phpdocumentor-tag-list__entry">
  1584. <span class="phpdocumentor-tag__name">throws</span>
  1585. </dt>
  1586. <dd class="phpdocumentor-tag-list__definition">
  1587. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1588. </dd>
  1589. </dl>
  1590. </article>
  1591. <article
  1592. class="phpdocumentor-element
  1593. -method
  1594. -protected
  1595. "
  1596. >
  1597. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1598. setMatrixDimensions()
  1599. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1600. </h4>
  1601. <aside class="phpdocumentor-element-found-in">
  1602. <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>
  1603. :
  1604. <span class="phpdocumentor-element-found-in__line">112</span>
  1605. </aside>
  1606. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1607. <code class="phpdocumentor-code phpdocumentor-signature ">
  1608. <span class="phpdocumentor-signature__visibility">protected</span>
  1609. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1610. <div class="phpdocumentor-label-line">
  1611. </div>
  1612. <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>
  1613. </section>
  1614. </article>
  1615. <article
  1616. class="phpdocumentor-element
  1617. -method
  1618. -protected
  1619. "
  1620. >
  1621. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1622. setModuleValues()
  1623. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1624. </h4>
  1625. <aside class="phpdocumentor-element-found-in">
  1626. <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>
  1627. :
  1628. <span class="phpdocumentor-element-found-in__line">130</span>
  1629. </aside>
  1630. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1631. <code class="phpdocumentor-code phpdocumentor-signature ">
  1632. <span class="phpdocumentor-signature__visibility">protected</span>
  1633. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1634. <div class="phpdocumentor-label-line">
  1635. </div>
  1636. </article>
  1637. <article
  1638. class="phpdocumentor-element
  1639. -method
  1640. -protected
  1641. "
  1642. >
  1643. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1644. toBase64DataURI()
  1645. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1646. </h4>
  1647. <aside class="phpdocumentor-element-found-in">
  1648. <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>
  1649. :
  1650. <span class="phpdocumentor-element-found-in__line">189</span>
  1651. </aside>
  1652. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1653. <code class="phpdocumentor-code phpdocumentor-signature ">
  1654. <span class="phpdocumentor-signature__visibility">protected</span>
  1655. <span class="phpdocumentor-signature__name">toBase64DataURI</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1656. <div class="phpdocumentor-label-line">
  1657. </div>
  1658. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1659. <dl class="phpdocumentor-argument-list">
  1660. <dt class="phpdocumentor-argument-list__entry">
  1661. <span class="phpdocumentor-signature__argument__name">$data</span>
  1662. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1663. </dt>
  1664. <dd class="phpdocumentor-argument-list__definition">
  1665. </dd>
  1666. <dt class="phpdocumentor-argument-list__entry">
  1667. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1668. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1669. </dt>
  1670. <dd class="phpdocumentor-argument-list__definition">
  1671. </dd>
  1672. </dl>
  1673. <section>
  1674. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1675. <span class="phpdocumentor-signature__response_type">string</span>
  1676. </section>
  1677. </article>
  1678. </section>
  1679. <div class="phpdocumentor-modal" id="source-view">
  1680. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1681. <div class="phpdocumentor-modal-container">
  1682. <div class="phpdocumentor-modal-content">
  1683. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Output/QRMarkupSVG.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  1684. </div>
  1685. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1686. </div>
  1687. </div>
  1688. <script type="text/javascript">
  1689. (function () {
  1690. function loadExternalCodeSnippet(el, url, line) {
  1691. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1692. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1693. const language = 'php';
  1694. const code = document.createElement('code');
  1695. code.className = 'language-' + language;
  1696. pre.textContent = '';
  1697. pre.setAttribute('data-line', line)
  1698. code.textContent = 'Loading…';
  1699. pre.appendChild(code);
  1700. var xhr = new XMLHttpRequest();
  1701. xhr.open('GET', src, true);
  1702. xhr.onreadystatechange = function () {
  1703. if (xhr.readyState !== 4) {
  1704. return;
  1705. }
  1706. if (xhr.status < 400 && xhr.responseText) {
  1707. code.textContent = xhr.responseText;
  1708. Prism.highlightElement(code);
  1709. return;
  1710. }
  1711. if (xhr.status === 404) {
  1712. code.textContent = '✖ Error: File could not be found';
  1713. return;
  1714. }
  1715. if (xhr.status >= 400) {
  1716. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1717. return;
  1718. }
  1719. code.textContent = '✖ Error: An unknown error occurred';
  1720. };
  1721. xhr.send(null);
  1722. });
  1723. }
  1724. const modalButtons = document.querySelectorAll("[data-modal]");
  1725. const openedAsLocalFile = window.location.protocol === 'file:';
  1726. if (modalButtons.length > 0 && openedAsLocalFile) {
  1727. console.warn(
  1728. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1729. 'browsers block XHR requests when a page is opened this way'
  1730. );
  1731. }
  1732. modalButtons.forEach(function (trigger) {
  1733. if (openedAsLocalFile) {
  1734. trigger.setAttribute("hidden", "hidden");
  1735. }
  1736. trigger.addEventListener("click", function (event) {
  1737. event.preventDefault();
  1738. const modal = document.getElementById(trigger.dataset.modal);
  1739. if (!modal) {
  1740. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1741. return;
  1742. }
  1743. modal.classList.add("phpdocumentor-modal__open");
  1744. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1745. const exits = modal.querySelectorAll("[data-exit-button]");
  1746. exits.forEach(function (exit) {
  1747. exit.addEventListener("click", function (event) {
  1748. event.preventDefault();
  1749. modal.classList.remove("phpdocumentor-modal__open");
  1750. });
  1751. });
  1752. });
  1753. });
  1754. })();
  1755. </script>
  1756. </article>
  1757. </section>
  1758. <section class="phpdocumentor-on-this-page__sidebar">
  1759. <section class="phpdocumentor-on-this-page__content">
  1760. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1761. <ul class="phpdocumentor-list -clean">
  1762. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1763. <li>
  1764. <ul class="phpdocumentor-list -clean">
  1765. <li><a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#toc-properties">Properties</a></li>
  1766. <li><a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#toc-methods">Methods</a></li>
  1767. </ul>
  1768. </li>
  1769. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1770. <li>
  1771. <ul class="phpdocumentor-list -clean">
  1772. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1773. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1774. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1775. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1776. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1777. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1778. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1779. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1780. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1781. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1782. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1783. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1784. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html"></li>
  1785. </ul>
  1786. </li>
  1787. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1788. <li>
  1789. <ul class="phpdocumentor-list -clean">
  1790. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a></li>
  1791. <li><a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump">dump()</a></li>
  1792. <li><a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  1793. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1794. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a></li>
  1795. <li><a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_createMarkup">createMarkup()</a></li>
  1796. <li><a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getCssClass">getCssClass()</a></li>
  1797. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1798. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1799. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1800. <li><a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1801. <li><a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getViewBox">getViewBox()</a></li>
  1802. <li><a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_header">header()</a></li>
  1803. <li><a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_module">module()</a></li>
  1804. <li><a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_path">path()</a></li>
  1805. <li><a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_paths">paths()</a></li>
  1806. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1807. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1808. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1809. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1810. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1811. </ul>
  1812. </li>
  1813. </ul>
  1814. </section>
  1815. </section>
  1816. </div>
  1817. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1818. <section class="phpdocumentor-search-results__dialog">
  1819. <header class="phpdocumentor-search-results__header">
  1820. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1821. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1822. </header>
  1823. <section class="phpdocumentor-search-results__body">
  1824. <ul class="phpdocumentor-search-results__entries"></ul>
  1825. </section>
  1826. </section>
  1827. </section>
  1828. </div>
  1829. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1830. </main>
  1831. <script>
  1832. cssVars({});
  1833. </script>
  1834. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1835. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1836. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1837. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1838. </body>
  1839. </html>