chillerlan-QRCode-Output-QRMarkup.html 64 KB

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