chillerlan-QRCode-Output-QROutputInterface.html 53 KB

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