chillerlan-QRCode-Output-QROutputInterface.html 45 KB

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