chillerlan-QRCode-Output-QROutputInterface.html 54 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141
  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. </ul>
  59. </nav>
  60. </header>
  61. <main class="phpdocumentor">
  62. <div class="phpdocumentor-section">
  63. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  64. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  65. Menu
  66. </label>
  67. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  68. <section class="phpdocumentor-sidebar__category">
  69. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  70. <h4 class="phpdocumentor-sidebar__root-namespace">
  71. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  72. </h4>
  73. <ul class="phpdocumentor-list">
  74. <li>
  75. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  76. </li>
  77. <li>
  78. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  79. </li>
  80. </ul>
  81. </section>
  82. <section class="phpdocumentor-sidebar__category">
  83. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  84. <h4 class="phpdocumentor-sidebar__root-namespace">
  85. <a href="packages/Application.html" class="">Application</a>
  86. </h4>
  87. </section>
  88. <section class="phpdocumentor-sidebar__category">
  89. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  92. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  93. </section>
  94. <section class="phpdocumentor-sidebar__category">
  95. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  96. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  97. </section>
  98. </aside>
  99. <div class="phpdocumentor-column -nine phpdocumentor-content">
  100. <section>
  101. <ul class="phpdocumentor-breadcrumbs">
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  103. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  104. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  105. </ul>
  106. <article class="phpdocumentor-element -interface">
  107. <h2 class="phpdocumentor-content__title">
  108. QROutputInterface
  109. <div class="phpdocumentor-element__package">
  110. in
  111. <ul class="phpdocumentor-breadcrumbs">
  112. <li><a href="packages/Application.html">Application</a></li>
  113. </ul>
  114. </div>
  115. </h2>
  116. <aside class="phpdocumentor-element-found-in">
  117. <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>
  118. :
  119. <span class="phpdocumentor-element-found-in__line">18</span>
  120. </aside>
  121. <p class="phpdocumentor-summary">Converts the data matrix into readable output</p>
  122. <h3 id="toc">
  123. Table of Contents
  124. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  125. </h3>
  126. <h4 id="toc-constants">
  127. Constants
  128. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
  129. </h4>
  130. <dl class="phpdocumentor-table-of-contents">
  131. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  132. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_CUSTOM">CUSTOM</a>
  133. <span>
  134. &nbsp;= &#039;custom&#039; </span>
  135. </dt>
  136. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  137. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_DEFAULT_MODULE_VALUES">DEFAULT_MODULE_VALUES</a>
  138. <span>
  139. &nbsp;= [
  140. // light
  141. \chillerlan\QRCode\Data\QRMatrix::M_NULL =&gt; false,
  142. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT =&gt; false,
  143. \chillerlan\QRCode\Data\QRMatrix::M_DATA =&gt; false,
  144. \chillerlan\QRCode\Data\QRMatrix::M_FINDER =&gt; false,
  145. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR =&gt; false,
  146. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT =&gt; false,
  147. \chillerlan\QRCode\Data\QRMatrix::M_TIMING =&gt; false,
  148. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT =&gt; false,
  149. \chillerlan\QRCode\Data\QRMatrix::M_VERSION =&gt; false,
  150. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE =&gt; false,
  151. \chillerlan\QRCode\Data\QRMatrix::M_LOGO =&gt; false,
  152. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT =&gt; false,
  153. \chillerlan\QRCode\Data\QRMatrix::M_TEST =&gt; false,
  154. // dark
  155. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE =&gt; true,
  156. \chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK =&gt; true,
  157. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK =&gt; true,
  158. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK =&gt; true,
  159. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK =&gt; true,
  160. \chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK =&gt; true,
  161. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK =&gt; true,
  162. \chillerlan\QRCode\Data\QRMatrix::M_VERSION_DARK =&gt; true,
  163. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE_DARK =&gt; true,
  164. \chillerlan\QRCode\Data\QRMatrix::M_LOGO_DARK =&gt; true,
  165. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT =&gt; true,
  166. \chillerlan\QRCode\Data\QRMatrix::M_TEST_DARK =&gt; true,
  167. ] </span>
  168. </dt>
  169. <dd>Map of module type =&gt; default value</dd>
  170. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  171. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_EPS">EPS</a>
  172. <span>
  173. &nbsp;= &#039;eps&#039; </span>
  174. </dt>
  175. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  176. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_FPDF">FPDF</a>
  177. <span>
  178. &nbsp;= &#039;fpdf&#039; </span>
  179. </dt>
  180. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  181. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_BMP">GDIMAGE_BMP</a>
  182. <span>
  183. &nbsp;= &#039;bmp&#039; </span>
  184. </dt>
  185. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  186. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_GIF">GDIMAGE_GIF</a>
  187. <span>
  188. &nbsp;= &#039;gif&#039; </span>
  189. </dt>
  190. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  191. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_JPG">GDIMAGE_JPG</a>
  192. <span>
  193. &nbsp;= &#039;jpg&#039; </span>
  194. </dt>
  195. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  196. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_PNG">GDIMAGE_PNG</a>
  197. <span>
  198. &nbsp;= &#039;png&#039; </span>
  199. </dt>
  200. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  201. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_WEBP">GDIMAGE_WEBP</a>
  202. <span>
  203. &nbsp;= &#039;webp&#039; </span>
  204. </dt>
  205. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  206. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_IMAGICK">IMAGICK</a>
  207. <span>
  208. &nbsp;= &#039;imagick&#039; </span>
  209. </dt>
  210. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  211. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_LAYERNAMES">LAYERNAMES</a>
  212. <span>
  213. &nbsp;= [
  214. // light
  215. \chillerlan\QRCode\Data\QRMatrix::M_NULL =&gt; &#039;null&#039;,
  216. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT =&gt; &#039;darkmodule-light&#039;,
  217. \chillerlan\QRCode\Data\QRMatrix::M_DATA =&gt; &#039;data&#039;,
  218. \chillerlan\QRCode\Data\QRMatrix::M_FINDER =&gt; &#039;finder&#039;,
  219. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR =&gt; &#039;separator&#039;,
  220. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT =&gt; &#039;alignment&#039;,
  221. \chillerlan\QRCode\Data\QRMatrix::M_TIMING =&gt; &#039;timing&#039;,
  222. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT =&gt; &#039;format&#039;,
  223. \chillerlan\QRCode\Data\QRMatrix::M_VERSION =&gt; &#039;version&#039;,
  224. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE =&gt; &#039;quietzone&#039;,
  225. \chillerlan\QRCode\Data\QRMatrix::M_LOGO =&gt; &#039;logo&#039;,
  226. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT =&gt; &#039;finder-dot-light&#039;,
  227. \chillerlan\QRCode\Data\QRMatrix::M_TEST =&gt; &#039;test&#039;,
  228. // dark
  229. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE =&gt; &#039;darkmodule&#039;,
  230. \chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK =&gt; &#039;data-dark&#039;,
  231. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK =&gt; &#039;finder-dark&#039;,
  232. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK =&gt; &#039;separator-dark&#039;,
  233. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK =&gt; &#039;alignment-dark&#039;,
  234. \chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK =&gt; &#039;timing-dark&#039;,
  235. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK =&gt; &#039;format-dark&#039;,
  236. \chillerlan\QRCode\Data\QRMatrix::M_VERSION_DARK =&gt; &#039;version-dark&#039;,
  237. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE_DARK =&gt; &#039;quietzone-dark&#039;,
  238. \chillerlan\QRCode\Data\QRMatrix::M_LOGO_DARK =&gt; &#039;logo-dark&#039;,
  239. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT =&gt; &#039;finder-dot&#039;,
  240. \chillerlan\QRCode\Data\QRMatrix::M_TEST_DARK =&gt; &#039;test-dark&#039;,
  241. ] </span>
  242. </dt>
  243. <dd>Map of module type =&gt; readable name (for CSS etc.)</dd>
  244. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  245. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MARKUP_HTML">MARKUP_HTML</a>
  246. <span>
  247. &nbsp;= &#039;html&#039; </span>
  248. </dt>
  249. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  250. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MARKUP_SVG">MARKUP_SVG</a>
  251. <span>
  252. &nbsp;= &#039;svg&#039; </span>
  253. </dt>
  254. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  255. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES">MODES</a>
  256. <span>
  257. &nbsp;= [self::MARKUP_SVG =&gt; \chillerlan\QRCode\Output\QRMarkupSVG::class, self::MARKUP_HTML =&gt; \chillerlan\QRCode\Output\QRMarkupHTML::class, self::GDIMAGE_BMP =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_GIF =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_JPG =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_PNG =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_WEBP =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::STRING_JSON =&gt; \chillerlan\QRCode\Output\QRString::class, self::STRING_TEXT =&gt; \chillerlan\QRCode\Output\QRString::class, self::IMAGICK =&gt; \chillerlan\QRCode\Output\QRImagick::class, self::FPDF =&gt; \chillerlan\QRCode\Output\QRFpdf::class, self::EPS =&gt; \chillerlan\QRCode\Output\QREps::class] </span>
  258. </dt>
  259. <dd>Map of built-in output modes =&gt; class FQN</dd>
  260. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  261. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_STRING_JSON">STRING_JSON</a>
  262. <span>
  263. &nbsp;= &#039;json&#039; </span>
  264. </dt>
  265. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  266. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_STRING_TEXT">STRING_TEXT</a>
  267. <span>
  268. &nbsp;= &#039;text&#039; </span>
  269. </dt>
  270. </dl>
  271. <h4 id="toc-methods">
  272. Methods
  273. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  274. </h4>
  275. <dl class="phpdocumentor-table-of-contents">
  276. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  277. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump">dump()</a>
  278. <span>
  279. &nbsp;: mixed </span>
  280. </dt>
  281. <dd>Generates the output, optionally dumps it to a file, and returns it</dd>
  282. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  283. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  284. <span>
  285. &nbsp;: bool </span>
  286. </dt>
  287. <dd>Determines whether the given value is valid</dd>
  288. </dl>
  289. <section class="phpdocumentor-constants">
  290. <h3 class="phpdocumentor-elements__header" id="constants">
  291. Constants
  292. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  293. </h3>
  294. <article class="phpdocumentor-element -constant -public ">
  295. <h4 class="phpdocumentor-element__name" id="constant_CUSTOM">
  296. CUSTOM
  297. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_CUSTOM" class="headerlink"><i class="fas fa-link"></i></a>
  298. </h4>
  299. <aside class="phpdocumentor-element-found-in">
  300. <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>
  301. :
  302. <span class="phpdocumentor-element-found-in__line">45</span>
  303. </aside>
  304. <code class="phpdocumentor-signature phpdocumentor-code ">
  305. <span class="phpdocumentor-signature__visibility">public</span>
  306. <span class="phpdocumentor-signature__type">string</span>
  307. <span class="phpdocumentor-signature__name">CUSTOM</span>
  308. = <span class="phpdocumentor-signature__default-value">&#039;custom&#039;</span>
  309. </code>
  310. </article>
  311. <article class="phpdocumentor-element -constant -public ">
  312. <h4 class="phpdocumentor-element__name" id="constant_DEFAULT_MODULE_VALUES">
  313. DEFAULT_MODULE_VALUES
  314. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_DEFAULT_MODULE_VALUES" class="headerlink"><i class="fas fa-link"></i></a>
  315. </h4>
  316. <aside class="phpdocumentor-element-found-in">
  317. <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>
  318. :
  319. <span class="phpdocumentor-element-found-in__line">72</span>
  320. </aside>
  321. <p class="phpdocumentor-summary">Map of module type =&gt; default value</p>
  322. <code class="phpdocumentor-signature phpdocumentor-code ">
  323. <span class="phpdocumentor-signature__visibility">public</span>
  324. <span class="phpdocumentor-signature__type">array&lt;string|int, bool&gt;</span>
  325. <span class="phpdocumentor-signature__name">DEFAULT_MODULE_VALUES</span>
  326. = <span class="phpdocumentor-signature__default-value">[
  327. // light
  328. \chillerlan\QRCode\Data\QRMatrix::M_NULL =&gt; false,
  329. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT =&gt; false,
  330. \chillerlan\QRCode\Data\QRMatrix::M_DATA =&gt; false,
  331. \chillerlan\QRCode\Data\QRMatrix::M_FINDER =&gt; false,
  332. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR =&gt; false,
  333. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT =&gt; false,
  334. \chillerlan\QRCode\Data\QRMatrix::M_TIMING =&gt; false,
  335. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT =&gt; false,
  336. \chillerlan\QRCode\Data\QRMatrix::M_VERSION =&gt; false,
  337. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE =&gt; false,
  338. \chillerlan\QRCode\Data\QRMatrix::M_LOGO =&gt; false,
  339. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT =&gt; false,
  340. \chillerlan\QRCode\Data\QRMatrix::M_TEST =&gt; false,
  341. // dark
  342. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE =&gt; true,
  343. \chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK =&gt; true,
  344. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK =&gt; true,
  345. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK =&gt; true,
  346. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK =&gt; true,
  347. \chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK =&gt; true,
  348. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK =&gt; true,
  349. \chillerlan\QRCode\Data\QRMatrix::M_VERSION_DARK =&gt; true,
  350. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE_DARK =&gt; true,
  351. \chillerlan\QRCode\Data\QRMatrix::M_LOGO_DARK =&gt; true,
  352. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT =&gt; true,
  353. \chillerlan\QRCode\Data\QRMatrix::M_TEST_DARK =&gt; true,
  354. ]</span>
  355. </code>
  356. </article>
  357. <article class="phpdocumentor-element -constant -public ">
  358. <h4 class="phpdocumentor-element__name" id="constant_EPS">
  359. EPS
  360. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_EPS" class="headerlink"><i class="fas fa-link"></i></a>
  361. </h4>
  362. <aside class="phpdocumentor-element-found-in">
  363. <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>
  364. :
  365. <span class="phpdocumentor-element-found-in__line">43</span>
  366. </aside>
  367. <code class="phpdocumentor-signature phpdocumentor-code ">
  368. <span class="phpdocumentor-signature__visibility">public</span>
  369. <span class="phpdocumentor-signature__type">string</span>
  370. <span class="phpdocumentor-signature__name">EPS</span>
  371. = <span class="phpdocumentor-signature__default-value">&#039;eps&#039;</span>
  372. </code>
  373. </article>
  374. <article class="phpdocumentor-element -constant -public ">
  375. <h4 class="phpdocumentor-element__name" id="constant_FPDF">
  376. FPDF
  377. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_FPDF" class="headerlink"><i class="fas fa-link"></i></a>
  378. </h4>
  379. <aside class="phpdocumentor-element-found-in">
  380. <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>
  381. :
  382. <span class="phpdocumentor-element-found-in__line">41</span>
  383. </aside>
  384. <code class="phpdocumentor-signature phpdocumentor-code ">
  385. <span class="phpdocumentor-signature__visibility">public</span>
  386. <span class="phpdocumentor-signature__type">string</span>
  387. <span class="phpdocumentor-signature__name">FPDF</span>
  388. = <span class="phpdocumentor-signature__default-value">&#039;fpdf&#039;</span>
  389. </code>
  390. </article>
  391. <article class="phpdocumentor-element -constant -public ">
  392. <h4 class="phpdocumentor-element__name" id="constant_GDIMAGE_BMP">
  393. GDIMAGE_BMP
  394. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_BMP" class="headerlink"><i class="fas fa-link"></i></a>
  395. </h4>
  396. <aside class="phpdocumentor-element-found-in">
  397. <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>
  398. :
  399. <span class="phpdocumentor-element-found-in__line">25</span>
  400. </aside>
  401. <code class="phpdocumentor-signature phpdocumentor-code ">
  402. <span class="phpdocumentor-signature__visibility">public</span>
  403. <span class="phpdocumentor-signature__type">string</span>
  404. <span class="phpdocumentor-signature__name">GDIMAGE_BMP</span>
  405. = <span class="phpdocumentor-signature__default-value">&#039;bmp&#039;</span>
  406. </code>
  407. </article>
  408. <article class="phpdocumentor-element -constant -public ">
  409. <h4 class="phpdocumentor-element__name" id="constant_GDIMAGE_GIF">
  410. GDIMAGE_GIF
  411. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_GIF" class="headerlink"><i class="fas fa-link"></i></a>
  412. </h4>
  413. <aside class="phpdocumentor-element-found-in">
  414. <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>
  415. :
  416. <span class="phpdocumentor-element-found-in__line">27</span>
  417. </aside>
  418. <code class="phpdocumentor-signature phpdocumentor-code ">
  419. <span class="phpdocumentor-signature__visibility">public</span>
  420. <span class="phpdocumentor-signature__type">string</span>
  421. <span class="phpdocumentor-signature__name">GDIMAGE_GIF</span>
  422. = <span class="phpdocumentor-signature__default-value">&#039;gif&#039;</span>
  423. </code>
  424. </article>
  425. <article class="phpdocumentor-element -constant -public ">
  426. <h4 class="phpdocumentor-element__name" id="constant_GDIMAGE_JPG">
  427. GDIMAGE_JPG
  428. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_JPG" class="headerlink"><i class="fas fa-link"></i></a>
  429. </h4>
  430. <aside class="phpdocumentor-element-found-in">
  431. <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>
  432. :
  433. <span class="phpdocumentor-element-found-in__line">29</span>
  434. </aside>
  435. <code class="phpdocumentor-signature phpdocumentor-code ">
  436. <span class="phpdocumentor-signature__visibility">public</span>
  437. <span class="phpdocumentor-signature__type">string</span>
  438. <span class="phpdocumentor-signature__name">GDIMAGE_JPG</span>
  439. = <span class="phpdocumentor-signature__default-value">&#039;jpg&#039;</span>
  440. </code>
  441. </article>
  442. <article class="phpdocumentor-element -constant -public ">
  443. <h4 class="phpdocumentor-element__name" id="constant_GDIMAGE_PNG">
  444. GDIMAGE_PNG
  445. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_PNG" class="headerlink"><i class="fas fa-link"></i></a>
  446. </h4>
  447. <aside class="phpdocumentor-element-found-in">
  448. <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>
  449. :
  450. <span class="phpdocumentor-element-found-in__line">31</span>
  451. </aside>
  452. <code class="phpdocumentor-signature phpdocumentor-code ">
  453. <span class="phpdocumentor-signature__visibility">public</span>
  454. <span class="phpdocumentor-signature__type">string</span>
  455. <span class="phpdocumentor-signature__name">GDIMAGE_PNG</span>
  456. = <span class="phpdocumentor-signature__default-value">&#039;png&#039;</span>
  457. </code>
  458. </article>
  459. <article class="phpdocumentor-element -constant -public ">
  460. <h4 class="phpdocumentor-element__name" id="constant_GDIMAGE_WEBP">
  461. GDIMAGE_WEBP
  462. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_WEBP" class="headerlink"><i class="fas fa-link"></i></a>
  463. </h4>
  464. <aside class="phpdocumentor-element-found-in">
  465. <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>
  466. :
  467. <span class="phpdocumentor-element-found-in__line">33</span>
  468. </aside>
  469. <code class="phpdocumentor-signature phpdocumentor-code ">
  470. <span class="phpdocumentor-signature__visibility">public</span>
  471. <span class="phpdocumentor-signature__type">string</span>
  472. <span class="phpdocumentor-signature__name">GDIMAGE_WEBP</span>
  473. = <span class="phpdocumentor-signature__default-value">&#039;webp&#039;</span>
  474. </code>
  475. </article>
  476. <article class="phpdocumentor-element -constant -public ">
  477. <h4 class="phpdocumentor-element__name" id="constant_IMAGICK">
  478. IMAGICK
  479. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_IMAGICK" class="headerlink"><i class="fas fa-link"></i></a>
  480. </h4>
  481. <aside class="phpdocumentor-element-found-in">
  482. <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>
  483. :
  484. <span class="phpdocumentor-element-found-in__line">39</span>
  485. </aside>
  486. <code class="phpdocumentor-signature phpdocumentor-code ">
  487. <span class="phpdocumentor-signature__visibility">public</span>
  488. <span class="phpdocumentor-signature__type">string</span>
  489. <span class="phpdocumentor-signature__name">IMAGICK</span>
  490. = <span class="phpdocumentor-signature__default-value">&#039;imagick&#039;</span>
  491. </code>
  492. </article>
  493. <article class="phpdocumentor-element -constant -public ">
  494. <h4 class="phpdocumentor-element__name" id="constant_LAYERNAMES">
  495. LAYERNAMES
  496. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_LAYERNAMES" class="headerlink"><i class="fas fa-link"></i></a>
  497. </h4>
  498. <aside class="phpdocumentor-element-found-in">
  499. <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>
  500. :
  501. <span class="phpdocumentor-element-found-in__line">107</span>
  502. </aside>
  503. <p class="phpdocumentor-summary">Map of module type =&gt; readable name (for CSS etc.)</p>
  504. <code class="phpdocumentor-signature phpdocumentor-code ">
  505. <span class="phpdocumentor-signature__visibility">public</span>
  506. <span class="phpdocumentor-signature__type">array&lt;string|int, string&gt;</span>
  507. <span class="phpdocumentor-signature__name">LAYERNAMES</span>
  508. = <span class="phpdocumentor-signature__default-value">[
  509. // light
  510. \chillerlan\QRCode\Data\QRMatrix::M_NULL =&gt; &#039;null&#039;,
  511. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE_LIGHT =&gt; &#039;darkmodule-light&#039;,
  512. \chillerlan\QRCode\Data\QRMatrix::M_DATA =&gt; &#039;data&#039;,
  513. \chillerlan\QRCode\Data\QRMatrix::M_FINDER =&gt; &#039;finder&#039;,
  514. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR =&gt; &#039;separator&#039;,
  515. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT =&gt; &#039;alignment&#039;,
  516. \chillerlan\QRCode\Data\QRMatrix::M_TIMING =&gt; &#039;timing&#039;,
  517. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT =&gt; &#039;format&#039;,
  518. \chillerlan\QRCode\Data\QRMatrix::M_VERSION =&gt; &#039;version&#039;,
  519. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE =&gt; &#039;quietzone&#039;,
  520. \chillerlan\QRCode\Data\QRMatrix::M_LOGO =&gt; &#039;logo&#039;,
  521. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT_LIGHT =&gt; &#039;finder-dot-light&#039;,
  522. \chillerlan\QRCode\Data\QRMatrix::M_TEST =&gt; &#039;test&#039;,
  523. // dark
  524. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE =&gt; &#039;darkmodule&#039;,
  525. \chillerlan\QRCode\Data\QRMatrix::M_DATA_DARK =&gt; &#039;data-dark&#039;,
  526. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DARK =&gt; &#039;finder-dark&#039;,
  527. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR_DARK =&gt; &#039;separator-dark&#039;,
  528. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT_DARK =&gt; &#039;alignment-dark&#039;,
  529. \chillerlan\QRCode\Data\QRMatrix::M_TIMING_DARK =&gt; &#039;timing-dark&#039;,
  530. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT_DARK =&gt; &#039;format-dark&#039;,
  531. \chillerlan\QRCode\Data\QRMatrix::M_VERSION_DARK =&gt; &#039;version-dark&#039;,
  532. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE_DARK =&gt; &#039;quietzone-dark&#039;,
  533. \chillerlan\QRCode\Data\QRMatrix::M_LOGO_DARK =&gt; &#039;logo-dark&#039;,
  534. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT =&gt; &#039;finder-dot&#039;,
  535. \chillerlan\QRCode\Data\QRMatrix::M_TEST_DARK =&gt; &#039;test-dark&#039;,
  536. ]</span>
  537. </code>
  538. </article>
  539. <article class="phpdocumentor-element -constant -public ">
  540. <h4 class="phpdocumentor-element__name" id="constant_MARKUP_HTML">
  541. MARKUP_HTML
  542. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MARKUP_HTML" class="headerlink"><i class="fas fa-link"></i></a>
  543. </h4>
  544. <aside class="phpdocumentor-element-found-in">
  545. <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>
  546. :
  547. <span class="phpdocumentor-element-found-in__line">21</span>
  548. </aside>
  549. <code class="phpdocumentor-signature phpdocumentor-code ">
  550. <span class="phpdocumentor-signature__visibility">public</span>
  551. <span class="phpdocumentor-signature__type">string</span>
  552. <span class="phpdocumentor-signature__name">MARKUP_HTML</span>
  553. = <span class="phpdocumentor-signature__default-value">&#039;html&#039;</span>
  554. </code>
  555. </article>
  556. <article class="phpdocumentor-element -constant -public ">
  557. <h4 class="phpdocumentor-element__name" id="constant_MARKUP_SVG">
  558. MARKUP_SVG
  559. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MARKUP_SVG" class="headerlink"><i class="fas fa-link"></i></a>
  560. </h4>
  561. <aside class="phpdocumentor-element-found-in">
  562. <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>
  563. :
  564. <span class="phpdocumentor-element-found-in__line">23</span>
  565. </aside>
  566. <code class="phpdocumentor-signature phpdocumentor-code ">
  567. <span class="phpdocumentor-signature__visibility">public</span>
  568. <span class="phpdocumentor-signature__type">string</span>
  569. <span class="phpdocumentor-signature__name">MARKUP_SVG</span>
  570. = <span class="phpdocumentor-signature__default-value">&#039;svg&#039;</span>
  571. </code>
  572. </article>
  573. <article class="phpdocumentor-element -constant -public ">
  574. <h4 class="phpdocumentor-element__name" id="constant_MODES">
  575. MODES
  576. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES" class="headerlink"><i class="fas fa-link"></i></a>
  577. </h4>
  578. <aside class="phpdocumentor-element-found-in">
  579. <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>
  580. :
  581. <span class="phpdocumentor-element-found-in__line">52</span>
  582. </aside>
  583. <p class="phpdocumentor-summary">Map of built-in output modes =&gt; class FQN</p>
  584. <code class="phpdocumentor-signature phpdocumentor-code ">
  585. <span class="phpdocumentor-signature__visibility">public</span>
  586. <span class="phpdocumentor-signature__type">array&lt;string|int, string&gt;</span>
  587. <span class="phpdocumentor-signature__name">MODES</span>
  588. = <span class="phpdocumentor-signature__default-value">[self::MARKUP_SVG =&gt; \chillerlan\QRCode\Output\QRMarkupSVG::class, self::MARKUP_HTML =&gt; \chillerlan\QRCode\Output\QRMarkupHTML::class, self::GDIMAGE_BMP =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_GIF =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_JPG =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_PNG =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::GDIMAGE_WEBP =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::STRING_JSON =&gt; \chillerlan\QRCode\Output\QRString::class, self::STRING_TEXT =&gt; \chillerlan\QRCode\Output\QRString::class, self::IMAGICK =&gt; \chillerlan\QRCode\Output\QRImagick::class, self::FPDF =&gt; \chillerlan\QRCode\Output\QRFpdf::class, self::EPS =&gt; \chillerlan\QRCode\Output\QREps::class]</span>
  589. </code>
  590. </article>
  591. <article class="phpdocumentor-element -constant -public ">
  592. <h4 class="phpdocumentor-element__name" id="constant_STRING_JSON">
  593. STRING_JSON
  594. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_STRING_JSON" class="headerlink"><i class="fas fa-link"></i></a>
  595. </h4>
  596. <aside class="phpdocumentor-element-found-in">
  597. <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>
  598. :
  599. <span class="phpdocumentor-element-found-in__line">35</span>
  600. </aside>
  601. <code class="phpdocumentor-signature phpdocumentor-code ">
  602. <span class="phpdocumentor-signature__visibility">public</span>
  603. <span class="phpdocumentor-signature__type">string</span>
  604. <span class="phpdocumentor-signature__name">STRING_JSON</span>
  605. = <span class="phpdocumentor-signature__default-value">&#039;json&#039;</span>
  606. </code>
  607. </article>
  608. <article class="phpdocumentor-element -constant -public ">
  609. <h4 class="phpdocumentor-element__name" id="constant_STRING_TEXT">
  610. STRING_TEXT
  611. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_STRING_TEXT" class="headerlink"><i class="fas fa-link"></i></a>
  612. </h4>
  613. <aside class="phpdocumentor-element-found-in">
  614. <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>
  615. :
  616. <span class="phpdocumentor-element-found-in__line">37</span>
  617. </aside>
  618. <code class="phpdocumentor-signature phpdocumentor-code ">
  619. <span class="phpdocumentor-signature__visibility">public</span>
  620. <span class="phpdocumentor-signature__type">string</span>
  621. <span class="phpdocumentor-signature__name">STRING_TEXT</span>
  622. = <span class="phpdocumentor-signature__default-value">&#039;text&#039;</span>
  623. </code>
  624. </article>
  625. </section>
  626. <section class="phpdocumentor-methods">
  627. <h3 class="phpdocumentor-elements__header" id="methods">
  628. Methods
  629. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  630. </h3>
  631. <article
  632. class="phpdocumentor-element
  633. -method
  634. -public
  635. "
  636. >
  637. <h4 class="phpdocumentor-element__name" id="method_dump">
  638. dump()
  639. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  640. </h4>
  641. <aside class="phpdocumentor-element-found-in">
  642. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputInterface.php"><a href="files/src-output-qroutputinterface.html"><abbr title="src/Output/QROutputInterface.php">QROutputInterface.php</abbr></a></abbr>
  643. :
  644. <span class="phpdocumentor-element-found-in__line">155</span>
  645. </aside>
  646. <p class="phpdocumentor-summary">Generates the output, optionally dumps it to a file, and returns it</p>
  647. <code class="phpdocumentor-code phpdocumentor-signature ">
  648. <span class="phpdocumentor-signature__visibility">public</span>
  649. <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>
  650. <div class="phpdocumentor-label-line">
  651. </div>
  652. <section class="phpdocumentor-description"><p>please note that the value of QROptions::$cachefile is already evaluated at this point.
  653. if the output module is invoked manually, it has no effect at all.
  654. you need to supply the $file parameter here in that case (or handle the option value in your custom output module).</p>
  655. </section>
  656. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  657. <dl class="phpdocumentor-argument-list">
  658. <dt class="phpdocumentor-argument-list__entry">
  659. <span class="phpdocumentor-signature__argument__name">$file</span>
  660. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  661. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  662. <dd class="phpdocumentor-argument-list__definition">
  663. </dd>
  664. </dl>
  665. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  666. Tags
  667. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  668. </h5>
  669. <dl class="phpdocumentor-tag-list">
  670. <dt class="phpdocumentor-tag-list__entry">
  671. <span class="phpdocumentor-tag__name">see</span>
  672. </dt>
  673. <dd class="phpdocumentor-tag-list__definition">
  674. <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>
  675. </dd>
  676. </dl>
  677. </article>
  678. <article
  679. class="phpdocumentor-element
  680. -method
  681. -public
  682. -static "
  683. >
  684. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  685. moduleValueIsValid()
  686. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  687. </h4>
  688. <aside class="phpdocumentor-element-found-in">
  689. <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>
  690. :
  691. <span class="phpdocumentor-element-found-in__line">142</span>
  692. </aside>
  693. <p class="phpdocumentor-summary">Determines whether the given value is valid</p>
  694. <code class="phpdocumentor-code phpdocumentor-signature ">
  695. <span class="phpdocumentor-signature__visibility">public</span>
  696. <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>
  697. <div class="phpdocumentor-label-line">
  698. </div>
  699. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  700. <dl class="phpdocumentor-argument-list">
  701. <dt class="phpdocumentor-argument-list__entry">
  702. <span class="phpdocumentor-signature__argument__name">$value</span>
  703. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  704. </dt>
  705. <dd class="phpdocumentor-argument-list__definition">
  706. </dd>
  707. </dl>
  708. <section>
  709. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  710. <span class="phpdocumentor-signature__response_type">bool</span>
  711. </section>
  712. </article>
  713. </section>
  714. <div class="phpdocumentor-modal" id="source-view">
  715. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  716. <div class="phpdocumentor-modal-container">
  717. <div class="phpdocumentor-modal-content">
  718. <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>
  719. </div>
  720. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  721. </div>
  722. </div>
  723. <script type="text/javascript">
  724. (function () {
  725. function loadExternalCodeSnippet(el, url, line) {
  726. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  727. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  728. const language = 'php';
  729. const code = document.createElement('code');
  730. code.className = 'language-' + language;
  731. pre.textContent = '';
  732. pre.setAttribute('data-line', line)
  733. code.textContent = 'Loading…';
  734. pre.appendChild(code);
  735. var xhr = new XMLHttpRequest();
  736. xhr.open('GET', src, true);
  737. xhr.onreadystatechange = function () {
  738. if (xhr.readyState !== 4) {
  739. return;
  740. }
  741. if (xhr.status < 400 && xhr.responseText) {
  742. code.textContent = xhr.responseText;
  743. Prism.highlightElement(code);
  744. return;
  745. }
  746. if (xhr.status === 404) {
  747. code.textContent = '✖ Error: File could not be found';
  748. return;
  749. }
  750. if (xhr.status >= 400) {
  751. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  752. return;
  753. }
  754. code.textContent = '✖ Error: An unknown error occurred';
  755. };
  756. xhr.send(null);
  757. });
  758. }
  759. const modalButtons = document.querySelectorAll("[data-modal]");
  760. const openedAsLocalFile = window.location.protocol === 'file:';
  761. if (modalButtons.length > 0 && openedAsLocalFile) {
  762. console.warn(
  763. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  764. 'browsers block XHR requests when a page is opened this way'
  765. );
  766. }
  767. modalButtons.forEach(function (trigger) {
  768. if (openedAsLocalFile) {
  769. trigger.setAttribute("hidden", "hidden");
  770. }
  771. trigger.addEventListener("click", function (event) {
  772. event.preventDefault();
  773. const modal = document.getElementById(trigger.dataset.modal);
  774. if (!modal) {
  775. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  776. return;
  777. }
  778. modal.classList.add("phpdocumentor-modal__open");
  779. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  780. const exits = modal.querySelectorAll("[data-exit-button]");
  781. exits.forEach(function (exit) {
  782. exit.addEventListener("click", function (event) {
  783. event.preventDefault();
  784. modal.classList.remove("phpdocumentor-modal__open");
  785. });
  786. });
  787. });
  788. });
  789. })();
  790. </script>
  791. </article>
  792. </section>
  793. <section class="phpdocumentor-on-this-page__sidebar">
  794. <section class="phpdocumentor-on-this-page__content">
  795. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  796. <ul class="phpdocumentor-list -clean">
  797. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  798. <li>
  799. <ul class="phpdocumentor-list -clean">
  800. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc-constants">Constants</a></li>
  801. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#toc-methods">Methods</a></li>
  802. </ul>
  803. </li>
  804. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  805. <li>
  806. <ul class="phpdocumentor-list -clean">
  807. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump">dump()</a></li>
  808. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  809. </ul>
  810. </li>
  811. <li class="phpdocumentor-on-this-page-section__title">Constants</li>
  812. <li>
  813. <ul class="phpdocumentor-list -clean">
  814. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_CUSTOM">CUSTOM</a></li>
  815. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_DEFAULT_MODULE_VALUES">DEFAULT_MODULE_VALUES</a></li>
  816. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_EPS">EPS</a></li>
  817. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_FPDF">FPDF</a></li>
  818. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_BMP">GDIMAGE_BMP</a></li>
  819. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_GIF">GDIMAGE_GIF</a></li>
  820. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_JPG">GDIMAGE_JPG</a></li>
  821. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_PNG">GDIMAGE_PNG</a></li>
  822. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_WEBP">GDIMAGE_WEBP</a></li>
  823. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_IMAGICK">IMAGICK</a></li>
  824. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_LAYERNAMES">LAYERNAMES</a></li>
  825. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MARKUP_HTML">MARKUP_HTML</a></li>
  826. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MARKUP_SVG">MARKUP_SVG</a></li>
  827. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES">MODES</a></li>
  828. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_STRING_JSON">STRING_JSON</a></li>
  829. <li><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_STRING_TEXT">STRING_TEXT</a></li>
  830. </ul>
  831. </li>
  832. </ul>
  833. </section>
  834. </section>
  835. </div>
  836. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  837. <section class="phpdocumentor-search-results__dialog">
  838. <header class="phpdocumentor-search-results__header">
  839. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  840. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  841. </header>
  842. <section class="phpdocumentor-search-results__body">
  843. <ul class="phpdocumentor-search-results__entries"></ul>
  844. </section>
  845. </section>
  846. </section>
  847. </div>
  848. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  849. </main>
  850. <script>
  851. cssVars({});
  852. </script>
  853. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  854. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  855. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  856. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  857. </body>
  858. </html>