chillerlan-QRCode-Output-QRMarkup.html 67 KB

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