chillerlan-QRCode-Output-QROutputInterface.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  89. </ul>
  90. <article class="phpdocumentor-element -interface">
  91. <h2 class="phpdocumentor-content__title">
  92. QROutputInterface
  93. <div class="phpdocumentor-element__package">
  94. in
  95. <ul class="phpdocumentor-breadcrumbs">
  96. <li><a href="packages/Application.html">Application</a></li>
  97. </ul>
  98. </div>
  99. </h2>
  100. <aside class="phpdocumentor-element-found-in">
  101. <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>
  102. :
  103. <span class="phpdocumentor-element-found-in__line">18</span>
  104. </aside>
  105. <p class="phpdocumentor-summary">Converts the data matrix into readable output</p>
  106. <h3 id="toc">
  107. Table of Contents
  108. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  109. </h3>
  110. <dl class="phpdocumentor-table-of-contents">
  111. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  112. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_CUSTOM">CUSTOM</a>
  113. <span>
  114. &nbsp;= &#039;custom&#039; </span>
  115. </dt>
  116. <dd></dd>
  117. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  118. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_DEFAULT_MODULE_VALUES">DEFAULT_MODULE_VALUES</a>
  119. <span>
  120. &nbsp;= [
  121. // light
  122. \chillerlan\QRCode\Data\QRMatrix::M_NULL =&gt; false,
  123. \chillerlan\QRCode\Data\QRMatrix::M_DATA =&gt; false,
  124. \chillerlan\QRCode\Data\QRMatrix::M_FINDER =&gt; false,
  125. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR =&gt; false,
  126. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT =&gt; false,
  127. \chillerlan\QRCode\Data\QRMatrix::M_TIMING =&gt; false,
  128. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT =&gt; false,
  129. \chillerlan\QRCode\Data\QRMatrix::M_VERSION =&gt; false,
  130. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE =&gt; false,
  131. \chillerlan\QRCode\Data\QRMatrix::M_LOGO =&gt; false,
  132. \chillerlan\QRCode\Data\QRMatrix::M_TEST =&gt; false,
  133. // dark
  134. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  135. \chillerlan\QRCode\Data\QRMatrix::M_DATA | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  136. \chillerlan\QRCode\Data\QRMatrix::M_FINDER | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  137. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  138. \chillerlan\QRCode\Data\QRMatrix::M_TIMING | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  139. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  140. \chillerlan\QRCode\Data\QRMatrix::M_VERSION | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  141. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  142. \chillerlan\QRCode\Data\QRMatrix::M_TEST | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  143. ] </span>
  144. </dt>
  145. <dd></dd>
  146. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  147. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_EPS">EPS</a>
  148. <span>
  149. &nbsp;= &#039;eps&#039; </span>
  150. </dt>
  151. <dd></dd>
  152. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  153. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_FPDF">FPDF</a>
  154. <span>
  155. &nbsp;= &#039;fpdf&#039; </span>
  156. </dt>
  157. <dd></dd>
  158. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  159. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_GIF">GDIMAGE_GIF</a>
  160. <span>
  161. &nbsp;= &#039;gif&#039; </span>
  162. </dt>
  163. <dd></dd>
  164. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  165. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_JPG">GDIMAGE_JPG</a>
  166. <span>
  167. &nbsp;= &#039;jpg&#039; </span>
  168. </dt>
  169. <dd></dd>
  170. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  171. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_PNG">GDIMAGE_PNG</a>
  172. <span>
  173. &nbsp;= &#039;png&#039; </span>
  174. </dt>
  175. <dd></dd>
  176. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  177. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_IMAGICK">IMAGICK</a>
  178. <span>
  179. &nbsp;= &#039;imagick&#039; </span>
  180. </dt>
  181. <dd></dd>
  182. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  183. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MARKUP_HTML">MARKUP_HTML</a>
  184. <span>
  185. &nbsp;= &#039;html&#039; </span>
  186. </dt>
  187. <dd></dd>
  188. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  189. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MARKUP_SVG">MARKUP_SVG</a>
  190. <span>
  191. &nbsp;= &#039;svg&#039; </span>
  192. </dt>
  193. <dd></dd>
  194. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  195. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES">MODES</a>
  196. <span>
  197. &nbsp;= [self::MARKUP_SVG =&gt; \chillerlan\QRCode\Output\QRMarkupSVG::class, self::MARKUP_HTML =&gt; \chillerlan\QRCode\Output\QRMarkupHTML::class, self::GDIMAGE_PNG =&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::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>
  198. </dt>
  199. <dd>Map of built-in output modes =&gt; modules</dd>
  200. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  201. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_STRING_JSON">STRING_JSON</a>
  202. <span>
  203. &nbsp;= &#039;json&#039; </span>
  204. </dt>
  205. <dd></dd>
  206. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  207. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_STRING_TEXT">STRING_TEXT</a>
  208. <span>
  209. &nbsp;= &#039;text&#039; </span>
  210. </dt>
  211. <dd></dd>
  212. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  213. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump">dump()</a>
  214. <span>
  215. &nbsp;: mixed </span>
  216. </dt>
  217. <dd>generates the output, optionally dumps it to a file, and returns it</dd>
  218. </dl>
  219. <section class="phpdocumentor-constants">
  220. <h3 class="phpdocumentor-elements__header" id="constants">
  221. Constants
  222. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  223. </h3>
  224. <article class="phpdocumentor-element -constant -public ">
  225. <h4 class="phpdocumentor-element__name" id="constant_CUSTOM">
  226. CUSTOM
  227. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_CUSTOM" class="headerlink"><i class="fas fa-link"></i></a>
  228. </h4>
  229. <aside class="phpdocumentor-element-found-in">
  230. <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>
  231. :
  232. <span class="phpdocumentor-element-found-in__line">41</span>
  233. </aside>
  234. <code class="phpdocumentor-signature phpdocumentor-code ">
  235. <span class="phpdocumentor-signature__visibility">public</span>
  236. <span class="phpdocumentor-signature__type">string</span>
  237. <span class="phpdocumentor-signature__name">CUSTOM</span>
  238. = <span class="phpdocumentor-signature__default-value">&#039;custom&#039;</span>
  239. </code>
  240. </article>
  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">64</span>
  250. </aside>
  251. <code class="phpdocumentor-signature phpdocumentor-code ">
  252. <span class="phpdocumentor-signature__visibility">public</span>
  253. <span class="phpdocumentor-signature__type">array&lt;string|int, bool&gt;</span>
  254. <span class="phpdocumentor-signature__name">DEFAULT_MODULE_VALUES</span>
  255. = <span class="phpdocumentor-signature__default-value">[
  256. // light
  257. \chillerlan\QRCode\Data\QRMatrix::M_NULL =&gt; false,
  258. \chillerlan\QRCode\Data\QRMatrix::M_DATA =&gt; false,
  259. \chillerlan\QRCode\Data\QRMatrix::M_FINDER =&gt; false,
  260. \chillerlan\QRCode\Data\QRMatrix::M_SEPARATOR =&gt; false,
  261. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT =&gt; false,
  262. \chillerlan\QRCode\Data\QRMatrix::M_TIMING =&gt; false,
  263. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT =&gt; false,
  264. \chillerlan\QRCode\Data\QRMatrix::M_VERSION =&gt; false,
  265. \chillerlan\QRCode\Data\QRMatrix::M_QUIETZONE =&gt; false,
  266. \chillerlan\QRCode\Data\QRMatrix::M_LOGO =&gt; false,
  267. \chillerlan\QRCode\Data\QRMatrix::M_TEST =&gt; false,
  268. // dark
  269. \chillerlan\QRCode\Data\QRMatrix::M_DARKMODULE | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  270. \chillerlan\QRCode\Data\QRMatrix::M_DATA | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  271. \chillerlan\QRCode\Data\QRMatrix::M_FINDER | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  272. \chillerlan\QRCode\Data\QRMatrix::M_ALIGNMENT | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  273. \chillerlan\QRCode\Data\QRMatrix::M_TIMING | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  274. \chillerlan\QRCode\Data\QRMatrix::M_FORMAT | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  275. \chillerlan\QRCode\Data\QRMatrix::M_VERSION | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  276. \chillerlan\QRCode\Data\QRMatrix::M_FINDER_DOT | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  277. \chillerlan\QRCode\Data\QRMatrix::M_TEST | \chillerlan\QRCode\Data\QRMatrix::IS_DARK =&gt; true,
  278. ]</span>
  279. </code>
  280. </article>
  281. <article class="phpdocumentor-element -constant -public ">
  282. <h4 class="phpdocumentor-element__name" id="constant_EPS">
  283. EPS
  284. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_EPS" class="headerlink"><i class="fas fa-link"></i></a>
  285. </h4>
  286. <aside class="phpdocumentor-element-found-in">
  287. <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>
  288. :
  289. <span class="phpdocumentor-element-found-in__line">39</span>
  290. </aside>
  291. <code class="phpdocumentor-signature phpdocumentor-code ">
  292. <span class="phpdocumentor-signature__visibility">public</span>
  293. <span class="phpdocumentor-signature__type">string</span>
  294. <span class="phpdocumentor-signature__name">EPS</span>
  295. = <span class="phpdocumentor-signature__default-value">&#039;eps&#039;</span>
  296. </code>
  297. </article>
  298. <article class="phpdocumentor-element -constant -public ">
  299. <h4 class="phpdocumentor-element__name" id="constant_FPDF">
  300. FPDF
  301. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_FPDF" class="headerlink"><i class="fas fa-link"></i></a>
  302. </h4>
  303. <aside class="phpdocumentor-element-found-in">
  304. <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>
  305. :
  306. <span class="phpdocumentor-element-found-in__line">37</span>
  307. </aside>
  308. <code class="phpdocumentor-signature phpdocumentor-code ">
  309. <span class="phpdocumentor-signature__visibility">public</span>
  310. <span class="phpdocumentor-signature__type">string</span>
  311. <span class="phpdocumentor-signature__name">FPDF</span>
  312. = <span class="phpdocumentor-signature__default-value">&#039;fpdf&#039;</span>
  313. </code>
  314. </article>
  315. <article class="phpdocumentor-element -constant -public ">
  316. <h4 class="phpdocumentor-element__name" id="constant_GDIMAGE_GIF">
  317. GDIMAGE_GIF
  318. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_GIF" class="headerlink"><i class="fas fa-link"></i></a>
  319. </h4>
  320. <aside class="phpdocumentor-element-found-in">
  321. <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>
  322. :
  323. <span class="phpdocumentor-element-found-in__line">29</span>
  324. </aside>
  325. <code class="phpdocumentor-signature phpdocumentor-code ">
  326. <span class="phpdocumentor-signature__visibility">public</span>
  327. <span class="phpdocumentor-signature__type">string</span>
  328. <span class="phpdocumentor-signature__name">GDIMAGE_GIF</span>
  329. = <span class="phpdocumentor-signature__default-value">&#039;gif&#039;</span>
  330. </code>
  331. </article>
  332. <article class="phpdocumentor-element -constant -public ">
  333. <h4 class="phpdocumentor-element__name" id="constant_GDIMAGE_JPG">
  334. GDIMAGE_JPG
  335. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_JPG" class="headerlink"><i class="fas fa-link"></i></a>
  336. </h4>
  337. <aside class="phpdocumentor-element-found-in">
  338. <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>
  339. :
  340. <span class="phpdocumentor-element-found-in__line">27</span>
  341. </aside>
  342. <code class="phpdocumentor-signature phpdocumentor-code ">
  343. <span class="phpdocumentor-signature__visibility">public</span>
  344. <span class="phpdocumentor-signature__type">string</span>
  345. <span class="phpdocumentor-signature__name">GDIMAGE_JPG</span>
  346. = <span class="phpdocumentor-signature__default-value">&#039;jpg&#039;</span>
  347. </code>
  348. </article>
  349. <article class="phpdocumentor-element -constant -public ">
  350. <h4 class="phpdocumentor-element__name" id="constant_GDIMAGE_PNG">
  351. GDIMAGE_PNG
  352. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_PNG" class="headerlink"><i class="fas fa-link"></i></a>
  353. </h4>
  354. <aside class="phpdocumentor-element-found-in">
  355. <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>
  356. :
  357. <span class="phpdocumentor-element-found-in__line">25</span>
  358. </aside>
  359. <code class="phpdocumentor-signature phpdocumentor-code ">
  360. <span class="phpdocumentor-signature__visibility">public</span>
  361. <span class="phpdocumentor-signature__type">string</span>
  362. <span class="phpdocumentor-signature__name">GDIMAGE_PNG</span>
  363. = <span class="phpdocumentor-signature__default-value">&#039;png&#039;</span>
  364. </code>
  365. </article>
  366. <article class="phpdocumentor-element -constant -public ">
  367. <h4 class="phpdocumentor-element__name" id="constant_IMAGICK">
  368. IMAGICK
  369. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_IMAGICK" class="headerlink"><i class="fas fa-link"></i></a>
  370. </h4>
  371. <aside class="phpdocumentor-element-found-in">
  372. <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>
  373. :
  374. <span class="phpdocumentor-element-found-in__line">35</span>
  375. </aside>
  376. <code class="phpdocumentor-signature phpdocumentor-code ">
  377. <span class="phpdocumentor-signature__visibility">public</span>
  378. <span class="phpdocumentor-signature__type">string</span>
  379. <span class="phpdocumentor-signature__name">IMAGICK</span>
  380. = <span class="phpdocumentor-signature__default-value">&#039;imagick&#039;</span>
  381. </code>
  382. </article>
  383. <article class="phpdocumentor-element -constant -public ">
  384. <h4 class="phpdocumentor-element__name" id="constant_MARKUP_HTML">
  385. MARKUP_HTML
  386. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MARKUP_HTML" class="headerlink"><i class="fas fa-link"></i></a>
  387. </h4>
  388. <aside class="phpdocumentor-element-found-in">
  389. <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>
  390. :
  391. <span class="phpdocumentor-element-found-in__line">21</span>
  392. </aside>
  393. <code class="phpdocumentor-signature phpdocumentor-code ">
  394. <span class="phpdocumentor-signature__visibility">public</span>
  395. <span class="phpdocumentor-signature__type">string</span>
  396. <span class="phpdocumentor-signature__name">MARKUP_HTML</span>
  397. = <span class="phpdocumentor-signature__default-value">&#039;html&#039;</span>
  398. </code>
  399. </article>
  400. <article class="phpdocumentor-element -constant -public ">
  401. <h4 class="phpdocumentor-element__name" id="constant_MARKUP_SVG">
  402. MARKUP_SVG
  403. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MARKUP_SVG" 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">23</span>
  409. </aside>
  410. <code class="phpdocumentor-signature phpdocumentor-code ">
  411. <span class="phpdocumentor-signature__visibility">public</span>
  412. <span class="phpdocumentor-signature__type">string</span>
  413. <span class="phpdocumentor-signature__name">MARKUP_SVG</span>
  414. = <span class="phpdocumentor-signature__default-value">&#039;svg&#039;</span>
  415. </code>
  416. </article>
  417. <article class="phpdocumentor-element -constant -public ">
  418. <h4 class="phpdocumentor-element__name" id="constant_MODES">
  419. MODES
  420. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES" class="headerlink"><i class="fas fa-link"></i></a>
  421. </h4>
  422. <aside class="phpdocumentor-element-found-in">
  423. <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>
  424. :
  425. <span class="phpdocumentor-element-found-in__line">48</span>
  426. </aside>
  427. <p class="phpdocumentor-summary">Map of built-in output modes =&gt; modules</p>
  428. <code class="phpdocumentor-signature phpdocumentor-code ">
  429. <span class="phpdocumentor-signature__visibility">public</span>
  430. <span class="phpdocumentor-signature__type">array&lt;string|int, string&gt;</span>
  431. <span class="phpdocumentor-signature__name">MODES</span>
  432. = <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_PNG =&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::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>
  433. </code>
  434. </article>
  435. <article class="phpdocumentor-element -constant -public ">
  436. <h4 class="phpdocumentor-element__name" id="constant_STRING_JSON">
  437. STRING_JSON
  438. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_STRING_JSON" class="headerlink"><i class="fas fa-link"></i></a>
  439. </h4>
  440. <aside class="phpdocumentor-element-found-in">
  441. <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>
  442. :
  443. <span class="phpdocumentor-element-found-in__line">31</span>
  444. </aside>
  445. <code class="phpdocumentor-signature phpdocumentor-code ">
  446. <span class="phpdocumentor-signature__visibility">public</span>
  447. <span class="phpdocumentor-signature__type">string</span>
  448. <span class="phpdocumentor-signature__name">STRING_JSON</span>
  449. = <span class="phpdocumentor-signature__default-value">&#039;json&#039;</span>
  450. </code>
  451. </article>
  452. <article class="phpdocumentor-element -constant -public ">
  453. <h4 class="phpdocumentor-element__name" id="constant_STRING_TEXT">
  454. STRING_TEXT
  455. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_STRING_TEXT" class="headerlink"><i class="fas fa-link"></i></a>
  456. </h4>
  457. <aside class="phpdocumentor-element-found-in">
  458. <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>
  459. :
  460. <span class="phpdocumentor-element-found-in__line">33</span>
  461. </aside>
  462. <code class="phpdocumentor-signature phpdocumentor-code ">
  463. <span class="phpdocumentor-signature__visibility">public</span>
  464. <span class="phpdocumentor-signature__type">string</span>
  465. <span class="phpdocumentor-signature__name">STRING_TEXT</span>
  466. = <span class="phpdocumentor-signature__default-value">&#039;text&#039;</span>
  467. </code>
  468. </article>
  469. </section>
  470. <section class="phpdocumentor-methods">
  471. <h3 class="phpdocumentor-elements__header" id="methods">
  472. Methods
  473. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  474. </h3>
  475. <article
  476. class="phpdocumentor-element
  477. -method
  478. -public
  479. "
  480. >
  481. <h4 class="phpdocumentor-element__name" id="method_dump">
  482. dump()
  483. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  484. </h4>
  485. <aside class="phpdocumentor-element-found-in">
  486. <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>
  487. :
  488. <span class="phpdocumentor-element-found-in__line">94</span>
  489. </aside>
  490. <p class="phpdocumentor-summary">generates the output, optionally dumps it to a file, and returns it</p>
  491. <code class="phpdocumentor-code phpdocumentor-signature ">
  492. <span class="phpdocumentor-signature__visibility">public</span>
  493. <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>
  494. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  495. <dl class="phpdocumentor-argument-list">
  496. <dt class="phpdocumentor-argument-list__entry">
  497. <span class="phpdocumentor-signature__argument__name">$file</span>
  498. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  499. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  500. <dd class="phpdocumentor-argument-list__definition">
  501. <section class="phpdocumentor-description"></section>
  502. </dd>
  503. </dl>
  504. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  505. <span class="phpdocumentor-signature__response_type">mixed</span>
  506. &mdash;
  507. </article>
  508. </section>
  509. <script type="text/javascript">
  510. function loadExternalCodeSnippets(line) {
  511. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  512. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  513. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  514. var language = 'php';
  515. var code = document.createElement('code');
  516. code.className = 'language-' + language;
  517. pre.textContent = '';
  518. pre.setAttribute('data-line', line)
  519. code.textContent = 'Loading…';
  520. pre.appendChild(code);
  521. var xhr = new XMLHttpRequest();
  522. xhr.open('GET', src, true);
  523. xhr.onreadystatechange = function () {
  524. if (xhr.readyState == 4) {
  525. if (xhr.status < 400 && xhr.responseText) {
  526. code.textContent = xhr.responseText;
  527. Prism.highlightElement(code);
  528. }
  529. else if (xhr.status >= 400) {
  530. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  531. }
  532. else {
  533. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  534. }
  535. }
  536. };
  537. xhr.send(null);
  538. });
  539. }
  540. var modals = document.querySelectorAll("[data-modal]");
  541. modals.forEach(function (trigger) {
  542. trigger.addEventListener("click", function (event) {
  543. //event.preventDefault();
  544. const modal = document.getElementById(trigger.dataset.modal);
  545. modal.classList.add("phpdocumentor-modal__open");
  546. loadExternalCodeSnippets(trigger.dataset.line)
  547. const exits = modal.querySelectorAll("[data-exit-button]");
  548. exits.forEach(function (exit) {
  549. exit.addEventListener("click", function (event) {
  550. event.preventDefault();
  551. modal.classList.remove("phpdocumentor-modal__open");
  552. });
  553. });
  554. });
  555. });
  556. </script>
  557. </article>
  558. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  559. <section class="phpdocumentor-search-results__dialog">
  560. <header class="phpdocumentor-search-results__header">
  561. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  562. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  563. </header>
  564. <section class="phpdocumentor-search-results__body">
  565. <ul class="phpdocumentor-search-results__entries"></ul>
  566. </section>
  567. </section>
  568. </section>
  569. </div>
  570. </div>
  571. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  572. </main>
  573. <script>
  574. cssVars({});
  575. </script>
  576. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  577. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  578. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  579. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  580. </body>
  581. </html>