chillerlan-QRCode-Output-QROutputInterface.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. <h4 class="phpdocumentor-sidebar__root-namespace">
  89. <a href="namespaces/output.html" class="">Output</a>
  90. </h4>
  91. </section>
  92. <section class="phpdocumentor-sidebar__category -packages">
  93. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  94. <h4 class="phpdocumentor-sidebar__root-namespace">
  95. <a href="packages/Application.html" class="">Application</a>
  96. </h4>
  97. </section>
  98. <section class="phpdocumentor-sidebar__category -reports">
  99. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  100. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  101. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  102. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  103. </section>
  104. <section class="phpdocumentor-sidebar__category -indices">
  105. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  106. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  107. </section>
  108. </aside>
  109. <div class="phpdocumentor-column -nine phpdocumentor-content">
  110. <section>
  111. <ul class="phpdocumentor-breadcrumbs">
  112. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  113. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  114. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  115. </ul>
  116. <article class="phpdocumentor-element -interface">
  117. <h2 class="phpdocumentor-content__title">
  118. QROutputInterface
  119. <div class="phpdocumentor-element__package">
  120. in
  121. <ul class="phpdocumentor-breadcrumbs">
  122. <li><a href="packages/Application.html">Application</a></li>
  123. </ul>
  124. </div>
  125. </h2>
  126. <aside class="phpdocumentor-element-found-in">
  127. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
  128. :
  129. <span class="phpdocumentor-element-found-in__line">18</span>
  130. </aside>
  131. <p class="phpdocumentor-summary">Converts the data matrix into readable output</p>
  132. <h3 id="toc">
  133. Table of Contents
  134. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  135. </h3>
  136. <h4 id="toc-constants">
  137. Constants
  138. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  139. </h4>
  140. <dl class="phpdocumentor-table-of-contents">
  141. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  142. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_DEFAULT_MODULE_VALUES">DEFAULT_MODULE_VALUES</a>
  143. <span>
  144. &nbsp;= [
  145. // light
  146. \chillerlan\QRCode\Data\QRMatrix::M_NULL =&gt; false,
  147. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT =&gt; false,
  148. \chillerlan\QRCode\Data\QRMatrix::M_DATA =&gt; false,
  149. \chillerlan\QRCode\Data\QRMatrix::M_FINDER =&gt; false,
  150. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR =&gt; false,
  151. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT =&gt; false,
  152. \chillerlan\QRCode\Data\QRMatrix::M_TIMING =&gt; false,
  153. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT =&gt; false,
  154. \chillerlan\QRCode\Data\QRMatrix::M_VERSION =&gt; false,
  155. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE =&gt; false,
  156. \chillerlan\QRCode\Data\QRMatrix::M_LOGO =&gt; false,
  157. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT =&gt; false,
  158. // dark
  159. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE =&gt; true,
  160. \chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK =&gt; true,
  161. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK =&gt; true,
  162. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK =&gt; true,
  163. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK =&gt; true,
  164. \chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK =&gt; true,
  165. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK =&gt; true,
  166. \chillerlan\QRCode\Data\QRMatrix::M_VERSION_DARK =&gt; true,
  167. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE_DARK =&gt; true,
  168. \chillerlan\QRCode\Data\QRMatrix::M_LOGO_DARK =&gt; true,
  169. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT =&gt; true,
  170. ] </span>
  171. </dt>
  172. <dd>Map of module type =&gt; default value</dd>
  173. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  174. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_LAYERNAMES">LAYERNAMES</a>
  175. <span>
  176. &nbsp;= [
  177. // light
  178. \chillerlan\QRCode\Data\QRMatrix::M_NULL =&gt; &#039;null&#039;,
  179. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT =&gt; &#039;darkmodule-light&#039;,
  180. \chillerlan\QRCode\Data\QRMatrix::M_DATA =&gt; &#039;data&#039;,
  181. \chillerlan\QRCode\Data\QRMatrix::M_FINDER =&gt; &#039;finder&#039;,
  182. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR =&gt; &#039;separator&#039;,
  183. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT =&gt; &#039;alignment&#039;,
  184. \chillerlan\QRCode\Data\QRMatrix::M_TIMING =&gt; &#039;timing&#039;,
  185. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT =&gt; &#039;format&#039;,
  186. \chillerlan\QRCode\Data\QRMatrix::M_VERSION =&gt; &#039;version&#039;,
  187. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE =&gt; &#039;quietzone&#039;,
  188. \chillerlan\QRCode\Data\QRMatrix::M_LOGO =&gt; &#039;logo&#039;,
  189. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT =&gt; &#039;finder-dot-light&#039;,
  190. // dark
  191. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE =&gt; &#039;darkmodule&#039;,
  192. \chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK =&gt; &#039;data-dark&#039;,
  193. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK =&gt; &#039;finder-dark&#039;,
  194. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK =&gt; &#039;separator-dark&#039;,
  195. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK =&gt; &#039;alignment-dark&#039;,
  196. \chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK =&gt; &#039;timing-dark&#039;,
  197. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK =&gt; &#039;format-dark&#039;,
  198. \chillerlan\QRCode\Data\QRMatrix::M_VERSION_DARK =&gt; &#039;version-dark&#039;,
  199. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE_DARK =&gt; &#039;quietzone-dark&#039;,
  200. \chillerlan\QRCode\Data\QRMatrix::M_LOGO_DARK =&gt; &#039;logo-dark&#039;,
  201. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT =&gt; &#039;finder-dot&#039;,
  202. ] </span>
  203. </dt>
  204. <dd>Map of module type =&gt; readable name (for CSS etc.)</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  206. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MIME_TYPE">MIME_TYPE</a>
  207. <span>
  208. &nbsp;= &#039;&#039; </span>
  209. </dt>
  210. <dd>Note: do not call this constant from the interface, but rather from one of the child classes</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  212. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES">MODES</a>
  213. <span>
  214. &nbsp;= [\chillerlan\QRCode\Output\QREps::class, \chillerlan\QRCode\Output\QRFpdf::class, \chillerlan\QRCode\Output\QRGdImageAVIF::class, \chillerlan\QRCode\Output\QRGdImageBMP::class, \chillerlan\QRCode\Output\QRGdImageGIF::class, \chillerlan\QRCode\Output\QRGdImageJPEG::class, \chillerlan\QRCode\Output\QRGdImagePNG::class, \chillerlan\QRCode\Output\QRGdImageWEBP::class, \chillerlan\QRCode\Output\QRImagick::class, \chillerlan\QRCode\Output\QRInterventionImage::class, \chillerlan\QRCode\Output\QRMarkupHTML::class, \chillerlan\QRCode\Output\QRMarkupSVG::class, \chillerlan\QRCode\Output\QRMarkupXML::class, \chillerlan\QRCode\Output\QRStringJSON::class, \chillerlan\QRCode\Output\QRStringText::class] </span>
  215. </dt>
  216. <dd>Map of built-in output class FQN</dd>
  217. </dl>
  218. <h4 id="toc-methods">
  219. Methods
  220. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  221. </h4>
  222. <dl class="phpdocumentor-table-of-contents">
  223. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  224. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump">dump()</a>
  225. <span>
  226. &nbsp;: mixed </span>
  227. </dt>
  228. <dd>Generates the output, optionally dumps it to a file, and returns it</dd>
  229. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  230. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  231. <span>
  232. &nbsp;: bool </span>
  233. </dt>
  234. <dd>Determines whether the given value is valid</dd>
  235. </dl>
  236. <section class="phpdocumentor-constants">
  237. <h3 class="phpdocumentor-elements__header" id="constants">
  238. Constants
  239. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  240. </h3>
  241. <article class="phpdocumentor-element -constant -public ">
  242. <h4 class="phpdocumentor-element__name" id="constant_DEFAULT_MODULE_VALUES">
  243. DEFAULT_MODULE_VALUES
  244. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_DEFAULT_MODULE_VALUES" class="headerlink"><i class="fas fa-link"></i></a>
  245. </h4>
  246. <aside class="phpdocumentor-element-found-in">
  247. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
  248. :
  249. <span class="phpdocumentor-element-found-in__line">49</span>
  250. </aside>
  251. <p class="phpdocumentor-summary">Map of module type =&gt; default value</p>
  252. <code class="phpdocumentor-signature phpdocumentor-code ">
  253. <span class="phpdocumentor-signature__visibility">public</span>
  254. <span class="phpdocumentor-signature__type">array&lt;string|int, bool&gt;</span>
  255. <span class="phpdocumentor-signature__name">DEFAULT_MODULE_VALUES</span>
  256. = <span class="phpdocumentor-signature__default-value">[
  257. // light
  258. \chillerlan\QRCode\Data\QRMatrix::M_NULL =&gt; false,
  259. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT =&gt; false,
  260. \chillerlan\QRCode\Data\QRMatrix::M_DATA =&gt; false,
  261. \chillerlan\QRCode\Data\QRMatrix::M_FINDER =&gt; false,
  262. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR =&gt; false,
  263. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT =&gt; false,
  264. \chillerlan\QRCode\Data\QRMatrix::M_TIMING =&gt; false,
  265. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT =&gt; false,
  266. \chillerlan\QRCode\Data\QRMatrix::M_VERSION =&gt; false,
  267. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE =&gt; false,
  268. \chillerlan\QRCode\Data\QRMatrix::M_LOGO =&gt; false,
  269. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT =&gt; false,
  270. // dark
  271. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE =&gt; true,
  272. \chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK =&gt; true,
  273. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK =&gt; true,
  274. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK =&gt; true,
  275. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK =&gt; true,
  276. \chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK =&gt; true,
  277. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK =&gt; true,
  278. \chillerlan\QRCode\Data\QRMatrix::M_VERSION_DARK =&gt; true,
  279. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE_DARK =&gt; true,
  280. \chillerlan\QRCode\Data\QRMatrix::M_LOGO_DARK =&gt; true,
  281. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT =&gt; true,
  282. ]</span>
  283. </code>
  284. </article>
  285. <article class="phpdocumentor-element -constant -public ">
  286. <h4 class="phpdocumentor-element__name" id="constant_LAYERNAMES">
  287. LAYERNAMES
  288. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_LAYERNAMES" class="headerlink"><i class="fas fa-link"></i></a>
  289. </h4>
  290. <aside class="phpdocumentor-element-found-in">
  291. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
  292. :
  293. <span class="phpdocumentor-element-found-in__line">82</span>
  294. </aside>
  295. <p class="phpdocumentor-summary">Map of module type =&gt; readable name (for CSS etc.)</p>
  296. <code class="phpdocumentor-signature phpdocumentor-code ">
  297. <span class="phpdocumentor-signature__visibility">public</span>
  298. <span class="phpdocumentor-signature__type">array&lt;string|int, string&gt;</span>
  299. <span class="phpdocumentor-signature__name">LAYERNAMES</span>
  300. = <span class="phpdocumentor-signature__default-value">[
  301. // light
  302. \chillerlan\QRCode\Data\QRMatrix::M_NULL =&gt; &#039;null&#039;,
  303. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT =&gt; &#039;darkmodule-light&#039;,
  304. \chillerlan\QRCode\Data\QRMatrix::M_DATA =&gt; &#039;data&#039;,
  305. \chillerlan\QRCode\Data\QRMatrix::M_FINDER =&gt; &#039;finder&#039;,
  306. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR =&gt; &#039;separator&#039;,
  307. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT =&gt; &#039;alignment&#039;,
  308. \chillerlan\QRCode\Data\QRMatrix::M_TIMING =&gt; &#039;timing&#039;,
  309. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT =&gt; &#039;format&#039;,
  310. \chillerlan\QRCode\Data\QRMatrix::M_VERSION =&gt; &#039;version&#039;,
  311. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE =&gt; &#039;quietzone&#039;,
  312. \chillerlan\QRCode\Data\QRMatrix::M_LOGO =&gt; &#039;logo&#039;,
  313. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT =&gt; &#039;finder-dot-light&#039;,
  314. // dark
  315. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE =&gt; &#039;darkmodule&#039;,
  316. \chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK =&gt; &#039;data-dark&#039;,
  317. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK =&gt; &#039;finder-dark&#039;,
  318. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK =&gt; &#039;separator-dark&#039;,
  319. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK =&gt; &#039;alignment-dark&#039;,
  320. \chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK =&gt; &#039;timing-dark&#039;,
  321. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK =&gt; &#039;format-dark&#039;,
  322. \chillerlan\QRCode\Data\QRMatrix::M_VERSION_DARK =&gt; &#039;version-dark&#039;,
  323. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE_DARK =&gt; &#039;quietzone-dark&#039;,
  324. \chillerlan\QRCode\Data\QRMatrix::M_LOGO_DARK =&gt; &#039;logo-dark&#039;,
  325. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT =&gt; &#039;finder-dot&#039;,
  326. ]</span>
  327. </code>
  328. </article>
  329. <article class="phpdocumentor-element -constant -public ">
  330. <h4 class="phpdocumentor-element__name" id="constant_MIME_TYPE">
  331. MIME_TYPE
  332. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MIME_TYPE" class="headerlink"><i class="fas fa-link"></i></a>
  333. </h4>
  334. <aside class="phpdocumentor-element-found-in">
  335. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
  336. :
  337. <span class="phpdocumentor-element-found-in__line">116</span>
  338. </aside>
  339. <p class="phpdocumentor-summary">Note: do not call this constant from the interface, but rather from one of the child classes</p>
  340. <code class="phpdocumentor-signature phpdocumentor-code ">
  341. <span class="phpdocumentor-signature__visibility">public</span>
  342. <span class="phpdocumentor-signature__type">string</span>
  343. <span class="phpdocumentor-signature__name">MIME_TYPE</span>
  344. = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span>
  345. </code>
  346. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  347. Tags
  348. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MIME_TYPE#tags" class="headerlink"><i class="fas fa-link"></i></a>
  349. </h5>
  350. <dl class="phpdocumentor-tag-list">
  351. <dt class="phpdocumentor-tag-list__entry">
  352. <span class="phpdocumentor-tag__name">see</span>
  353. </dt>
  354. <dd class="phpdocumentor-tag-list__definition">
  355. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract::toBase64DataURI()">QROutputAbstract::toBase64DataURI()</abbr></a></span>
  356. </dd>
  357. </dl>
  358. </article>
  359. <article class="phpdocumentor-element -constant -public ">
  360. <h4 class="phpdocumentor-element__name" id="constant_MODES">
  361. MODES
  362. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES" class="headerlink"><i class="fas fa-link"></i></a>
  363. </h4>
  364. <aside class="phpdocumentor-element-found-in">
  365. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
  366. :
  367. <span class="phpdocumentor-element-found-in__line">26</span>
  368. </aside>
  369. <p class="phpdocumentor-summary">Map of built-in output class FQN</p>
  370. <code class="phpdocumentor-signature phpdocumentor-code ">
  371. <span class="phpdocumentor-signature__visibility">public</span>
  372. <span class="phpdocumentor-signature__type">array&lt;string|int, string&gt;</span>
  373. <span class="phpdocumentor-signature__name">MODES</span>
  374. = <span class="phpdocumentor-signature__default-value">[\chillerlan\QRCode\Output\QREps::class, \chillerlan\QRCode\Output\QRFpdf::class, \chillerlan\QRCode\Output\QRGdImageAVIF::class, \chillerlan\QRCode\Output\QRGdImageBMP::class, \chillerlan\QRCode\Output\QRGdImageGIF::class, \chillerlan\QRCode\Output\QRGdImageJPEG::class, \chillerlan\QRCode\Output\QRGdImagePNG::class, \chillerlan\QRCode\Output\QRGdImageWEBP::class, \chillerlan\QRCode\Output\QRImagick::class, \chillerlan\QRCode\Output\QRInterventionImage::class, \chillerlan\QRCode\Output\QRMarkupHTML::class, \chillerlan\QRCode\Output\QRMarkupSVG::class, \chillerlan\QRCode\Output\QRMarkupXML::class, \chillerlan\QRCode\Output\QRStringJSON::class, \chillerlan\QRCode\Output\QRStringText::class]</span>
  375. </code>
  376. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  377. Tags
  378. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES#tags" class="headerlink"><i class="fas fa-link"></i></a>
  379. </h5>
  380. <dl class="phpdocumentor-tag-list">
  381. <dt class="phpdocumentor-tag-list__entry">
  382. <span class="phpdocumentor-tag__name">see</span>
  383. </dt>
  384. <dd class="phpdocumentor-tag-list__definition">
  385. <span class="phpdocumentor-tag-link"><a href="https://github.com/chillerlan/php-qrcode/issues/223">https://github.com/chillerlan/php-qrcode/issues/223</a></span>
  386. </dd>
  387. </dl>
  388. </article>
  389. </section>
  390. <section class="phpdocumentor-methods">
  391. <h3 class="phpdocumentor-elements__header" id="methods">
  392. Methods
  393. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  394. </h3>
  395. <article
  396. class="phpdocumentor-element
  397. -method
  398. -public
  399. "
  400. >
  401. <h4 class="phpdocumentor-element__name" id="method_dump">
  402. dump()
  403. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  404. </h4>
  405. <aside class="phpdocumentor-element-found-in">
  406. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
  407. :
  408. <span class="phpdocumentor-element-found-in__line">132</span>
  409. </aside>
  410. <p class="phpdocumentor-summary">Generates the output, optionally dumps it to a file, and returns it</p>
  411. <code class="phpdocumentor-code phpdocumentor-signature ">
  412. <span class="phpdocumentor-signature__visibility">public</span>
  413. <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>
  414. <div class="phpdocumentor-label-line">
  415. </div>
  416. <section class="phpdocumentor-description"><p>please note that the value of QROptions::$cachefile is already evaluated at this point.
  417. if the output module is invoked manually, it has no effect at all.
  418. you need to supply the $file parameter here in that case (or handle the option value in your custom output module).</p>
  419. </section>
  420. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  421. <dl class="phpdocumentor-argument-list">
  422. <dt class="phpdocumentor-argument-list__entry">
  423. <span class="phpdocumentor-signature__argument__name">$file</span>
  424. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  425. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  426. <dd class="phpdocumentor-argument-list__definition">
  427. </dd>
  428. </dl>
  429. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  430. Tags
  431. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  432. </h5>
  433. <dl class="phpdocumentor-tag-list">
  434. <dt class="phpdocumentor-tag-list__entry">
  435. <span class="phpdocumentor-tag__name">see</span>
  436. </dt>
  437. <dd class="phpdocumentor-tag-list__definition">
  438. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCode.html#method_renderMatrix"><abbr title="\chillerlan\QRCode\QRCode::renderMatrix()">QRCode::renderMatrix()</abbr></a></span>
  439. </dd>
  440. </dl>
  441. </article>
  442. <article
  443. class="phpdocumentor-element
  444. -method
  445. -public
  446. -static "
  447. >
  448. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  449. moduleValueIsValid()
  450. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  451. </h4>
  452. <aside class="phpdocumentor-element-found-in">
  453. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
  454. :
  455. <span class="phpdocumentor-element-found-in__line">121</span>
  456. </aside>
  457. <p class="phpdocumentor-summary">Determines whether the given value is valid</p>
  458. <code class="phpdocumentor-code phpdocumentor-signature ">
  459. <span class="phpdocumentor-signature__visibility">public</span>
  460. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">moduleValueIsValid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  461. <div class="phpdocumentor-label-line">
  462. </div>
  463. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  464. <dl class="phpdocumentor-argument-list">
  465. <dt class="phpdocumentor-argument-list__entry">
  466. <span class="phpdocumentor-signature__argument__name">$value</span>
  467. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  468. </dt>
  469. <dd class="phpdocumentor-argument-list__definition">
  470. </dd>
  471. </dl>
  472. <section>
  473. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  474. <span class="phpdocumentor-signature__response_type">bool</span>
  475. </section>
  476. </article>
  477. </section>
  478. <div class="phpdocumentor-modal" id="source-view">
  479. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  480. <div class="phpdocumentor-modal-container">
  481. <div class="phpdocumentor-modal-content">
  482. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Output/QROutputInterface.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  483. </div>
  484. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  485. </div>
  486. </div>
  487. <script type="text/javascript">
  488. (function () {
  489. function loadExternalCodeSnippet(el, url, line) {
  490. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  491. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  492. const language = 'php';
  493. const code = document.createElement('code');
  494. code.className = 'language-' + language;
  495. pre.textContent = '';
  496. pre.setAttribute('data-line', line)
  497. code.textContent = 'Loading…';
  498. pre.appendChild(code);
  499. var xhr = new XMLHttpRequest();
  500. xhr.open('GET', src, true);
  501. xhr.onreadystatechange = function () {
  502. if (xhr.readyState !== 4) {
  503. return;
  504. }
  505. if (xhr.status < 400 && xhr.responseText) {
  506. code.textContent = xhr.responseText;
  507. Prism.highlightElement(code);
  508. return;
  509. }
  510. if (xhr.status === 404) {
  511. code.textContent = '✖ Error: File could not be found';
  512. return;
  513. }
  514. if (xhr.status >= 400) {
  515. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  516. return;
  517. }
  518. code.textContent = '✖ Error: An unknown error occurred';
  519. };
  520. xhr.send(null);
  521. });
  522. }
  523. const modalButtons = document.querySelectorAll("[data-modal]");
  524. const openedAsLocalFile = window.location.protocol === 'file:';
  525. if (modalButtons.length > 0 && openedAsLocalFile) {
  526. console.warn(
  527. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  528. 'browsers block XHR requests when a page is opened this way'
  529. );
  530. }
  531. modalButtons.forEach(function (trigger) {
  532. if (openedAsLocalFile) {
  533. trigger.setAttribute("hidden", "hidden");
  534. }
  535. trigger.addEventListener("click", function (event) {
  536. event.preventDefault();
  537. const modal = document.getElementById(trigger.dataset.modal);
  538. if (!modal) {
  539. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  540. return;
  541. }
  542. modal.classList.add("phpdocumentor-modal__open");
  543. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  544. const exits = modal.querySelectorAll("[data-exit-button]");
  545. exits.forEach(function (exit) {
  546. exit.addEventListener("click", function (event) {
  547. event.preventDefault();
  548. modal.classList.remove("phpdocumentor-modal__open");
  549. });
  550. });
  551. });
  552. });
  553. })();
  554. </script>
  555. </article>
  556. </section>
  557. <section class="phpdocumentor-on-this-page__sidebar">
  558. <section class="phpdocumentor-on-this-page__content">
  559. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  560. <ul class="phpdocumentor-list -clean">
  561. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  562. <li>
  563. <ul class="phpdocumentor-list -clean">
  564. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc-constants">Constants</a></li>
  565. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc-methods">Methods</a></li>
  566. </ul>
  567. </li>
  568. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  569. <li>
  570. <ul class="phpdocumentor-list -clean">
  571. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump">dump()</a></li>
  572. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  573. </ul>
  574. </li>
  575. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  576. <li>
  577. <ul class="phpdocumentor-list -clean">
  578. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_DEFAULT_MODULE_VALUES">DEFAULT_MODULE_VALUES</a></li>
  579. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_LAYERNAMES">LAYERNAMES</a></li>
  580. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MIME_TYPE">MIME_TYPE</a></li>
  581. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES">MODES</a></li>
  582. </ul>
  583. </li>
  584. </ul>
  585. </section>
  586. </section>
  587. </div>
  588. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  589. <section class="phpdocumentor-search-results__dialog">
  590. <header class="phpdocumentor-search-results__header">
  591. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  592. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  593. </header>
  594. <section class="phpdocumentor-search-results__body">
  595. <ul class="phpdocumentor-search-results__entries"></ul>
  596. </section>
  597. </section>
  598. </section>
  599. </div>
  600. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  601. </main>
  602. <script>
  603. cssVars({});
  604. </script>
  605. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  606. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  607. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  608. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  609. </body>
  610. </html>