chillerlan-QRCode-Output-QROutputInterface.html 44 KB

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