chillerlan-QRCode-Output-QRMarkup.html 59 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239
  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"><a href="namespaces/chillerlan.html">chillerlan</a></h4>
  56. <ul class="phpdocumentor-list">
  57. <li>
  58. <a href="namespaces/chillerlan-qrcode.html">QRCode</a>
  59. </li>
  60. <li>
  61. <a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a>
  62. </li>
  63. </ul>
  64. </section>
  65. <section class="phpdocumentor-sidebar__category">
  66. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  67. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
  68. </section>
  69. <section class="phpdocumentor-sidebar__category">
  70. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  71. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  72. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  73. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  74. </section>
  75. <section class="phpdocumentor-sidebar__category">
  76. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  78. </section>
  79. </aside>
  80. <div class="phpdocumentor-column -eight phpdocumentor-content">
  81. <ul class="phpdocumentor-breadcrumbs">
  82. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  83. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  84. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  85. </ul>
  86. <article class="phpdocumentor-element -class">
  87. <h2 class="phpdocumentor-content__title">
  88. QRMarkup
  89. <span class="phpdocumentor-element__extends">
  90. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  91. </span>
  92. <div class="phpdocumentor-element__package">
  93. in package
  94. <ul class="phpdocumentor-breadcrumbs">
  95. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  96. </ul>
  97. </div>
  98. </h2>
  99. <aside class="phpdocumentor-element-found-in">
  100. <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>
  101. :
  102. <span class="phpdocumentor-element-found-in__line">21</span>
  103. </aside>
  104. <p class="phpdocumentor-summary">Converts the matrix into markup types: HTML, SVG, .</p>
  105. <section class="phpdocumentor-description"><p>..</p>
  106. </section>
  107. <h3 id="toc">
  108. Table of Contents
  109. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  110. </h3>
  111. <dl class="phpdocumentor-table-of-contents">
  112. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  113. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#property_defaultMode">$defaultMode</a>
  114. <span>
  115. &nbsp;: string </span>
  116. </dt>
  117. <dd>the default output mode of the current output module</dd>
  118. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  119. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  120. <span>
  121. &nbsp;: int </span>
  122. </dt>
  123. <dd>the side length of the QR image (modules * scale)</dd>
  124. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  125. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  126. <span>
  127. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  128. </dt>
  129. <dd>the (filled) data matrix object</dd>
  130. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  131. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  132. <span>
  133. &nbsp;: int </span>
  134. </dt>
  135. <dd>the current size of the QR matrix</dd>
  136. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  137. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  138. <span>
  139. &nbsp;: array&lt;string|int, mixed&gt; </span>
  140. </dt>
  141. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  142. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  143. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  144. <span>
  145. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  146. </dt>
  147. <dd></dd>
  148. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  149. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_outputMode">$outputMode</a>
  150. <span>
  151. &nbsp;: string </span>
  152. </dt>
  153. <dd>the current output mode</dd>
  154. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  155. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  156. <span>
  157. &nbsp;: int </span>
  158. </dt>
  159. <dd>the current scaling for a QR pixel</dd>
  160. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  161. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  162. <span>
  163. &nbsp;: mixed </span>
  164. </dt>
  165. <dd>QROutputAbstract constructor.</dd>
  166. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  167. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_dump">dump()</a>
  168. <span>
  169. &nbsp;: mixed </span>
  170. </dt>
  171. <dd>generates the output, optionally dumps it to a file, and returns it</dd>
  172. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  173. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode">base64encode()</a>
  174. <span>
  175. &nbsp;: string </span>
  176. </dt>
  177. <dd>Returns a base64 data URI for the given string and mime type</dd>
  178. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  179. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_html">html()</a>
  180. <span>
  181. &nbsp;: string </span>
  182. </dt>
  183. <dd>HTML output</dd>
  184. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  185. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  186. <span>
  187. &nbsp;: bool </span>
  188. </dt>
  189. <dd>saves the qr data to a file</dd>
  190. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  191. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_setModuleValues">setModuleValues()</a>
  192. <span>
  193. &nbsp;: void </span>
  194. </dt>
  195. <dd>Sets the initial module values (clean-up &amp; defaults)</dd>
  196. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  197. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_svg">svg()</a>
  198. <span>
  199. &nbsp;: string </span>
  200. </dt>
  201. <dd>SVG output</dd>
  202. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  203. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_svgHeader">svgHeader()</a>
  204. <span>
  205. &nbsp;: string </span>
  206. </dt>
  207. <dd>returns the &lt;svg&gt; header with the given options parsed</dd>
  208. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  209. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_svgModule">svgModule()</a>
  210. <span>
  211. &nbsp;: string </span>
  212. </dt>
  213. <dd>returns a path segment for a single module</dd>
  214. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  215. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_svgPaths">svgPaths()</a>
  216. <span>
  217. &nbsp;: string </span>
  218. </dt>
  219. <dd>returns one or more SVG &lt;path&gt; elements</dd>
  220. </dl>
  221. <section class="phpdocumentor-properties">
  222. <h3 class="phpdocumentor-elements__header" id="properties">
  223. Properties
  224. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  225. </h3>
  226. <article
  227. class="
  228. phpdocumentor-element
  229. -property
  230. -protected
  231. "
  232. >
  233. <h4 class="phpdocumentor-element__name" id="property_defaultMode">
  234. $defaultMode
  235. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#property_defaultMode" class="headerlink"><i class="fas fa-link"></i></a>
  236. <span class="phpdocumentor-element__modifiers">
  237. </span>
  238. </h4>
  239. <aside class="phpdocumentor-element-found-in">
  240. <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>
  241. :
  242. <span class="phpdocumentor-element-found-in__line">23</span>
  243. </aside>
  244. <p class="phpdocumentor-summary">the default output mode of the current output module</p>
  245. <code class="phpdocumentor-code phpdocumentor-signature ">
  246. <span class="phpdocumentor-signature__visibility">protected</span>
  247. <span class="phpdocumentor-signature__type">string</span>
  248. <span class="phpdocumentor-signature__name">$defaultMode</span>
  249. = <span class="phpdocumentor-signature__default-value">chillerlanQRCodeQRCode::OUTPUT_MARKUP_SVG</span></code>
  250. <section class="phpdocumentor-description"></section>
  251. </article>
  252. <article
  253. class="
  254. phpdocumentor-element
  255. -property
  256. -protected
  257. "
  258. >
  259. <h4 class="phpdocumentor-element__name" id="property_length">
  260. $length
  261. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  262. <span class="phpdocumentor-element__modifiers">
  263. </span>
  264. </h4>
  265. <aside class="phpdocumentor-element-found-in">
  266. <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>
  267. :
  268. <span class="phpdocumentor-element-found-in__line">51</span>
  269. </aside>
  270. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  271. <code class="phpdocumentor-code phpdocumentor-signature ">
  272. <span class="phpdocumentor-signature__visibility">protected</span>
  273. <span class="phpdocumentor-signature__type">int</span>
  274. <span class="phpdocumentor-signature__name">$length</span>
  275. </code>
  276. <section class="phpdocumentor-description"></section>
  277. </article>
  278. <article
  279. class="
  280. phpdocumentor-element
  281. -property
  282. -protected
  283. "
  284. >
  285. <h4 class="phpdocumentor-element__name" id="property_matrix">
  286. $matrix
  287. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  288. <span class="phpdocumentor-element__modifiers">
  289. </span>
  290. </h4>
  291. <aside class="phpdocumentor-element-found-in">
  292. <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>
  293. :
  294. <span class="phpdocumentor-element-found-in__line">61</span>
  295. </aside>
  296. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  297. <code class="phpdocumentor-code phpdocumentor-signature ">
  298. <span class="phpdocumentor-signature__visibility">protected</span>
  299. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  300. <span class="phpdocumentor-signature__name">$matrix</span>
  301. </code>
  302. <section class="phpdocumentor-description"></section>
  303. </article>
  304. <article
  305. class="
  306. phpdocumentor-element
  307. -property
  308. -protected
  309. "
  310. >
  311. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  312. $moduleCount
  313. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  314. <span class="phpdocumentor-element__modifiers">
  315. </span>
  316. </h4>
  317. <aside class="phpdocumentor-element-found-in">
  318. <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>
  319. :
  320. <span class="phpdocumentor-element-found-in__line">27</span>
  321. </aside>
  322. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  323. <code class="phpdocumentor-code phpdocumentor-signature ">
  324. <span class="phpdocumentor-signature__visibility">protected</span>
  325. <span class="phpdocumentor-signature__type">int</span>
  326. <span class="phpdocumentor-signature__name">$moduleCount</span>
  327. </code>
  328. <section class="phpdocumentor-description"></section>
  329. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  330. Tags
  331. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  332. </h5>
  333. <dl class="phpdocumentor-tag-list">
  334. <dt class="phpdocumentor-tag-list__entry">
  335. <span class="phpdocumentor-tag__name">see</span>
  336. </dt>
  337. <dd class="phpdocumentor-tag-list__definition">
  338. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_size"><abbr title="\chillerlan\QRCode\Data\QRMatrix::size()">QRMatrix::size()</abbr></a></span>
  339. </dd>
  340. </dl>
  341. </article>
  342. <article
  343. class="
  344. phpdocumentor-element
  345. -property
  346. -protected
  347. "
  348. >
  349. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  350. $moduleValues
  351. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  352. <span class="phpdocumentor-element__modifiers">
  353. </span>
  354. </h4>
  355. <aside class="phpdocumentor-element-found-in">
  356. <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>
  357. :
  358. <span class="phpdocumentor-element-found-in__line">56</span>
  359. </aside>
  360. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  361. <code class="phpdocumentor-code phpdocumentor-signature ">
  362. <span class="phpdocumentor-signature__visibility">protected</span>
  363. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  364. <span class="phpdocumentor-signature__name">$moduleValues</span>
  365. </code>
  366. <section class="phpdocumentor-description"></section>
  367. </article>
  368. <article
  369. class="
  370. phpdocumentor-element
  371. -property
  372. -protected
  373. "
  374. >
  375. <h4 class="phpdocumentor-element__name" id="property_options">
  376. $options
  377. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  378. <span class="phpdocumentor-element__modifiers">
  379. </span>
  380. </h4>
  381. <aside class="phpdocumentor-element-found-in">
  382. <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>
  383. :
  384. <span class="phpdocumentor-element-found-in__line">66</span>
  385. </aside>
  386. <code class="phpdocumentor-code phpdocumentor-signature ">
  387. <span class="phpdocumentor-signature__visibility">protected</span>
  388. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  389. <span class="phpdocumentor-signature__name">$options</span>
  390. </code>
  391. </article>
  392. <article
  393. class="
  394. phpdocumentor-element
  395. -property
  396. -protected
  397. "
  398. >
  399. <h4 class="phpdocumentor-element__name" id="property_outputMode">
  400. $outputMode
  401. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_outputMode" class="headerlink"><i class="fas fa-link"></i></a>
  402. <span class="phpdocumentor-element__modifiers">
  403. </span>
  404. </h4>
  405. <aside class="phpdocumentor-element-found-in">
  406. <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>
  407. :
  408. <span class="phpdocumentor-element-found-in__line">34</span>
  409. </aside>
  410. <p class="phpdocumentor-summary">the current output mode</p>
  411. <code class="phpdocumentor-code phpdocumentor-signature ">
  412. <span class="phpdocumentor-signature__visibility">protected</span>
  413. <span class="phpdocumentor-signature__type">string</span>
  414. <span class="phpdocumentor-signature__name">$outputMode</span>
  415. </code>
  416. <section class="phpdocumentor-description"></section>
  417. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  418. Tags
  419. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  420. </h5>
  421. <dl class="phpdocumentor-tag-list">
  422. <dt class="phpdocumentor-tag-list__entry">
  423. <span class="phpdocumentor-tag__name">see</span>
  424. </dt>
  425. <dd class="phpdocumentor-tag-list__definition">
  426. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$outputType">QROptions::$outputType</abbr></span>
  427. </dd>
  428. </dl>
  429. </article>
  430. <article
  431. class="
  432. phpdocumentor-element
  433. -property
  434. -protected
  435. "
  436. >
  437. <h4 class="phpdocumentor-element__name" id="property_scale">
  438. $scale
  439. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  440. <span class="phpdocumentor-element__modifiers">
  441. </span>
  442. </h4>
  443. <aside class="phpdocumentor-element-found-in">
  444. <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>
  445. :
  446. <span class="phpdocumentor-element-found-in__line">46</span>
  447. </aside>
  448. <p class="phpdocumentor-summary">the current scaling for a QR pixel</p>
  449. <code class="phpdocumentor-code phpdocumentor-signature ">
  450. <span class="phpdocumentor-signature__visibility">protected</span>
  451. <span class="phpdocumentor-signature__type">int</span>
  452. <span class="phpdocumentor-signature__name">$scale</span>
  453. </code>
  454. <section class="phpdocumentor-description"></section>
  455. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  456. Tags
  457. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  458. </h5>
  459. <dl class="phpdocumentor-tag-list">
  460. <dt class="phpdocumentor-tag-list__entry">
  461. <span class="phpdocumentor-tag__name">see</span>
  462. </dt>
  463. <dd class="phpdocumentor-tag-list__definition">
  464. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  465. </dd>
  466. </dl>
  467. </article>
  468. </section>
  469. <section class="phpdocumentor-methods">
  470. <h3 class="phpdocumentor-elements__header" id="methods">
  471. Methods
  472. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  473. </h3>
  474. <article
  475. class="phpdocumentor-element
  476. -method
  477. -public
  478. "
  479. >
  480. <h4 class="phpdocumentor-element__name" id="method___construct">
  481. __construct()
  482. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  483. </h4>
  484. <aside class="phpdocumentor-element-found-in">
  485. <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>
  486. :
  487. <span class="phpdocumentor-element-found-in__line">71</span>
  488. </aside>
  489. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  490. <code class="phpdocumentor-code phpdocumentor-signature ">
  491. <span class="phpdocumentor-signature__visibility">public</span>
  492. <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>
  493. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  494. <dl class="phpdocumentor-argument-list">
  495. <dt class="phpdocumentor-argument-list__entry">
  496. <span class="phpdocumentor-signature__argument__name">$options</span>
  497. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  498. </dt>
  499. <dd class="phpdocumentor-argument-list__definition">
  500. <section class="phpdocumentor-description"></section>
  501. </dd>
  502. <dt class="phpdocumentor-argument-list__entry">
  503. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  504. : <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>
  505. </dt>
  506. <dd class="phpdocumentor-argument-list__definition">
  507. <section class="phpdocumentor-description"></section>
  508. </dd>
  509. </dl>
  510. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  511. <span class="phpdocumentor-signature__response_type">mixed</span>
  512. &mdash;
  513. </article>
  514. <article
  515. class="phpdocumentor-element
  516. -method
  517. -public
  518. "
  519. >
  520. <h4 class="phpdocumentor-element__name" id="method_dump">
  521. dump()
  522. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  523. </h4>
  524. <aside class="phpdocumentor-element-found-in">
  525. <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>
  526. :
  527. <span class="phpdocumentor-element-found-in__line">118</span>
  528. </aside>
  529. <p class="phpdocumentor-summary">generates the output, optionally dumps it to a file, and returns it</p>
  530. <code class="phpdocumentor-code phpdocumentor-signature ">
  531. <span class="phpdocumentor-signature__visibility">public</span>
  532. <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">mixed</span></code>
  533. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  534. <dl class="phpdocumentor-argument-list">
  535. <dt class="phpdocumentor-argument-list__entry">
  536. <span class="phpdocumentor-signature__argument__name">$file</span>
  537. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  538. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  539. <dd class="phpdocumentor-argument-list__definition">
  540. <section class="phpdocumentor-description"></section>
  541. </dd>
  542. </dl>
  543. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  544. Tags
  545. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  546. </h5>
  547. <dl class="phpdocumentor-tag-list">
  548. <dt class="phpdocumentor-tag-list__entry">
  549. <span class="phpdocumentor-tag__name">inheritDoc</span>
  550. </dt>
  551. <dd class="phpdocumentor-tag-list__definition">
  552. </dd>
  553. </dl>
  554. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  555. <span class="phpdocumentor-signature__response_type">mixed</span>
  556. &mdash;
  557. </article>
  558. <article
  559. class="phpdocumentor-element
  560. -method
  561. -protected
  562. "
  563. >
  564. <h4 class="phpdocumentor-element__name" id="method_base64encode">
  565. base64encode()
  566. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_base64encode" class="headerlink"><i class="fas fa-link"></i></a>
  567. </h4>
  568. <aside class="phpdocumentor-element-found-in">
  569. <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>
  570. :
  571. <span class="phpdocumentor-element-found-in__line">94</span>
  572. </aside>
  573. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  574. <code class="phpdocumentor-code phpdocumentor-signature ">
  575. <span class="phpdocumentor-signature__visibility">protected</span>
  576. <span class="phpdocumentor-signature__name">base64encode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  577. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  578. <dl class="phpdocumentor-argument-list">
  579. <dt class="phpdocumentor-argument-list__entry">
  580. <span class="phpdocumentor-signature__argument__name">$data</span>
  581. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  582. </dt>
  583. <dd class="phpdocumentor-argument-list__definition">
  584. <section class="phpdocumentor-description"></section>
  585. </dd>
  586. <dt class="phpdocumentor-argument-list__entry">
  587. <span class="phpdocumentor-signature__argument__name">$mime</span>
  588. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  589. </dt>
  590. <dd class="phpdocumentor-argument-list__definition">
  591. <section class="phpdocumentor-description"></section>
  592. </dd>
  593. </dl>
  594. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  595. <span class="phpdocumentor-signature__response_type">string</span>
  596. &mdash;
  597. </article>
  598. <article
  599. class="phpdocumentor-element
  600. -method
  601. -protected
  602. "
  603. >
  604. <h4 class="phpdocumentor-element__name" id="method_html">
  605. html()
  606. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_html" class="headerlink"><i class="fas fa-link"></i></a>
  607. </h4>
  608. <aside class="phpdocumentor-element-found-in">
  609. <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>
  610. :
  611. <span class="phpdocumentor-element-found-in__line">49</span>
  612. </aside>
  613. <p class="phpdocumentor-summary">HTML output</p>
  614. <code class="phpdocumentor-code phpdocumentor-signature ">
  615. <span class="phpdocumentor-signature__visibility">protected</span>
  616. <span class="phpdocumentor-signature__name">html</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>
  617. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  618. <dl class="phpdocumentor-argument-list">
  619. <dt class="phpdocumentor-argument-list__entry">
  620. <span class="phpdocumentor-signature__argument__name">$file</span>
  621. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  622. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  623. <dd class="phpdocumentor-argument-list__definition">
  624. <section class="phpdocumentor-description"></section>
  625. </dd>
  626. </dl>
  627. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  628. <span class="phpdocumentor-signature__response_type">string</span>
  629. &mdash;
  630. </article>
  631. <article
  632. class="phpdocumentor-element
  633. -method
  634. -protected
  635. "
  636. >
  637. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  638. saveToFile()
  639. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  640. </h4>
  641. <aside class="phpdocumentor-element-found-in">
  642. <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>
  643. :
  644. <span class="phpdocumentor-element-found-in__line">106</span>
  645. </aside>
  646. <p class="phpdocumentor-summary">saves the qr data to a file</p>
  647. <code class="phpdocumentor-code phpdocumentor-signature ">
  648. <span class="phpdocumentor-signature__visibility">protected</span>
  649. <span class="phpdocumentor-signature__name">saveToFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  650. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  651. <dl class="phpdocumentor-argument-list">
  652. <dt class="phpdocumentor-argument-list__entry">
  653. <span class="phpdocumentor-signature__argument__name">$data</span>
  654. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  655. </dt>
  656. <dd class="phpdocumentor-argument-list__definition">
  657. <section class="phpdocumentor-description"></section>
  658. </dd>
  659. <dt class="phpdocumentor-argument-list__entry">
  660. <span class="phpdocumentor-signature__argument__name">$file</span>
  661. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  662. </dt>
  663. <dd class="phpdocumentor-argument-list__definition">
  664. <section class="phpdocumentor-description"></section>
  665. </dd>
  666. </dl>
  667. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  668. Tags
  669. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  670. </h5>
  671. <dl class="phpdocumentor-tag-list">
  672. <dt class="phpdocumentor-tag-list__entry">
  673. <span class="phpdocumentor-tag__name">see</span>
  674. </dt>
  675. <dd class="phpdocumentor-tag-list__definition">
  676. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  677. </dd>
  678. <dt class="phpdocumentor-tag-list__entry">
  679. <span class="phpdocumentor-tag__name">see</span>
  680. </dt>
  681. <dd class="phpdocumentor-tag-list__definition">
  682. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::cachefile">QROptions::cachefile</abbr></span>
  683. </dd>
  684. <dt class="phpdocumentor-tag-list__entry">
  685. <span class="phpdocumentor-tag__name">throws</span>
  686. </dt>
  687. <dd class="phpdocumentor-tag-list__definition">
  688. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  689. </dd>
  690. </dl>
  691. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  692. <span class="phpdocumentor-signature__response_type">bool</span>
  693. &mdash;
  694. </article>
  695. <article
  696. class="phpdocumentor-element
  697. -method
  698. -protected
  699. "
  700. >
  701. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  702. setModuleValues()
  703. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  704. </h4>
  705. <aside class="phpdocumentor-element-found-in">
  706. <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>
  707. :
  708. <span class="phpdocumentor-element-found-in__line">28</span>
  709. </aside>
  710. <p class="phpdocumentor-summary">Sets the initial module values (clean-up &amp; defaults)</p>
  711. <code class="phpdocumentor-code phpdocumentor-signature ">
  712. <span class="phpdocumentor-signature__visibility">protected</span>
  713. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  714. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  715. Tags
  716. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  717. </h5>
  718. <dl class="phpdocumentor-tag-list">
  719. <dt class="phpdocumentor-tag-list__entry">
  720. <span class="phpdocumentor-tag__name">inheritDoc</span>
  721. </dt>
  722. <dd class="phpdocumentor-tag-list__definition">
  723. </dd>
  724. </dl>
  725. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  726. <span class="phpdocumentor-signature__response_type">void</span>
  727. &mdash;
  728. </article>
  729. <article
  730. class="phpdocumentor-element
  731. -method
  732. -protected
  733. "
  734. >
  735. <h4 class="phpdocumentor-element__name" id="method_svg">
  736. svg()
  737. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_svg" class="headerlink"><i class="fas fa-link"></i></a>
  738. </h4>
  739. <aside class="phpdocumentor-element-found-in">
  740. <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>
  741. :
  742. <span class="phpdocumentor-element-found-in__line">86</span>
  743. </aside>
  744. <p class="phpdocumentor-summary">SVG output</p>
  745. <code class="phpdocumentor-code phpdocumentor-signature ">
  746. <span class="phpdocumentor-signature__visibility">protected</span>
  747. <span class="phpdocumentor-signature__name">svg</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>
  748. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  749. <dl class="phpdocumentor-argument-list">
  750. <dt class="phpdocumentor-argument-list__entry">
  751. <span class="phpdocumentor-signature__argument__name">$file</span>
  752. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  753. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  754. <dd class="phpdocumentor-argument-list__definition">
  755. <section class="phpdocumentor-description"></section>
  756. </dd>
  757. </dl>
  758. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  759. Tags
  760. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  761. </h5>
  762. <dl class="phpdocumentor-tag-list">
  763. <dt class="phpdocumentor-tag-list__entry">
  764. <span class="phpdocumentor-tag__name">see</span>
  765. </dt>
  766. <dd class="phpdocumentor-tag-list__definition">
  767. <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>
  768. </dd>
  769. <dt class="phpdocumentor-tag-list__entry">
  770. <span class="phpdocumentor-tag__name">see</span>
  771. </dt>
  772. <dd class="phpdocumentor-tag-list__definition">
  773. <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>
  774. </dd>
  775. <dt class="phpdocumentor-tag-list__entry">
  776. <span class="phpdocumentor-tag__name">see</span>
  777. </dt>
  778. <dd class="phpdocumentor-tag-list__definition">
  779. <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>
  780. </dd>
  781. </dl>
  782. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  783. <span class="phpdocumentor-signature__response_type">string</span>
  784. &mdash;
  785. </article>
  786. <article
  787. class="phpdocumentor-element
  788. -method
  789. -protected
  790. "
  791. >
  792. <h4 class="phpdocumentor-element__name" id="method_svgHeader">
  793. svgHeader()
  794. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_svgHeader" class="headerlink"><i class="fas fa-link"></i></a>
  795. </h4>
  796. <aside class="phpdocumentor-element-found-in">
  797. <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>
  798. :
  799. <span class="phpdocumentor-element-found-in__line">109</span>
  800. </aside>
  801. <p class="phpdocumentor-summary">returns the &lt;svg&gt; header with the given options parsed</p>
  802. <code class="phpdocumentor-code phpdocumentor-signature ">
  803. <span class="phpdocumentor-signature__visibility">protected</span>
  804. <span class="phpdocumentor-signature__name">svgHeader</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  805. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  806. <span class="phpdocumentor-signature__response_type">string</span>
  807. &mdash;
  808. </article>
  809. <article
  810. class="phpdocumentor-element
  811. -method
  812. -protected
  813. "
  814. >
  815. <h4 class="phpdocumentor-element__name" id="method_svgModule">
  816. svgModule()
  817. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_svgModule" class="headerlink"><i class="fas fa-link"></i></a>
  818. </h4>
  819. <aside class="phpdocumentor-element-found-in">
  820. <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>
  821. :
  822. <span class="phpdocumentor-element-found-in__line">186</span>
  823. </aside>
  824. <p class="phpdocumentor-summary">returns a path segment for a single module</p>
  825. <code class="phpdocumentor-code phpdocumentor-signature ">
  826. <span class="phpdocumentor-signature__visibility">protected</span>
  827. <span class="phpdocumentor-signature__name">svgModule</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  828. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  829. <dl class="phpdocumentor-argument-list">
  830. <dt class="phpdocumentor-argument-list__entry">
  831. <span class="phpdocumentor-signature__argument__name">$x</span>
  832. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  833. </dt>
  834. <dd class="phpdocumentor-argument-list__definition">
  835. <section class="phpdocumentor-description"></section>
  836. </dd>
  837. <dt class="phpdocumentor-argument-list__entry">
  838. <span class="phpdocumentor-signature__argument__name">$y</span>
  839. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  840. </dt>
  841. <dd class="phpdocumentor-argument-list__definition">
  842. <section class="phpdocumentor-description"></section>
  843. </dd>
  844. </dl>
  845. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  846. Tags
  847. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  848. </h5>
  849. <dl class="phpdocumentor-tag-list">
  850. <dt class="phpdocumentor-tag-list__entry">
  851. <span class="phpdocumentor-tag__name">see</span>
  852. </dt>
  853. <dd class="phpdocumentor-tag-list__definition">
  854. <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>
  855. </dd>
  856. </dl>
  857. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  858. <span class="phpdocumentor-signature__response_type">string</span>
  859. &mdash;
  860. </article>
  861. <article
  862. class="phpdocumentor-element
  863. -method
  864. -protected
  865. "
  866. >
  867. <h4 class="phpdocumentor-element__name" id="method_svgPaths">
  868. svgPaths()
  869. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#method_svgPaths" class="headerlink"><i class="fas fa-link"></i></a>
  870. </h4>
  871. <aside class="phpdocumentor-element-found-in">
  872. <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>
  873. :
  874. <span class="phpdocumentor-element-found-in__line">131</span>
  875. </aside>
  876. <p class="phpdocumentor-summary">returns one or more SVG &lt;path&gt; elements</p>
  877. <code class="phpdocumentor-code phpdocumentor-signature ">
  878. <span class="phpdocumentor-signature__visibility">protected</span>
  879. <span class="phpdocumentor-signature__name">svgPaths</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  880. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  881. Tags
  882. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  883. </h5>
  884. <dl class="phpdocumentor-tag-list">
  885. <dt class="phpdocumentor-tag-list__entry">
  886. <span class="phpdocumentor-tag__name">see</span>
  887. </dt>
  888. <dd class="phpdocumentor-tag-list__definition">
  889. <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>
  890. </dd>
  891. </dl>
  892. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  893. <span class="phpdocumentor-signature__response_type">string</span>
  894. &mdash;
  895. </article>
  896. </section>
  897. <script type="text/javascript">
  898. function loadExternalCodeSnippets(line) {
  899. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  900. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  901. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  902. var language = 'php';
  903. var code = document.createElement('code');
  904. code.className = 'language-' + language;
  905. pre.textContent = '';
  906. pre.setAttribute('data-line', line)
  907. code.textContent = 'Loading…';
  908. pre.appendChild(code);
  909. var xhr = new XMLHttpRequest();
  910. xhr.open('GET', src, true);
  911. xhr.onreadystatechange = function () {
  912. if (xhr.readyState == 4) {
  913. if (xhr.status < 400 && xhr.responseText) {
  914. code.textContent = xhr.responseText;
  915. Prism.highlightElement(code);
  916. }
  917. else if (xhr.status >= 400) {
  918. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  919. }
  920. else {
  921. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  922. }
  923. }
  924. };
  925. xhr.send(null);
  926. });
  927. }
  928. var modals = document.querySelectorAll("[data-modal]");
  929. modals.forEach(function (trigger) {
  930. trigger.addEventListener("click", function (event) {
  931. //event.preventDefault();
  932. const modal = document.getElementById(trigger.dataset.modal);
  933. modal.classList.add("phpdocumentor-modal__open");
  934. loadExternalCodeSnippets(trigger.dataset.line)
  935. const exits = modal.querySelectorAll("[data-exit-button]");
  936. exits.forEach(function (exit) {
  937. exit.addEventListener("click", function (event) {
  938. event.preventDefault();
  939. modal.classList.remove("phpdocumentor-modal__open");
  940. });
  941. });
  942. });
  943. });
  944. </script>
  945. </article>
  946. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  947. <section class="phpdocumentor-search-results__dialog">
  948. <header class="phpdocumentor-search-results__header">
  949. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  950. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  951. </header>
  952. <section class="phpdocumentor-search-results__body">
  953. <ul class="phpdocumentor-search-results__entries"></ul>
  954. </section>
  955. </section>
  956. </section>
  957. </div>
  958. </div>
  959. <a href="classes/chillerlan-QRCode-Output-QRMarkup.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  960. </main>
  961. <script>
  962. cssVars({});
  963. </script>
  964. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  965. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  966. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  967. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  968. </body>
  969. </html>