chillerlan-QRCode-Output-QRMarkupSVG.html 81 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -class">
  91. <h2 class="phpdocumentor-content__title">
  92. QRMarkupSVG
  93. <span class="phpdocumentor-element__extends">
  94. extends <a href="classes/chillerlan-QRCode-Output-QRMarkup.html"><abbr title="\chillerlan\QRCode\Output\QRMarkup">QRMarkup</abbr></a>
  95. </span>
  96. <div class="phpdocumentor-element__package">
  97. in package
  98. <ul class="phpdocumentor-breadcrumbs">
  99. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  100. </ul>
  101. </div>
  102. </h2>
  103. <aside class="phpdocumentor-element-found-in">
  104. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupSVG.php"><a href="files/src-output-qrmarkupsvg.html"><abbr title="src/Output/QRMarkupSVG.php">QRMarkupSVG.php</abbr></a></abbr>
  105. :
  106. <span class="phpdocumentor-element-found-in__line">24</span>
  107. </aside>
  108. <p class="phpdocumentor-summary">SVG output</p>
  109. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  110. Tags
  111. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  112. </h5>
  113. <dl class="phpdocumentor-tag-list">
  114. <dt class="phpdocumentor-tag-list__entry">
  115. <span class="phpdocumentor-tag__name">see</span>
  116. </dt>
  117. <dd class="phpdocumentor-tag-list__definition">
  118. <span class="phpdocumentor-tag-link"><a href="https://github.com/codemasher/php-qrcode/pull/5"><abbr title="https://github.com/codemasher/php-qrcode/pull/5">https://github.com/codemasher/php-qrcode/pull/5</abbr></a></span>
  119. </dd>
  120. <dt class="phpdocumentor-tag-list__entry">
  121. <span class="phpdocumentor-tag__name">see</span>
  122. </dt>
  123. <dd class="phpdocumentor-tag-list__definition">
  124. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/svg</abbr></a></span>
  125. </dd>
  126. <dt class="phpdocumentor-tag-list__entry">
  127. <span class="phpdocumentor-tag__name">see</span>
  128. </dt>
  129. <dd class="phpdocumentor-tag-list__definition">
  130. <span class="phpdocumentor-tag-link"><a href="https://www.sarasoueidan.com/demos/interactive-svg-coordinate-system/"><abbr title="https://www.sarasoueidan.com/demos/interactive-svg-coordinate-system/">https://www.sarasoueidan.com/demos/interactive-svg-coordinate-system/</abbr></a></span>
  131. </dd>
  132. <dt class="phpdocumentor-tag-list__entry">
  133. <span class="phpdocumentor-tag__name">see</span>
  134. </dt>
  135. <dd class="phpdocumentor-tag-list__definition">
  136. <span class="phpdocumentor-tag-link"><a href="http://apex.infogridpacific.com/SVG/svg-tutorial-contents.html"><abbr title="http://apex.infogridpacific.com/SVG/svg-tutorial-contents.html">http://apex.infogridpacific.com/SVG/svg-tutorial-contents.html</abbr></a></span>
  137. </dd>
  138. </dl>
  139. <h3 id="toc">
  140. Table of Contents
  141. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  142. </h3>
  143. <dl class="phpdocumentor-table-of-contents">
  144. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  145. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  146. <span>
  147. &nbsp;: int </span>
  148. </dt>
  149. <dd>the side length of the QR image (modules * scale)</dd>
  150. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  151. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  152. <span>
  153. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  154. </dt>
  155. <dd>the (filled) data matrix object</dd>
  156. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  157. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  158. <span>
  159. &nbsp;: int </span>
  160. </dt>
  161. <dd>the current size of the QR matrix</dd>
  162. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  163. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  164. <span>
  165. &nbsp;: array&lt;string|int, mixed&gt; </span>
  166. </dt>
  167. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  168. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  170. <span>
  171. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  172. </dt>
  173. <dd></dd>
  174. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  175. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  176. <span>
  177. &nbsp;: int </span>
  178. </dt>
  179. <dd>the current scaling for a QR pixel</dd>
  180. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  181. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  182. <span>
  183. &nbsp;: mixed </span>
  184. </dt>
  185. <dd>QROutputAbstract constructor.</dd>
  186. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  187. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump">dump()</a>
  188. <span>
  189. &nbsp;: string </span>
  190. </dt>
  191. <dd></dd>
  192. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  193. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  194. <span>
  195. &nbsp;: bool </span>
  196. </dt>
  197. <dd>note: we&#039;re not necessarily validating the several values, just checking the general syntax
  198. note: css4 colors are not included</dd>
  199. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  200. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  201. <span>
  202. &nbsp;: array&lt;string|int, mixed&gt; </span>
  203. </dt>
  204. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  205. returns an array with the transformed modules</dd>
  206. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  207. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_createMarkup">createMarkup()</a>
  208. <span>
  209. &nbsp;: string </span>
  210. </dt>
  211. <dd></dd>
  212. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  213. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getCssClass">getCssClass()</a>
  214. <span>
  215. &nbsp;: string </span>
  216. </dt>
  217. <dd>returns a string with all css classes for the current element</dd>
  218. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  219. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  220. <span>
  221. &nbsp;: mixed|null </span>
  222. </dt>
  223. <dd>Returns a default value for either dark or light modules</dd>
  224. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  225. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  226. <span>
  227. &nbsp;: mixed|null </span>
  228. </dt>
  229. <dd>Returns the prepared value for the given $M_TYPE</dd>
  230. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  231. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  232. <span>
  233. &nbsp;: mixed|null </span>
  234. </dt>
  235. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  236. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  237. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_header">header()</a>
  238. <span>
  239. &nbsp;: string </span>
  240. </dt>
  241. <dd>returns the &lt;svg&gt; header with the given options parsed</dd>
  242. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  243. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_module">module()</a>
  244. <span>
  245. &nbsp;: string </span>
  246. </dt>
  247. <dd>returns a path segment for a single module</dd>
  248. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  249. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_path">path()</a>
  250. <span>
  251. &nbsp;: string </span>
  252. </dt>
  253. <dd>renders and returns a single &lt;path&gt; element</dd>
  254. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  255. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_paths">paths()</a>
  256. <span>
  257. &nbsp;: string </span>
  258. </dt>
  259. <dd>returns one or more SVG &lt;path&gt; elements</dd>
  260. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  261. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a>
  262. <span>
  263. &nbsp;: mixed|null </span>
  264. </dt>
  265. <dd>Prepares the value for the given input ()</dd>
  266. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  267. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  268. <span>
  269. &nbsp;: void </span>
  270. </dt>
  271. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  272. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  273. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  274. <span>
  275. &nbsp;: void </span>
  276. </dt>
  277. <dd>Sets/updates the matrix dimensions</dd>
  278. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  279. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  280. <span>
  281. &nbsp;: void </span>
  282. </dt>
  283. <dd>Sets the initial module values</dd>
  284. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  285. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  286. <span>
  287. &nbsp;: string </span>
  288. </dt>
  289. <dd>Returns a base64 data URI for the given string and mime type</dd>
  290. </dl>
  291. <section class="phpdocumentor-properties">
  292. <h3 class="phpdocumentor-elements__header" id="properties">
  293. Properties
  294. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  295. </h3>
  296. <article
  297. class="
  298. phpdocumentor-element
  299. -property
  300. -protected
  301. "
  302. >
  303. <h4 class="phpdocumentor-element__name" id="property_length">
  304. $length
  305. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  306. <span class="phpdocumentor-element__modifiers">
  307. </span>
  308. </h4>
  309. <aside class="phpdocumentor-element-found-in">
  310. <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>
  311. :
  312. <span class="phpdocumentor-element-found-in__line">40</span>
  313. </aside>
  314. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  315. <code class="phpdocumentor-code phpdocumentor-signature ">
  316. <span class="phpdocumentor-signature__visibility">protected</span>
  317. <span class="phpdocumentor-signature__type">int</span>
  318. <span class="phpdocumentor-signature__name">$length</span>
  319. </code>
  320. <section class="phpdocumentor-description"></section>
  321. </article>
  322. <article
  323. class="
  324. phpdocumentor-element
  325. -property
  326. -protected
  327. "
  328. >
  329. <h4 class="phpdocumentor-element__name" id="property_matrix">
  330. $matrix
  331. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  332. <span class="phpdocumentor-element__modifiers">
  333. </span>
  334. </h4>
  335. <aside class="phpdocumentor-element-found-in">
  336. <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>
  337. :
  338. <span class="phpdocumentor-element-found-in__line">50</span>
  339. </aside>
  340. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  341. <code class="phpdocumentor-code phpdocumentor-signature ">
  342. <span class="phpdocumentor-signature__visibility">protected</span>
  343. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  344. <span class="phpdocumentor-signature__name">$matrix</span>
  345. </code>
  346. <section class="phpdocumentor-description"></section>
  347. </article>
  348. <article
  349. class="
  350. phpdocumentor-element
  351. -property
  352. -protected
  353. "
  354. >
  355. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  356. $moduleCount
  357. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  358. <span class="phpdocumentor-element__modifiers">
  359. </span>
  360. </h4>
  361. <aside class="phpdocumentor-element-found-in">
  362. <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>
  363. :
  364. <span class="phpdocumentor-element-found-in__line">28</span>
  365. </aside>
  366. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  367. <code class="phpdocumentor-code phpdocumentor-signature ">
  368. <span class="phpdocumentor-signature__visibility">protected</span>
  369. <span class="phpdocumentor-signature__type">int</span>
  370. <span class="phpdocumentor-signature__name">$moduleCount</span>
  371. </code>
  372. <section class="phpdocumentor-description"></section>
  373. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  374. Tags
  375. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  376. </h5>
  377. <dl class="phpdocumentor-tag-list">
  378. <dt class="phpdocumentor-tag-list__entry">
  379. <span class="phpdocumentor-tag__name">see</span>
  380. </dt>
  381. <dd class="phpdocumentor-tag-list__definition">
  382. <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>
  383. </dd>
  384. </dl>
  385. </article>
  386. <article
  387. class="
  388. phpdocumentor-element
  389. -property
  390. -protected
  391. "
  392. >
  393. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  394. $moduleValues
  395. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  396. <span class="phpdocumentor-element__modifiers">
  397. </span>
  398. </h4>
  399. <aside class="phpdocumentor-element-found-in">
  400. <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>
  401. :
  402. <span class="phpdocumentor-element-found-in__line">45</span>
  403. </aside>
  404. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  405. <code class="phpdocumentor-code phpdocumentor-signature ">
  406. <span class="phpdocumentor-signature__visibility">protected</span>
  407. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  408. <span class="phpdocumentor-signature__name">$moduleValues</span>
  409. </code>
  410. <section class="phpdocumentor-description"></section>
  411. </article>
  412. <article
  413. class="
  414. phpdocumentor-element
  415. -property
  416. -protected
  417. "
  418. >
  419. <h4 class="phpdocumentor-element__name" id="property_options">
  420. $options
  421. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  422. <span class="phpdocumentor-element__modifiers">
  423. </span>
  424. </h4>
  425. <aside class="phpdocumentor-element-found-in">
  426. <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>
  427. :
  428. <span class="phpdocumentor-element-found-in__line">55</span>
  429. </aside>
  430. <code class="phpdocumentor-code phpdocumentor-signature ">
  431. <span class="phpdocumentor-signature__visibility">protected</span>
  432. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  433. <span class="phpdocumentor-signature__name">$options</span>
  434. </code>
  435. </article>
  436. <article
  437. class="
  438. phpdocumentor-element
  439. -property
  440. -protected
  441. "
  442. >
  443. <h4 class="phpdocumentor-element__name" id="property_scale">
  444. $scale
  445. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  446. <span class="phpdocumentor-element__modifiers">
  447. </span>
  448. </h4>
  449. <aside class="phpdocumentor-element-found-in">
  450. <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>
  451. :
  452. <span class="phpdocumentor-element-found-in__line">35</span>
  453. </aside>
  454. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  455. <code class="phpdocumentor-code phpdocumentor-signature ">
  456. <span class="phpdocumentor-signature__visibility">protected</span>
  457. <span class="phpdocumentor-signature__type">int</span>
  458. <span class="phpdocumentor-signature__name">$scale</span>
  459. </code>
  460. <section class="phpdocumentor-description"></section>
  461. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  462. Tags
  463. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  464. </h5>
  465. <dl class="phpdocumentor-tag-list">
  466. <dt class="phpdocumentor-tag-list__entry">
  467. <span class="phpdocumentor-tag__name">see</span>
  468. </dt>
  469. <dd class="phpdocumentor-tag-list__definition">
  470. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  471. </dd>
  472. </dl>
  473. </article>
  474. </section>
  475. <section class="phpdocumentor-methods">
  476. <h3 class="phpdocumentor-elements__header" id="methods">
  477. Methods
  478. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  479. </h3>
  480. <article
  481. class="phpdocumentor-element
  482. -method
  483. -public
  484. "
  485. >
  486. <h4 class="phpdocumentor-element__name" id="method___construct">
  487. __construct()
  488. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  489. </h4>
  490. <aside class="phpdocumentor-element-found-in">
  491. <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>
  492. :
  493. <span class="phpdocumentor-element-found-in__line">60</span>
  494. </aside>
  495. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  496. <code class="phpdocumentor-code phpdocumentor-signature ">
  497. <span class="phpdocumentor-signature__visibility">public</span>
  498. <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>
  499. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  500. <dl class="phpdocumentor-argument-list">
  501. <dt class="phpdocumentor-argument-list__entry">
  502. <span class="phpdocumentor-signature__argument__name">$options</span>
  503. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  504. </dt>
  505. <dd class="phpdocumentor-argument-list__definition">
  506. <section class="phpdocumentor-description"></section>
  507. </dd>
  508. <dt class="phpdocumentor-argument-list__entry">
  509. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  510. : <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>
  511. </dt>
  512. <dd class="phpdocumentor-argument-list__definition">
  513. <section class="phpdocumentor-description"></section>
  514. </dd>
  515. </dl>
  516. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  517. <span class="phpdocumentor-signature__response_type">mixed</span>
  518. &mdash;
  519. </article>
  520. <article
  521. class="phpdocumentor-element
  522. -method
  523. -public
  524. "
  525. >
  526. <h4 class="phpdocumentor-element__name" id="method_dump">
  527. dump()
  528. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  529. </h4>
  530. <aside class="phpdocumentor-element-found-in">
  531. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkup.php"><a href="files/src-output-qrmarkup.html"><abbr title="src/Output/QRMarkup.php">QRMarkup.php</abbr></a></abbr>
  532. :
  533. <span class="phpdocumentor-element-found-in__line">74</span>
  534. </aside>
  535. <code class="phpdocumentor-code phpdocumentor-signature ">
  536. <span class="phpdocumentor-signature__visibility">public</span>
  537. <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>
  538. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  539. <dl class="phpdocumentor-argument-list">
  540. <dt class="phpdocumentor-argument-list__entry">
  541. <span class="phpdocumentor-signature__argument__name">$file</span>
  542. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  543. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  544. <dd class="phpdocumentor-argument-list__definition">
  545. <section class="phpdocumentor-description"></section>
  546. </dd>
  547. </dl>
  548. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  549. Tags
  550. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  551. </h5>
  552. <dl class="phpdocumentor-tag-list">
  553. <dt class="phpdocumentor-tag-list__entry">
  554. <span class="phpdocumentor-tag__name">inheritDoc</span>
  555. </dt>
  556. <dd class="phpdocumentor-tag-list__definition">
  557. </dd>
  558. </dl>
  559. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  560. <span class="phpdocumentor-signature__response_type">string</span>
  561. &mdash;
  562. </article>
  563. <article
  564. class="phpdocumentor-element
  565. -method
  566. -public
  567. -static "
  568. >
  569. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  570. moduleValueIsValid()
  571. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  572. </h4>
  573. <aside class="phpdocumentor-element-found-in">
  574. <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>
  575. :
  576. <span class="phpdocumentor-element-found-in__line">32</span>
  577. </aside>
  578. <p class="phpdocumentor-summary">note: we&#039;re not necessarily validating the several values, just checking the general syntax
  579. note: css4 colors are not included</p>
  580. <code class="phpdocumentor-code phpdocumentor-signature ">
  581. <span class="phpdocumentor-signature__visibility">public</span>
  582. <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>
  583. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  584. <dl class="phpdocumentor-argument-list">
  585. <dt class="phpdocumentor-argument-list__entry">
  586. <span class="phpdocumentor-signature__argument__name">$value</span>
  587. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  588. </dt>
  589. <dd class="phpdocumentor-argument-list__definition">
  590. <section class="phpdocumentor-description"></section>
  591. </dd>
  592. </dl>
  593. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  594. Tags
  595. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  596. </h5>
  597. <dl class="phpdocumentor-tag-list">
  598. <dt class="phpdocumentor-tag-list__entry">
  599. <span class="phpdocumentor-tag__name">todo:</span>
  600. </dt>
  601. <dd class="phpdocumentor-tag-list__definition">
  602. <section class="phpdocumentor-description"><p>XSS proof</p>
  603. </section>
  604. </dd>
  605. <dt class="phpdocumentor-tag-list__entry">
  606. <span class="phpdocumentor-tag__name">see</span>
  607. </dt>
  608. <dd class="phpdocumentor-tag-list__definition">
  609. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill</abbr></a></span>
  610. </dd>
  611. <dt class="phpdocumentor-tag-list__entry">
  612. <span class="phpdocumentor-tag__name">inheritDoc</span>
  613. </dt>
  614. <dd class="phpdocumentor-tag-list__definition">
  615. </dd>
  616. </dl>
  617. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  618. <span class="phpdocumentor-signature__response_type">bool</span>
  619. &mdash;
  620. </article>
  621. <article
  622. class="phpdocumentor-element
  623. -method
  624. -protected
  625. "
  626. >
  627. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  628. collectModules()
  629. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  630. </h4>
  631. <aside class="phpdocumentor-element-found-in">
  632. <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>
  633. :
  634. <span class="phpdocumentor-element-found-in__line">176</span>
  635. </aside>
  636. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  637. returns an array with the transformed modules</p>
  638. <code class="phpdocumentor-code phpdocumentor-signature ">
  639. <span class="phpdocumentor-signature__visibility">protected</span>
  640. <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>
  641. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  642. <p>$x - current column
  643. $y - current row
  644. $M_TYPE - field value
  645. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  646. </section>
  647. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  648. <dl class="phpdocumentor-argument-list">
  649. <dt class="phpdocumentor-argument-list__entry">
  650. <span class="phpdocumentor-signature__argument__name">$transform</span>
  651. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  652. </dt>
  653. <dd class="phpdocumentor-argument-list__definition">
  654. <section class="phpdocumentor-description"></section>
  655. </dd>
  656. </dl>
  657. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  658. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  659. &mdash;
  660. </article>
  661. <article
  662. class="phpdocumentor-element
  663. -method
  664. -protected
  665. "
  666. >
  667. <h4 class="phpdocumentor-element__name" id="method_createMarkup">
  668. createMarkup()
  669. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_createMarkup" class="headerlink"><i class="fas fa-link"></i></a>
  670. </h4>
  671. <aside class="phpdocumentor-element-found-in">
  672. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRMarkupSVG.php"><a href="files/src-output-qrmarkupsvg.html"><abbr title="src/Output/QRMarkupSVG.php">QRMarkupSVG.php</abbr></a></abbr>
  673. :
  674. <span class="phpdocumentor-element-found-in__line">52</span>
  675. </aside>
  676. <code class="phpdocumentor-code phpdocumentor-signature ">
  677. <span class="phpdocumentor-signature__visibility">protected</span>
  678. <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>
  679. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  680. <dl class="phpdocumentor-argument-list">
  681. <dt class="phpdocumentor-argument-list__entry">
  682. <span class="phpdocumentor-signature__argument__name">$saveToFile</span>
  683. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  684. </dt>
  685. <dd class="phpdocumentor-argument-list__definition">
  686. <section class="phpdocumentor-description"></section>
  687. </dd>
  688. </dl>
  689. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  690. Tags
  691. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  692. </h5>
  693. <dl class="phpdocumentor-tag-list">
  694. <dt class="phpdocumentor-tag-list__entry">
  695. <span class="phpdocumentor-tag__name">inheritDoc</span>
  696. </dt>
  697. <dd class="phpdocumentor-tag-list__definition">
  698. </dd>
  699. </dl>
  700. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  701. <span class="phpdocumentor-signature__response_type">string</span>
  702. &mdash;
  703. </article>
  704. <article
  705. class="phpdocumentor-element
  706. -method
  707. -protected
  708. "
  709. >
  710. <h4 class="phpdocumentor-element__name" id="method_getCssClass">
  711. getCssClass()
  712. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_getCssClass" class="headerlink"><i class="fas fa-link"></i></a>
  713. </h4>
  714. <aside class="phpdocumentor-element-found-in">
  715. <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>
  716. :
  717. <span class="phpdocumentor-element-found-in__line">145</span>
  718. </aside>
  719. <p class="phpdocumentor-summary">returns a string with all css classes for the current element</p>
  720. <code class="phpdocumentor-code phpdocumentor-signature ">
  721. <span class="phpdocumentor-signature__visibility">protected</span>
  722. <span class="phpdocumentor-signature__name">getCssClass</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  723. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  724. <dl class="phpdocumentor-argument-list">
  725. <dt class="phpdocumentor-argument-list__entry">
  726. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  727. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  728. </dt>
  729. <dd class="phpdocumentor-argument-list__definition">
  730. <section class="phpdocumentor-description"></section>
  731. </dd>
  732. </dl>
  733. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  734. Tags
  735. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  736. </h5>
  737. <dl class="phpdocumentor-tag-list">
  738. <dt class="phpdocumentor-tag-list__entry">
  739. <span class="phpdocumentor-tag__name">inheritDoc</span>
  740. </dt>
  741. <dd class="phpdocumentor-tag-list__definition">
  742. </dd>
  743. </dl>
  744. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  745. <span class="phpdocumentor-signature__response_type">string</span>
  746. &mdash;
  747. </article>
  748. <article
  749. class="phpdocumentor-element
  750. -method
  751. -protected
  752. -abstract "
  753. >
  754. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  755. getDefaultModuleValue()
  756. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  757. </h4>
  758. <aside class="phpdocumentor-element-found-in">
  759. <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>
  760. :
  761. <span class="phpdocumentor-element-found-in__line">133</span>
  762. </aside>
  763. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
  764. <code class="phpdocumentor-code phpdocumentor-signature ">
  765. <span class="phpdocumentor-signature__visibility">protected</span>
  766. <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>
  767. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  768. <dl class="phpdocumentor-argument-list">
  769. <dt class="phpdocumentor-argument-list__entry">
  770. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  771. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  772. </dt>
  773. <dd class="phpdocumentor-argument-list__definition">
  774. <section class="phpdocumentor-description"></section>
  775. </dd>
  776. </dl>
  777. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  778. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  779. &mdash;
  780. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  781. </section>
  782. </article>
  783. <article
  784. class="phpdocumentor-element
  785. -method
  786. -protected
  787. "
  788. >
  789. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  790. getModuleValue()
  791. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  792. </h4>
  793. <aside class="phpdocumentor-element-found-in">
  794. <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>
  795. :
  796. <span class="phpdocumentor-element-found-in__line">100</span>
  797. </aside>
  798. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  799. <code class="phpdocumentor-code phpdocumentor-signature ">
  800. <span class="phpdocumentor-signature__visibility">protected</span>
  801. <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|null</span></code>
  802. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  803. <dl class="phpdocumentor-argument-list">
  804. <dt class="phpdocumentor-argument-list__entry">
  805. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  806. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  807. </dt>
  808. <dd class="phpdocumentor-argument-list__definition">
  809. <section class="phpdocumentor-description"></section>
  810. </dd>
  811. </dl>
  812. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  813. Tags
  814. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  815. </h5>
  816. <dl class="phpdocumentor-tag-list">
  817. <dt class="phpdocumentor-tag-list__entry">
  818. <span class="phpdocumentor-tag__name">throws</span>
  819. </dt>
  820. <dd class="phpdocumentor-tag-list__definition">
  821. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  822. </dd>
  823. </dl>
  824. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  825. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  826. &mdash;
  827. <section class="phpdocumentor-description"><p>return value depends on the output class, null if $moduleValues[$M_TYPE] doesn't exist</p>
  828. </section>
  829. </article>
  830. <article
  831. class="phpdocumentor-element
  832. -method
  833. -protected
  834. "
  835. >
  836. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  837. getModuleValueAt()
  838. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  839. </h4>
  840. <aside class="phpdocumentor-element-found-in">
  841. <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>
  842. :
  843. <span class="phpdocumentor-element-found-in__line">115</span>
  844. </aside>
  845. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  846. <code class="phpdocumentor-code phpdocumentor-signature ">
  847. <span class="phpdocumentor-signature__visibility">protected</span>
  848. <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>
  849. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  850. <dl class="phpdocumentor-argument-list">
  851. <dt class="phpdocumentor-argument-list__entry">
  852. <span class="phpdocumentor-signature__argument__name">$x</span>
  853. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  854. </dt>
  855. <dd class="phpdocumentor-argument-list__definition">
  856. <section class="phpdocumentor-description"></section>
  857. </dd>
  858. <dt class="phpdocumentor-argument-list__entry">
  859. <span class="phpdocumentor-signature__argument__name">$y</span>
  860. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  861. </dt>
  862. <dd class="phpdocumentor-argument-list__definition">
  863. <section class="phpdocumentor-description"></section>
  864. </dd>
  865. </dl>
  866. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  867. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  868. &mdash;
  869. </article>
  870. <article
  871. class="phpdocumentor-element
  872. -method
  873. -protected
  874. "
  875. >
  876. <h4 class="phpdocumentor-element__name" id="method_header">
  877. header()
  878. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_header" class="headerlink"><i class="fas fa-link"></i></a>
  879. </h4>
  880. <aside class="phpdocumentor-element-found-in">
  881. <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>
  882. :
  883. <span class="phpdocumentor-element-found-in__line">75</span>
  884. </aside>
  885. <p class="phpdocumentor-summary">returns the &lt;svg&gt; header with the given options parsed</p>
  886. <code class="phpdocumentor-code phpdocumentor-signature ">
  887. <span class="phpdocumentor-signature__visibility">protected</span>
  888. <span class="phpdocumentor-signature__name">header</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  889. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  890. <span class="phpdocumentor-signature__response_type">string</span>
  891. &mdash;
  892. </article>
  893. <article
  894. class="phpdocumentor-element
  895. -method
  896. -protected
  897. "
  898. >
  899. <h4 class="phpdocumentor-element__name" id="method_module">
  900. module()
  901. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  902. </h4>
  903. <aside class="phpdocumentor-element-found-in">
  904. <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>
  905. :
  906. <span class="phpdocumentor-element-found-in__line">158</span>
  907. </aside>
  908. <p class="phpdocumentor-summary">returns a path segment for a single module</p>
  909. <code class="phpdocumentor-code phpdocumentor-signature ">
  910. <span class="phpdocumentor-signature__visibility">protected</span>
  911. <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>
  912. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  913. <dl class="phpdocumentor-argument-list">
  914. <dt class="phpdocumentor-argument-list__entry">
  915. <span class="phpdocumentor-signature__argument__name">$x</span>
  916. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  917. </dt>
  918. <dd class="phpdocumentor-argument-list__definition">
  919. <section class="phpdocumentor-description"></section>
  920. </dd>
  921. <dt class="phpdocumentor-argument-list__entry">
  922. <span class="phpdocumentor-signature__argument__name">$y</span>
  923. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  924. </dt>
  925. <dd class="phpdocumentor-argument-list__definition">
  926. <section class="phpdocumentor-description"></section>
  927. </dd>
  928. <dt class="phpdocumentor-argument-list__entry">
  929. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  930. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  931. </dt>
  932. <dd class="phpdocumentor-argument-list__definition">
  933. <section class="phpdocumentor-description"></section>
  934. </dd>
  935. </dl>
  936. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  937. Tags
  938. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  939. </h5>
  940. <dl class="phpdocumentor-tag-list">
  941. <dt class="phpdocumentor-tag-list__entry">
  942. <span class="phpdocumentor-tag__name">see</span>
  943. </dt>
  944. <dd class="phpdocumentor-tag-list__definition">
  945. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d">https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d</abbr></a></span>
  946. </dd>
  947. </dl>
  948. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  949. <span class="phpdocumentor-signature__response_type">string</span>
  950. &mdash;
  951. </article>
  952. <article
  953. class="phpdocumentor-element
  954. -method
  955. -protected
  956. "
  957. >
  958. <h4 class="phpdocumentor-element__name" id="method_path">
  959. path()
  960. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_path" class="headerlink"><i class="fas fa-link"></i></a>
  961. </h4>
  962. <aside class="phpdocumentor-element-found-in">
  963. <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>
  964. :
  965. <span class="phpdocumentor-element-found-in__line">126</span>
  966. </aside>
  967. <p class="phpdocumentor-summary">renders and returns a single &lt;path&gt; element</p>
  968. <code class="phpdocumentor-code phpdocumentor-signature ">
  969. <span class="phpdocumentor-signature__visibility">protected</span>
  970. <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>
  971. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  972. <dl class="phpdocumentor-argument-list">
  973. <dt class="phpdocumentor-argument-list__entry">
  974. <span class="phpdocumentor-signature__argument__name">$path</span>
  975. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  976. </dt>
  977. <dd class="phpdocumentor-argument-list__definition">
  978. <section class="phpdocumentor-description"></section>
  979. </dd>
  980. <dt class="phpdocumentor-argument-list__entry">
  981. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  982. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  983. </dt>
  984. <dd class="phpdocumentor-argument-list__definition">
  985. <section class="phpdocumentor-description"></section>
  986. </dd>
  987. </dl>
  988. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  989. Tags
  990. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  991. </h5>
  992. <dl class="phpdocumentor-tag-list">
  993. <dt class="phpdocumentor-tag-list__entry">
  994. <span class="phpdocumentor-tag__name">see</span>
  995. </dt>
  996. <dd class="phpdocumentor-tag-list__definition">
  997. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path"><abbr title="https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path">https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path</abbr></a></span>
  998. </dd>
  999. </dl>
  1000. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1001. <span class="phpdocumentor-signature__response_type">string</span>
  1002. &mdash;
  1003. </article>
  1004. <article
  1005. class="phpdocumentor-element
  1006. -method
  1007. -protected
  1008. "
  1009. >
  1010. <h4 class="phpdocumentor-element__name" id="method_paths">
  1011. paths()
  1012. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#method_paths" class="headerlink"><i class="fas fa-link"></i></a>
  1013. </h4>
  1014. <aside class="phpdocumentor-element-found-in">
  1015. <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>
  1016. :
  1017. <span class="phpdocumentor-element-found-in__line">95</span>
  1018. </aside>
  1019. <p class="phpdocumentor-summary">returns one or more SVG &lt;path&gt; elements</p>
  1020. <code class="phpdocumentor-code phpdocumentor-signature ">
  1021. <span class="phpdocumentor-signature__visibility">protected</span>
  1022. <span class="phpdocumentor-signature__name">paths</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1023. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1024. <span class="phpdocumentor-signature__response_type">string</span>
  1025. &mdash;
  1026. </article>
  1027. <article
  1028. class="phpdocumentor-element
  1029. -method
  1030. -protected
  1031. -abstract "
  1032. >
  1033. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  1034. prepareModuleValue()
  1035. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1036. </h4>
  1037. <aside class="phpdocumentor-element-found-in">
  1038. <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>
  1039. :
  1040. <span class="phpdocumentor-element-found-in__line">126</span>
  1041. </aside>
  1042. <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
  1043. <code class="phpdocumentor-code phpdocumentor-signature ">
  1044. <span class="phpdocumentor-signature__visibility">protected</span>
  1045. <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>
  1046. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1047. <dl class="phpdocumentor-argument-list">
  1048. <dt class="phpdocumentor-argument-list__entry">
  1049. <span class="phpdocumentor-signature__argument__name">$value</span>
  1050. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1051. </dt>
  1052. <dd class="phpdocumentor-argument-list__definition">
  1053. </dd>
  1054. </dl>
  1055. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1056. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  1057. &mdash;
  1058. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  1059. </section>
  1060. </article>
  1061. <article
  1062. class="phpdocumentor-element
  1063. -method
  1064. -protected
  1065. "
  1066. >
  1067. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1068. saveToFile()
  1069. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1070. </h4>
  1071. <aside class="phpdocumentor-element-found-in">
  1072. <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>
  1073. :
  1074. <span class="phpdocumentor-element-found-in__line">150</span>
  1075. </aside>
  1076. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1077. <code class="phpdocumentor-code phpdocumentor-signature ">
  1078. <span class="phpdocumentor-signature__visibility">protected</span>
  1079. <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>
  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">$data</span>
  1084. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1085. </dt>
  1086. <dd class="phpdocumentor-argument-list__definition">
  1087. <section class="phpdocumentor-description"></section>
  1088. </dd>
  1089. <dt class="phpdocumentor-argument-list__entry">
  1090. <span class="phpdocumentor-signature__argument__name">$file</span>
  1091. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1092. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1093. <dd class="phpdocumentor-argument-list__definition">
  1094. <section class="phpdocumentor-description"></section>
  1095. </dd>
  1096. </dl>
  1097. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1098. Tags
  1099. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1100. </h5>
  1101. <dl class="phpdocumentor-tag-list">
  1102. <dt class="phpdocumentor-tag-list__entry">
  1103. <span class="phpdocumentor-tag__name">see</span>
  1104. </dt>
  1105. <dd class="phpdocumentor-tag-list__definition">
  1106. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1107. </dd>
  1108. <dt class="phpdocumentor-tag-list__entry">
  1109. <span class="phpdocumentor-tag__name">see</span>
  1110. </dt>
  1111. <dd class="phpdocumentor-tag-list__definition">
  1112. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1113. </dd>
  1114. <dt class="phpdocumentor-tag-list__entry">
  1115. <span class="phpdocumentor-tag__name">throws</span>
  1116. </dt>
  1117. <dd class="phpdocumentor-tag-list__definition">
  1118. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1119. </dd>
  1120. </dl>
  1121. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1122. <span class="phpdocumentor-signature__response_type">void</span>
  1123. &mdash;
  1124. </article>
  1125. <article
  1126. class="phpdocumentor-element
  1127. -method
  1128. -protected
  1129. "
  1130. >
  1131. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1132. setMatrixDimensions()
  1133. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1134. </h4>
  1135. <aside class="phpdocumentor-element-found-in">
  1136. <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>
  1137. :
  1138. <span class="phpdocumentor-element-found-in__line">73</span>
  1139. </aside>
  1140. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1141. <code class="phpdocumentor-code phpdocumentor-signature ">
  1142. <span class="phpdocumentor-signature__visibility">protected</span>
  1143. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1144. <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>
  1145. </section>
  1146. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1147. <span class="phpdocumentor-signature__response_type">void</span>
  1148. &mdash;
  1149. </article>
  1150. <article
  1151. class="phpdocumentor-element
  1152. -method
  1153. -protected
  1154. "
  1155. >
  1156. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1157. setModuleValues()
  1158. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1159. </h4>
  1160. <aside class="phpdocumentor-element-found-in">
  1161. <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>
  1162. :
  1163. <span class="phpdocumentor-element-found-in__line">82</span>
  1164. </aside>
  1165. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1166. <code class="phpdocumentor-code phpdocumentor-signature ">
  1167. <span class="phpdocumentor-signature__visibility">protected</span>
  1168. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1169. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1170. <span class="phpdocumentor-signature__response_type">void</span>
  1171. &mdash;
  1172. </article>
  1173. <article
  1174. class="phpdocumentor-element
  1175. -method
  1176. -protected
  1177. "
  1178. >
  1179. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1180. toBase64DataURI()
  1181. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1182. </h4>
  1183. <aside class="phpdocumentor-element-found-in">
  1184. <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>
  1185. :
  1186. <span class="phpdocumentor-element-found-in__line">138</span>
  1187. </aside>
  1188. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1189. <code class="phpdocumentor-code phpdocumentor-signature ">
  1190. <span class="phpdocumentor-signature__visibility">protected</span>
  1191. <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>
  1192. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1193. <dl class="phpdocumentor-argument-list">
  1194. <dt class="phpdocumentor-argument-list__entry">
  1195. <span class="phpdocumentor-signature__argument__name">$data</span>
  1196. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1197. </dt>
  1198. <dd class="phpdocumentor-argument-list__definition">
  1199. <section class="phpdocumentor-description"></section>
  1200. </dd>
  1201. <dt class="phpdocumentor-argument-list__entry">
  1202. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1203. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1204. </dt>
  1205. <dd class="phpdocumentor-argument-list__definition">
  1206. <section class="phpdocumentor-description"></section>
  1207. </dd>
  1208. </dl>
  1209. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1210. <span class="phpdocumentor-signature__response_type">string</span>
  1211. &mdash;
  1212. </article>
  1213. </section>
  1214. <script type="text/javascript">
  1215. function loadExternalCodeSnippets(line) {
  1216. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1217. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  1218. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  1219. var language = 'php';
  1220. var code = document.createElement('code');
  1221. code.className = 'language-' + language;
  1222. pre.textContent = '';
  1223. pre.setAttribute('data-line', line)
  1224. code.textContent = 'Loading…';
  1225. pre.appendChild(code);
  1226. var xhr = new XMLHttpRequest();
  1227. xhr.open('GET', src, true);
  1228. xhr.onreadystatechange = function () {
  1229. if (xhr.readyState == 4) {
  1230. if (xhr.status < 400 && xhr.responseText) {
  1231. code.textContent = xhr.responseText;
  1232. Prism.highlightElement(code);
  1233. }
  1234. else if (xhr.status >= 400) {
  1235. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1236. }
  1237. else {
  1238. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  1239. }
  1240. }
  1241. };
  1242. xhr.send(null);
  1243. });
  1244. }
  1245. var modals = document.querySelectorAll("[data-modal]");
  1246. modals.forEach(function (trigger) {
  1247. trigger.addEventListener("click", function (event) {
  1248. //event.preventDefault();
  1249. const modal = document.getElementById(trigger.dataset.modal);
  1250. modal.classList.add("phpdocumentor-modal__open");
  1251. loadExternalCodeSnippets(trigger.dataset.line)
  1252. const exits = modal.querySelectorAll("[data-exit-button]");
  1253. exits.forEach(function (exit) {
  1254. exit.addEventListener("click", function (event) {
  1255. event.preventDefault();
  1256. modal.classList.remove("phpdocumentor-modal__open");
  1257. });
  1258. });
  1259. });
  1260. });
  1261. </script>
  1262. </article>
  1263. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1264. <section class="phpdocumentor-search-results__dialog">
  1265. <header class="phpdocumentor-search-results__header">
  1266. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1267. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1268. </header>
  1269. <section class="phpdocumentor-search-results__body">
  1270. <ul class="phpdocumentor-search-results__entries"></ul>
  1271. </section>
  1272. </section>
  1273. </section>
  1274. </div>
  1275. </div>
  1276. <a href="classes/chillerlan-QRCode-Output-QRMarkupSVG.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1277. </main>
  1278. <script>
  1279. cssVars({});
  1280. </script>
  1281. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1282. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1283. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1284. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1285. </body>
  1286. </html>