chillerlan-QRCode-QRCode.html 92 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/chillerlan.html">chillerlan</a></h4>
  56. <ul class="phpdocumentor-list">
  57. <li>
  58. <a href="namespaces/chillerlan-qrcode.html">QRCode</a>
  59. </li>
  60. <li>
  61. <a href="namespaces/chillerlan-qrcodetest.html">QRCodeTest</a>
  62. </li>
  63. </ul>
  64. </section>
  65. <section class="phpdocumentor-sidebar__category">
  66. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  67. <h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
  68. </section>
  69. <section class="phpdocumentor-sidebar__category">
  70. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  71. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  72. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  73. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  74. </section>
  75. <section class="phpdocumentor-sidebar__category">
  76. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  78. </section>
  79. </aside>
  80. <div class="phpdocumentor-column -eight phpdocumentor-content">
  81. <ul class="phpdocumentor-breadcrumbs">
  82. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  83. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  84. </ul>
  85. <article class="phpdocumentor-element -class">
  86. <h2 class="phpdocumentor-content__title">
  87. QRCode
  88. <div class="phpdocumentor-element__package">
  89. in package
  90. <ul class="phpdocumentor-breadcrumbs">
  91. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  92. </ul>
  93. </div>
  94. </h2>
  95. <aside class="phpdocumentor-element-found-in">
  96. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  97. :
  98. <span class="phpdocumentor-element-found-in__line">29</span>
  99. </aside>
  100. <p class="phpdocumentor-summary">Turns a text string into a Model 2 QR Code</p>
  101. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  102. Tags
  103. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  104. </h5>
  105. <dl class="phpdocumentor-tag-list">
  106. <dt class="phpdocumentor-tag-list__entry">
  107. <span class="phpdocumentor-tag__name">see</span>
  108. </dt>
  109. <dd class="phpdocumentor-tag-list__definition">
  110. <span class="phpdocumentor-tag-link"><a href="https://github.com/kazuhikoarase/qrcode-generator/tree/master/php"><abbr title="https://github.com/kazuhikoarase/qrcode-generator/tree/master/php">https://github.com/kazuhikoarase/qrcode-generator/tree/master/php</abbr></a></span>
  111. </dd>
  112. <dt class="phpdocumentor-tag-list__entry">
  113. <span class="phpdocumentor-tag__name">see</span>
  114. </dt>
  115. <dd class="phpdocumentor-tag-list__definition">
  116. <span class="phpdocumentor-tag-link"><a href="http://www.qrcode.com/en/codes/model12.html"><abbr title="http://www.qrcode.com/en/codes/model12.html">http://www.qrcode.com/en/codes/model12.html</abbr></a></span>
  117. </dd>
  118. <dt class="phpdocumentor-tag-list__entry">
  119. <span class="phpdocumentor-tag__name">see</span>
  120. </dt>
  121. <dd class="phpdocumentor-tag-list__definition">
  122. <span class="phpdocumentor-tag-link"><a href="https://www.swisseduc.ch/informatik/theoretische_informatik/qr_codes/docs/qr_standard.pdf"><abbr title="https://www.swisseduc.ch/informatik/theoretische_informatik/qr_codes/docs/qr_standard.pdf">https://www.swisseduc.ch/informatik/theoretische_informatik/qr_codes/docs/qr_standard.pdf</abbr></a></span>
  123. </dd>
  124. <dt class="phpdocumentor-tag-list__entry">
  125. <span class="phpdocumentor-tag__name">see</span>
  126. </dt>
  127. <dd class="phpdocumentor-tag-list__definition">
  128. <span class="phpdocumentor-tag-link"><a href="https://en.wikipedia.org/wiki/QR_code"><abbr title="https://en.wikipedia.org/wiki/QR_code">https://en.wikipedia.org/wiki/QR_code</abbr></a></span>
  129. </dd>
  130. <dt class="phpdocumentor-tag-list__entry">
  131. <span class="phpdocumentor-tag__name">see</span>
  132. </dt>
  133. <dd class="phpdocumentor-tag-list__definition">
  134. <span class="phpdocumentor-tag-link"><a href="http://www.thonky.com/qr-code-tutorial/"><abbr title="http://www.thonky.com/qr-code-tutorial/">http://www.thonky.com/qr-code-tutorial/</abbr></a></span>
  135. </dd>
  136. </dl>
  137. <h3 id="toc">
  138. Table of Contents
  139. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  140. </h3>
  141. <dl class="phpdocumentor-table-of-contents">
  142. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  143. <a href="classes/chillerlan-QRCode-QRCode.html#constant_MASK_PATTERN_AUTO">MASK_PATTERN_AUTO</a>
  144. <span>
  145. &nbsp;= -1 </span>
  146. </dt>
  147. <dd></dd>
  148. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  149. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_CUSTOM">OUTPUT_CUSTOM</a>
  150. <span>
  151. &nbsp;= &#039;custom&#039; </span>
  152. </dt>
  153. <dd></dd>
  154. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  155. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_FPDF">OUTPUT_FPDF</a>
  156. <span>
  157. &nbsp;= &#039;fpdf&#039; </span>
  158. </dt>
  159. <dd></dd>
  160. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  161. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_GIF">OUTPUT_IMAGE_GIF</a>
  162. <span>
  163. &nbsp;= &#039;gif&#039; </span>
  164. </dt>
  165. <dd></dd>
  166. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  167. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_JPG">OUTPUT_IMAGE_JPG</a>
  168. <span>
  169. &nbsp;= &#039;jpg&#039; </span>
  170. </dt>
  171. <dd></dd>
  172. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  173. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_PNG">OUTPUT_IMAGE_PNG</a>
  174. <span>
  175. &nbsp;= &#039;png&#039; </span>
  176. </dt>
  177. <dd></dd>
  178. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  179. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGICK">OUTPUT_IMAGICK</a>
  180. <span>
  181. &nbsp;= &#039;imagick&#039; </span>
  182. </dt>
  183. <dd></dd>
  184. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  185. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MARKUP_HTML">OUTPUT_MARKUP_HTML</a>
  186. <span>
  187. &nbsp;= &#039;html&#039; </span>
  188. </dt>
  189. <dd></dd>
  190. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  191. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MARKUP_SVG">OUTPUT_MARKUP_SVG</a>
  192. <span>
  193. &nbsp;= &#039;svg&#039; </span>
  194. </dt>
  195. <dd></dd>
  196. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  197. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MODES">OUTPUT_MODES</a>
  198. <span>
  199. &nbsp;= [chillerlanQRCodeOutputQRMarkup::class =&gt; [self::OUTPUT_MARKUP_SVG, self::OUTPUT_MARKUP_HTML], chillerlanQRCodeOutputQRImage::class =&gt; [self::OUTPUT_IMAGE_PNG, self::OUTPUT_IMAGE_GIF, self::OUTPUT_IMAGE_JPG], chillerlanQRCodeOutputQRString::class =&gt; [self::OUTPUT_STRING_JSON, self::OUTPUT_STRING_TEXT], chillerlanQRCodeOutputQRImagick::class =&gt; [self::OUTPUT_IMAGICK], chillerlanQRCodeOutputQRFpdf::class =&gt; [self::OUTPUT_FPDF]] </span>
  200. </dt>
  201. <dd>Map of built-in output modules =&gt; capabilities</dd>
  202. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  203. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_STRING_JSON">OUTPUT_STRING_JSON</a>
  204. <span>
  205. &nbsp;= &#039;json&#039; </span>
  206. </dt>
  207. <dd></dd>
  208. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  209. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_STRING_TEXT">OUTPUT_STRING_TEXT</a>
  210. <span>
  211. &nbsp;= &#039;text&#039; </span>
  212. </dt>
  213. <dd></dd>
  214. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  215. <a href="classes/chillerlan-QRCode-QRCode.html#constant_VERSION_AUTO">VERSION_AUTO</a>
  216. <span>
  217. &nbsp;= -1 </span>
  218. </dt>
  219. <dd></dd>
  220. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  221. <a href="classes/chillerlan-QRCode-QRCode.html#property_dataInterface">$dataInterface</a>
  222. <span>
  223. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRData.html"><abbr title="\chillerlan\QRCode\Data\QRData">QRData</abbr></a> </span>
  224. </dt>
  225. <dd>The selected data interface (Number, AlphaNum, Kanji, Byte)</dd>
  226. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  227. <a href="classes/chillerlan-QRCode-QRCode.html#property_dataSegments">$dataSegments</a>
  228. <span>
  229. &nbsp;: array&lt;string|int, mixed&gt; </span>
  230. </dt>
  231. <dd>A collection of one or more data segments of [classname, data] to write</dd>
  232. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  233. <a href="classes/chillerlan-QRCode-QRCode.html#property_options">$options</a>
  234. <span>
  235. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  236. </dt>
  237. <dd>The settings container</dd>
  238. <dt class="phpdocumentor-table-of-contents__entry -property -private">
  239. <a href="classes/chillerlan-QRCode-QRCode.html#property_luminanceSourceClass">$luminanceSourceClass</a>
  240. <span>
  241. &nbsp;: string </span>
  242. </dt>
  243. <dd>The FQCN of the luminance sporce class to use in the reader (GD or Imagick)</dd>
  244. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  245. <a href="classes/chillerlan-QRCode-QRCode.html#method___construct">__construct()</a>
  246. <span>
  247. &nbsp;: mixed </span>
  248. </dt>
  249. <dd>QRCode constructor.</dd>
  250. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  251. <a href="classes/chillerlan-QRCode-QRCode.html#method_addAlphaNumSegment">addAlphaNumSegment()</a>
  252. <span>
  253. &nbsp;: self </span>
  254. </dt>
  255. <dd>ISO/IEC 18004:2000 8.3.3 - Alphanumeric Mode</dd>
  256. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  257. <a href="classes/chillerlan-QRCode-QRCode.html#method_addByteSegment">addByteSegment()</a>
  258. <span>
  259. &nbsp;: self </span>
  260. </dt>
  261. <dd>ISO/IEC 18004:2000 8.3.4 - 8-bit Byte Mode</dd>
  262. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  263. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciDesignator">addEciDesignator()</a>
  264. <span>
  265. &nbsp;: self </span>
  266. </dt>
  267. <dd>ISO/IEC 18004:2000 8.3.1 - Extended Channel Interpretation (ECI) Mode</dd>
  268. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  269. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciSegment">addEciSegment()</a>
  270. <span>
  271. &nbsp;: self </span>
  272. </dt>
  273. <dd>i hate this somehow but i&#039;ll leave it for now</dd>
  274. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  275. <a href="classes/chillerlan-QRCode-QRCode.html#method_addKanjiSegment">addKanjiSegment()</a>
  276. <span>
  277. &nbsp;: self </span>
  278. </dt>
  279. <dd>ISO/IEC 18004:2000 8.3.5 - Kanji Mode</dd>
  280. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  281. <a href="classes/chillerlan-QRCode-QRCode.html#method_addNumberSegment">addNumberSegment()</a>
  282. <span>
  283. &nbsp;: self </span>
  284. </dt>
  285. <dd>ISO/IEC 18004:2000 8.3.2 - Numeric Mode</dd>
  286. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  287. <a href="classes/chillerlan-QRCode-QRCode.html#method_clearSegments">clearSegments()</a>
  288. <span>
  289. &nbsp;: self </span>
  290. </dt>
  291. <dd>Clears the data segments array</dd>
  292. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  293. <a href="classes/chillerlan-QRCode-QRCode.html#method_getMatrix">getMatrix()</a>
  294. <span>
  295. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  296. </dt>
  297. <dd>Returns a QRMatrix object for the given $data and current QROptions</dd>
  298. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  299. <a href="classes/chillerlan-QRCode-QRCode.html#method_isAlphaNum">isAlphaNum()</a>
  300. <span>
  301. &nbsp;: bool </span>
  302. </dt>
  303. <dd>checks if a string qualifies as alphanumeric (convenience method)</dd>
  304. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  305. <a href="classes/chillerlan-QRCode-QRCode.html#method_isByte">isByte()</a>
  306. <span>
  307. &nbsp;: bool </span>
  308. </dt>
  309. <dd>a dummy (convenience method)</dd>
  310. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  311. <a href="classes/chillerlan-QRCode-QRCode.html#method_isKanji">isKanji()</a>
  312. <span>
  313. &nbsp;: bool </span>
  314. </dt>
  315. <dd>checks if a string qualifies as Kanji (convenience method)</dd>
  316. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  317. <a href="classes/chillerlan-QRCode-QRCode.html#method_isNumber">isNumber()</a>
  318. <span>
  319. &nbsp;: bool </span>
  320. </dt>
  321. <dd>checks if a string qualifies as numeric (convenience method)</dd>
  322. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  323. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromBlob">readFromBlob()</a>
  324. <span>
  325. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  326. </dt>
  327. <dd>Reads a QR Code from the given data blob</dd>
  328. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  329. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromFile">readFromFile()</a>
  330. <span>
  331. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  332. </dt>
  333. <dd>Reads a QR Code from a given file</dd>
  334. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  335. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromSource">readFromSource()</a>
  336. <span>
  337. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  338. </dt>
  339. <dd>Reads a QR Code from the given luminance source</dd>
  340. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  341. <a href="classes/chillerlan-QRCode-QRCode.html#method_render">render()</a>
  342. <span>
  343. &nbsp;: mixed </span>
  344. </dt>
  345. <dd>Renders a QR Code for the given $data and QROptions</dd>
  346. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  347. <a href="classes/chillerlan-QRCode-QRCode.html#method_addSegment">addSegment()</a>
  348. <span>
  349. &nbsp;: void </span>
  350. </dt>
  351. <dd>ISO/IEC 18004:2000 8.3.6 - Mixing modes
  352. ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length</dd>
  353. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  354. <a href="classes/chillerlan-QRCode-QRCode.html#method_initCustomOutputInterface">initCustomOutputInterface()</a>
  355. <span>
  356. &nbsp;: <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a> </span>
  357. </dt>
  358. <dd>initializes a custom output module after checking the existence of the class and if it implemnts the required interface</dd>
  359. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  360. <a href="classes/chillerlan-QRCode-QRCode.html#method_initOutputInterface">initOutputInterface()</a>
  361. <span>
  362. &nbsp;: <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a> </span>
  363. </dt>
  364. <dd>returns a fresh (built-in) QROutputInterface</dd>
  365. </dl>
  366. <section class="phpdocumentor-constants">
  367. <h3 class="phpdocumentor-elements__header" id="constants">
  368. Constants
  369. <a href="classes/chillerlan-QRCode-QRCode.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  370. </h3>
  371. <article class="phpdocumentor-element -constant -public ">
  372. <h4 class="phpdocumentor-element__name" id="constant_MASK_PATTERN_AUTO">
  373. MASK_PATTERN_AUTO
  374. <a href="classes/chillerlan-QRCode-QRCode.html#constant_MASK_PATTERN_AUTO" class="headerlink"><i class="fas fa-link"></i></a>
  375. </h4>
  376. <aside class="phpdocumentor-element-found-in">
  377. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  378. :
  379. <span class="phpdocumentor-element-found-in__line">34</span>
  380. </aside>
  381. <code class="phpdocumentor-signature phpdocumentor-code ">
  382. <span class="phpdocumentor-signature__visibility">public</span>
  383. <span class="phpdocumentor-signature__type">int</span>
  384. <span class="phpdocumentor-signature__name">MASK_PATTERN_AUTO</span>
  385. = <span class="phpdocumentor-signature__default-value">-1</span>
  386. </code>
  387. </article>
  388. <article class="phpdocumentor-element -constant -public ">
  389. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_CUSTOM">
  390. OUTPUT_CUSTOM
  391. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_CUSTOM" class="headerlink"><i class="fas fa-link"></i></a>
  392. </h4>
  393. <aside class="phpdocumentor-element-found-in">
  394. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  395. :
  396. <span class="phpdocumentor-element-found-in__line">55</span>
  397. </aside>
  398. <code class="phpdocumentor-signature phpdocumentor-code ">
  399. <span class="phpdocumentor-signature__visibility">public</span>
  400. <span class="phpdocumentor-signature__type">string</span>
  401. <span class="phpdocumentor-signature__name">OUTPUT_CUSTOM</span>
  402. = <span class="phpdocumentor-signature__default-value">&#039;custom&#039;</span>
  403. </code>
  404. </article>
  405. <article class="phpdocumentor-element -constant -public ">
  406. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_FPDF">
  407. OUTPUT_FPDF
  408. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_FPDF" class="headerlink"><i class="fas fa-link"></i></a>
  409. </h4>
  410. <aside class="phpdocumentor-element-found-in">
  411. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  412. :
  413. <span class="phpdocumentor-element-found-in__line">53</span>
  414. </aside>
  415. <code class="phpdocumentor-signature phpdocumentor-code ">
  416. <span class="phpdocumentor-signature__visibility">public</span>
  417. <span class="phpdocumentor-signature__type">string</span>
  418. <span class="phpdocumentor-signature__name">OUTPUT_FPDF</span>
  419. = <span class="phpdocumentor-signature__default-value">&#039;fpdf&#039;</span>
  420. </code>
  421. </article>
  422. <article class="phpdocumentor-element -constant -public ">
  423. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_IMAGE_GIF">
  424. OUTPUT_IMAGE_GIF
  425. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_GIF" class="headerlink"><i class="fas fa-link"></i></a>
  426. </h4>
  427. <aside class="phpdocumentor-element-found-in">
  428. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  429. :
  430. <span class="phpdocumentor-element-found-in__line">45</span>
  431. </aside>
  432. <code class="phpdocumentor-signature phpdocumentor-code ">
  433. <span class="phpdocumentor-signature__visibility">public</span>
  434. <span class="phpdocumentor-signature__type">string</span>
  435. <span class="phpdocumentor-signature__name">OUTPUT_IMAGE_GIF</span>
  436. = <span class="phpdocumentor-signature__default-value">&#039;gif&#039;</span>
  437. </code>
  438. </article>
  439. <article class="phpdocumentor-element -constant -public ">
  440. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_IMAGE_JPG">
  441. OUTPUT_IMAGE_JPG
  442. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_JPG" class="headerlink"><i class="fas fa-link"></i></a>
  443. </h4>
  444. <aside class="phpdocumentor-element-found-in">
  445. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  446. :
  447. <span class="phpdocumentor-element-found-in__line">43</span>
  448. </aside>
  449. <code class="phpdocumentor-signature phpdocumentor-code ">
  450. <span class="phpdocumentor-signature__visibility">public</span>
  451. <span class="phpdocumentor-signature__type">string</span>
  452. <span class="phpdocumentor-signature__name">OUTPUT_IMAGE_JPG</span>
  453. = <span class="phpdocumentor-signature__default-value">&#039;jpg&#039;</span>
  454. </code>
  455. </article>
  456. <article class="phpdocumentor-element -constant -public ">
  457. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_IMAGE_PNG">
  458. OUTPUT_IMAGE_PNG
  459. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_PNG" class="headerlink"><i class="fas fa-link"></i></a>
  460. </h4>
  461. <aside class="phpdocumentor-element-found-in">
  462. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  463. :
  464. <span class="phpdocumentor-element-found-in__line">41</span>
  465. </aside>
  466. <code class="phpdocumentor-signature phpdocumentor-code ">
  467. <span class="phpdocumentor-signature__visibility">public</span>
  468. <span class="phpdocumentor-signature__type">string</span>
  469. <span class="phpdocumentor-signature__name">OUTPUT_IMAGE_PNG</span>
  470. = <span class="phpdocumentor-signature__default-value">&#039;png&#039;</span>
  471. </code>
  472. </article>
  473. <article class="phpdocumentor-element -constant -public ">
  474. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_IMAGICK">
  475. OUTPUT_IMAGICK
  476. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGICK" class="headerlink"><i class="fas fa-link"></i></a>
  477. </h4>
  478. <aside class="phpdocumentor-element-found-in">
  479. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  480. :
  481. <span class="phpdocumentor-element-found-in__line">51</span>
  482. </aside>
  483. <code class="phpdocumentor-signature phpdocumentor-code ">
  484. <span class="phpdocumentor-signature__visibility">public</span>
  485. <span class="phpdocumentor-signature__type">string</span>
  486. <span class="phpdocumentor-signature__name">OUTPUT_IMAGICK</span>
  487. = <span class="phpdocumentor-signature__default-value">&#039;imagick&#039;</span>
  488. </code>
  489. </article>
  490. <article class="phpdocumentor-element -constant -public ">
  491. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_MARKUP_HTML">
  492. OUTPUT_MARKUP_HTML
  493. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MARKUP_HTML" class="headerlink"><i class="fas fa-link"></i></a>
  494. </h4>
  495. <aside class="phpdocumentor-element-found-in">
  496. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  497. :
  498. <span class="phpdocumentor-element-found-in__line">37</span>
  499. </aside>
  500. <code class="phpdocumentor-signature phpdocumentor-code ">
  501. <span class="phpdocumentor-signature__visibility">public</span>
  502. <span class="phpdocumentor-signature__type">string</span>
  503. <span class="phpdocumentor-signature__name">OUTPUT_MARKUP_HTML</span>
  504. = <span class="phpdocumentor-signature__default-value">&#039;html&#039;</span>
  505. </code>
  506. </article>
  507. <article class="phpdocumentor-element -constant -public ">
  508. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_MARKUP_SVG">
  509. OUTPUT_MARKUP_SVG
  510. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MARKUP_SVG" class="headerlink"><i class="fas fa-link"></i></a>
  511. </h4>
  512. <aside class="phpdocumentor-element-found-in">
  513. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  514. :
  515. <span class="phpdocumentor-element-found-in__line">39</span>
  516. </aside>
  517. <code class="phpdocumentor-signature phpdocumentor-code ">
  518. <span class="phpdocumentor-signature__visibility">public</span>
  519. <span class="phpdocumentor-signature__type">string</span>
  520. <span class="phpdocumentor-signature__name">OUTPUT_MARKUP_SVG</span>
  521. = <span class="phpdocumentor-signature__default-value">&#039;svg&#039;</span>
  522. </code>
  523. </article>
  524. <article class="phpdocumentor-element -constant -public ">
  525. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_MODES">
  526. OUTPUT_MODES
  527. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MODES" class="headerlink"><i class="fas fa-link"></i></a>
  528. </h4>
  529. <aside class="phpdocumentor-element-found-in">
  530. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  531. :
  532. <span class="phpdocumentor-element-found-in__line">62</span>
  533. </aside>
  534. <p class="phpdocumentor-summary">Map of built-in output modules =&gt; capabilities</p>
  535. <code class="phpdocumentor-signature phpdocumentor-code ">
  536. <span class="phpdocumentor-signature__visibility">public</span>
  537. <span class="phpdocumentor-signature__type">array&lt;string|int, array&lt;string|int, string&gt;&gt;</span>
  538. <span class="phpdocumentor-signature__name">OUTPUT_MODES</span>
  539. = <span class="phpdocumentor-signature__default-value">[chillerlanQRCodeOutputQRMarkup::class =&gt; [self::OUTPUT_MARKUP_SVG, self::OUTPUT_MARKUP_HTML], chillerlanQRCodeOutputQRImage::class =&gt; [self::OUTPUT_IMAGE_PNG, self::OUTPUT_IMAGE_GIF, self::OUTPUT_IMAGE_JPG], chillerlanQRCodeOutputQRString::class =&gt; [self::OUTPUT_STRING_JSON, self::OUTPUT_STRING_TEXT], chillerlanQRCodeOutputQRImagick::class =&gt; [self::OUTPUT_IMAGICK], chillerlanQRCodeOutputQRFpdf::class =&gt; [self::OUTPUT_FPDF]]</span>
  540. </code>
  541. </article>
  542. <article class="phpdocumentor-element -constant -public ">
  543. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_STRING_JSON">
  544. OUTPUT_STRING_JSON
  545. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_STRING_JSON" class="headerlink"><i class="fas fa-link"></i></a>
  546. </h4>
  547. <aside class="phpdocumentor-element-found-in">
  548. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  549. :
  550. <span class="phpdocumentor-element-found-in__line">47</span>
  551. </aside>
  552. <code class="phpdocumentor-signature phpdocumentor-code ">
  553. <span class="phpdocumentor-signature__visibility">public</span>
  554. <span class="phpdocumentor-signature__type">string</span>
  555. <span class="phpdocumentor-signature__name">OUTPUT_STRING_JSON</span>
  556. = <span class="phpdocumentor-signature__default-value">&#039;json&#039;</span>
  557. </code>
  558. </article>
  559. <article class="phpdocumentor-element -constant -public ">
  560. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_STRING_TEXT">
  561. OUTPUT_STRING_TEXT
  562. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_STRING_TEXT" class="headerlink"><i class="fas fa-link"></i></a>
  563. </h4>
  564. <aside class="phpdocumentor-element-found-in">
  565. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  566. :
  567. <span class="phpdocumentor-element-found-in__line">49</span>
  568. </aside>
  569. <code class="phpdocumentor-signature phpdocumentor-code ">
  570. <span class="phpdocumentor-signature__visibility">public</span>
  571. <span class="phpdocumentor-signature__type">string</span>
  572. <span class="phpdocumentor-signature__name">OUTPUT_STRING_TEXT</span>
  573. = <span class="phpdocumentor-signature__default-value">&#039;text&#039;</span>
  574. </code>
  575. </article>
  576. <article class="phpdocumentor-element -constant -public ">
  577. <h4 class="phpdocumentor-element__name" id="constant_VERSION_AUTO">
  578. VERSION_AUTO
  579. <a href="classes/chillerlan-QRCode-QRCode.html#constant_VERSION_AUTO" class="headerlink"><i class="fas fa-link"></i></a>
  580. </h4>
  581. <aside class="phpdocumentor-element-found-in">
  582. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  583. :
  584. <span class="phpdocumentor-element-found-in__line">32</span>
  585. </aside>
  586. <code class="phpdocumentor-signature phpdocumentor-code ">
  587. <span class="phpdocumentor-signature__visibility">public</span>
  588. <span class="phpdocumentor-signature__type">int</span>
  589. <span class="phpdocumentor-signature__name">VERSION_AUTO</span>
  590. = <span class="phpdocumentor-signature__default-value">-1</span>
  591. </code>
  592. </article>
  593. </section>
  594. <section class="phpdocumentor-properties">
  595. <h3 class="phpdocumentor-elements__header" id="properties">
  596. Properties
  597. <a href="classes/chillerlan-QRCode-QRCode.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  598. </h3>
  599. <article
  600. class="
  601. phpdocumentor-element
  602. -property
  603. -protected
  604. "
  605. >
  606. <h4 class="phpdocumentor-element__name" id="property_dataInterface">
  607. $dataInterface
  608. <a href="classes/chillerlan-QRCode-QRCode.html#property_dataInterface" class="headerlink"><i class="fas fa-link"></i></a>
  609. <span class="phpdocumentor-element__modifiers">
  610. </span>
  611. </h4>
  612. <aside class="phpdocumentor-element-found-in">
  613. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  614. :
  615. <span class="phpdocumentor-element-found-in__line">94</span>
  616. </aside>
  617. <p class="phpdocumentor-summary">The selected data interface (Number, AlphaNum, Kanji, Byte)</p>
  618. <code class="phpdocumentor-code phpdocumentor-signature ">
  619. <span class="phpdocumentor-signature__visibility">protected</span>
  620. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRData.html"><abbr title="\chillerlan\QRCode\Data\QRData">QRData</abbr></a></span>
  621. <span class="phpdocumentor-signature__name">$dataInterface</span>
  622. </code>
  623. <section class="phpdocumentor-description"></section>
  624. </article>
  625. <article
  626. class="
  627. phpdocumentor-element
  628. -property
  629. -protected
  630. "
  631. >
  632. <h4 class="phpdocumentor-element__name" id="property_dataSegments">
  633. $dataSegments
  634. <a href="classes/chillerlan-QRCode-QRCode.html#property_dataSegments" class="headerlink"><i class="fas fa-link"></i></a>
  635. <span class="phpdocumentor-element__modifiers">
  636. </span>
  637. </h4>
  638. <aside class="phpdocumentor-element-found-in">
  639. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  640. :
  641. <span class="phpdocumentor-element-found-in__line">103</span>
  642. </aside>
  643. <p class="phpdocumentor-summary">A collection of one or more data segments of [classname, data] to write</p>
  644. <code class="phpdocumentor-code phpdocumentor-signature ">
  645. <span class="phpdocumentor-signature__visibility">protected</span>
  646. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  647. <span class="phpdocumentor-signature__name">$dataSegments</span>
  648. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  649. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  650. Tags
  651. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  652. </h5>
  653. <dl class="phpdocumentor-tag-list">
  654. <dt class="phpdocumentor-tag-list__entry">
  655. <span class="phpdocumentor-tag__name">see</span>
  656. </dt>
  657. <dd class="phpdocumentor-tag-list__definition">
  658. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeInterface">QRDataModeInterface</abbr></a></span>
  659. </dd>
  660. </dl>
  661. </article>
  662. <article
  663. class="
  664. phpdocumentor-element
  665. -property
  666. -protected
  667. "
  668. >
  669. <h4 class="phpdocumentor-element__name" id="property_options">
  670. $options
  671. <a href="classes/chillerlan-QRCode-QRCode.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  672. <span class="phpdocumentor-element__modifiers">
  673. </span>
  674. </h4>
  675. <aside class="phpdocumentor-element-found-in">
  676. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  677. :
  678. <span class="phpdocumentor-element-found-in__line">89</span>
  679. </aside>
  680. <p class="phpdocumentor-summary">The settings container</p>
  681. <code class="phpdocumentor-code phpdocumentor-signature ">
  682. <span class="phpdocumentor-signature__visibility">protected</span>
  683. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  684. <span class="phpdocumentor-signature__name">$options</span>
  685. </code>
  686. </article>
  687. <article
  688. class="
  689. phpdocumentor-element
  690. -property
  691. -private
  692. "
  693. >
  694. <h4 class="phpdocumentor-element__name" id="property_luminanceSourceClass">
  695. $luminanceSourceClass
  696. <a href="classes/chillerlan-QRCode-QRCode.html#property_luminanceSourceClass" class="headerlink"><i class="fas fa-link"></i></a>
  697. <span class="phpdocumentor-element__modifiers">
  698. </span>
  699. </h4>
  700. <aside class="phpdocumentor-element-found-in">
  701. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  702. :
  703. <span class="phpdocumentor-element-found-in__line">110</span>
  704. </aside>
  705. <p class="phpdocumentor-summary">The FQCN of the luminance sporce class to use in the reader (GD or Imagick)</p>
  706. <code class="phpdocumentor-code phpdocumentor-signature ">
  707. <span class="phpdocumentor-signature__visibility">private</span>
  708. <span class="phpdocumentor-signature__type">string</span>
  709. <span class="phpdocumentor-signature__name">$luminanceSourceClass</span>
  710. </code>
  711. <section class="phpdocumentor-description"></section>
  712. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  713. Tags
  714. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  715. </h5>
  716. <dl class="phpdocumentor-tag-list">
  717. <dt class="phpdocumentor-tag-list__entry">
  718. <span class="phpdocumentor-tag__name">see</span>
  719. </dt>
  720. <dd class="phpdocumentor-tag-list__definition">
  721. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceInterface.html"><abbr title="\chillerlan\QRCode\Decoder\LuminanceSourceInterface">LuminanceSourceInterface</abbr></a></span>
  722. </dd>
  723. </dl>
  724. </article>
  725. </section>
  726. <section class="phpdocumentor-methods">
  727. <h3 class="phpdocumentor-elements__header" id="methods">
  728. Methods
  729. <a href="classes/chillerlan-QRCode-QRCode.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  730. </h3>
  731. <article
  732. class="phpdocumentor-element
  733. -method
  734. -public
  735. "
  736. >
  737. <h4 class="phpdocumentor-element__name" id="method___construct">
  738. __construct()
  739. <a href="classes/chillerlan-QRCode-QRCode.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  740. </h4>
  741. <aside class="phpdocumentor-element-found-in">
  742. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  743. :
  744. <span class="phpdocumentor-element-found-in__line">117</span>
  745. </aside>
  746. <p class="phpdocumentor-summary">QRCode constructor.</p>
  747. <code class="phpdocumentor-code phpdocumentor-signature ">
  748. <span class="phpdocumentor-signature__visibility">public</span>
  749. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</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>
  750. <section class="phpdocumentor-description"><p>Sets the options instance</p>
  751. </section>
  752. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  753. <dl class="phpdocumentor-argument-list">
  754. <dt class="phpdocumentor-argument-list__entry">
  755. <span class="phpdocumentor-signature__argument__name">$options</span>
  756. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  757. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  758. <dd class="phpdocumentor-argument-list__definition">
  759. <section class="phpdocumentor-description"></section>
  760. </dd>
  761. </dl>
  762. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  763. <span class="phpdocumentor-signature__response_type">mixed</span>
  764. &mdash;
  765. </article>
  766. <article
  767. class="phpdocumentor-element
  768. -method
  769. -public
  770. "
  771. >
  772. <h4 class="phpdocumentor-element__name" id="method_addAlphaNumSegment">
  773. addAlphaNumSegment()
  774. <a href="classes/chillerlan-QRCode-QRCode.html#method_addAlphaNumSegment" class="headerlink"><i class="fas fa-link"></i></a>
  775. </h4>
  776. <aside class="phpdocumentor-element-found-in">
  777. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  778. :
  779. <span class="phpdocumentor-element-found-in__line">272</span>
  780. </aside>
  781. <p class="phpdocumentor-summary">ISO/IEC 18004:2000 8.3.3 - Alphanumeric Mode</p>
  782. <code class="phpdocumentor-code phpdocumentor-signature ">
  783. <span class="phpdocumentor-signature__visibility">public</span>
  784. <span class="phpdocumentor-signature__name">addAlphaNumSegment</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  785. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  786. <dl class="phpdocumentor-argument-list">
  787. <dt class="phpdocumentor-argument-list__entry">
  788. <span class="phpdocumentor-signature__argument__name">$data</span>
  789. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  790. </dt>
  791. <dd class="phpdocumentor-argument-list__definition">
  792. <section class="phpdocumentor-description"></section>
  793. </dd>
  794. </dl>
  795. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  796. <span class="phpdocumentor-signature__response_type">self</span>
  797. &mdash;
  798. </article>
  799. <article
  800. class="phpdocumentor-element
  801. -method
  802. -public
  803. "
  804. >
  805. <h4 class="phpdocumentor-element__name" id="method_addByteSegment">
  806. addByteSegment()
  807. <a href="classes/chillerlan-QRCode-QRCode.html#method_addByteSegment" class="headerlink"><i class="fas fa-link"></i></a>
  808. </h4>
  809. <aside class="phpdocumentor-element-found-in">
  810. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  811. :
  812. <span class="phpdocumentor-element-found-in__line">290</span>
  813. </aside>
  814. <p class="phpdocumentor-summary">ISO/IEC 18004:2000 8.3.4 - 8-bit Byte Mode</p>
  815. <code class="phpdocumentor-code phpdocumentor-signature ">
  816. <span class="phpdocumentor-signature__visibility">public</span>
  817. <span class="phpdocumentor-signature__name">addByteSegment</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  818. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  819. <dl class="phpdocumentor-argument-list">
  820. <dt class="phpdocumentor-argument-list__entry">
  821. <span class="phpdocumentor-signature__argument__name">$data</span>
  822. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  823. </dt>
  824. <dd class="phpdocumentor-argument-list__definition">
  825. <section class="phpdocumentor-description"></section>
  826. </dd>
  827. </dl>
  828. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  829. <span class="phpdocumentor-signature__response_type">self</span>
  830. &mdash;
  831. </article>
  832. <article
  833. class="phpdocumentor-element
  834. -method
  835. -public
  836. "
  837. >
  838. <h4 class="phpdocumentor-element__name" id="method_addEciDesignator">
  839. addEciDesignator()
  840. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciDesignator" class="headerlink"><i class="fas fa-link"></i></a>
  841. </h4>
  842. <aside class="phpdocumentor-element-found-in">
  843. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  844. :
  845. <span class="phpdocumentor-element-found-in__line">299</span>
  846. </aside>
  847. <p class="phpdocumentor-summary">ISO/IEC 18004:2000 8.3.1 - Extended Channel Interpretation (ECI) Mode</p>
  848. <code class="phpdocumentor-code phpdocumentor-signature ">
  849. <span class="phpdocumentor-signature__visibility">public</span>
  850. <span class="phpdocumentor-signature__name">addEciDesignator</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$encoding</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  851. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  852. <dl class="phpdocumentor-argument-list">
  853. <dt class="phpdocumentor-argument-list__entry">
  854. <span class="phpdocumentor-signature__argument__name">$encoding</span>
  855. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  856. </dt>
  857. <dd class="phpdocumentor-argument-list__definition">
  858. <section class="phpdocumentor-description"></section>
  859. </dd>
  860. </dl>
  861. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  862. <span class="phpdocumentor-signature__response_type">self</span>
  863. &mdash;
  864. </article>
  865. <article
  866. class="phpdocumentor-element
  867. -method
  868. -public
  869. "
  870. >
  871. <h4 class="phpdocumentor-element__name" id="method_addEciSegment">
  872. addEciSegment()
  873. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciSegment" class="headerlink"><i class="fas fa-link"></i></a>
  874. </h4>
  875. <aside class="phpdocumentor-element-found-in">
  876. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  877. :
  878. <span class="phpdocumentor-element-found-in__line">310</span>
  879. </aside>
  880. <p class="phpdocumentor-summary">i hate this somehow but i&#039;ll leave it for now</p>
  881. <code class="phpdocumentor-code phpdocumentor-signature ">
  882. <span class="phpdocumentor-signature__visibility">public</span>
  883. <span class="phpdocumentor-signature__name">addEciSegment</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$encoding</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">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  884. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  885. <dl class="phpdocumentor-argument-list">
  886. <dt class="phpdocumentor-argument-list__entry">
  887. <span class="phpdocumentor-signature__argument__name">$encoding</span>
  888. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  889. </dt>
  890. <dd class="phpdocumentor-argument-list__definition">
  891. <section class="phpdocumentor-description"></section>
  892. </dd>
  893. <dt class="phpdocumentor-argument-list__entry">
  894. <span class="phpdocumentor-signature__argument__name">$data</span>
  895. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  896. </dt>
  897. <dd class="phpdocumentor-argument-list__definition">
  898. <section class="phpdocumentor-description"></section>
  899. </dd>
  900. </dl>
  901. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  902. Tags
  903. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  904. </h5>
  905. <dl class="phpdocumentor-tag-list">
  906. <dt class="phpdocumentor-tag-list__entry">
  907. <span class="phpdocumentor-tag__name">throws</span>
  908. </dt>
  909. <dd class="phpdocumentor-tag-list__definition">
  910. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  911. </dd>
  912. </dl>
  913. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  914. <span class="phpdocumentor-signature__response_type">self</span>
  915. &mdash;
  916. </article>
  917. <article
  918. class="phpdocumentor-element
  919. -method
  920. -public
  921. "
  922. >
  923. <h4 class="phpdocumentor-element__name" id="method_addKanjiSegment">
  924. addKanjiSegment()
  925. <a href="classes/chillerlan-QRCode-QRCode.html#method_addKanjiSegment" class="headerlink"><i class="fas fa-link"></i></a>
  926. </h4>
  927. <aside class="phpdocumentor-element-found-in">
  928. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  929. :
  930. <span class="phpdocumentor-element-found-in__line">281</span>
  931. </aside>
  932. <p class="phpdocumentor-summary">ISO/IEC 18004:2000 8.3.5 - Kanji Mode</p>
  933. <code class="phpdocumentor-code phpdocumentor-signature ">
  934. <span class="phpdocumentor-signature__visibility">public</span>
  935. <span class="phpdocumentor-signature__name">addKanjiSegment</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  936. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  937. <dl class="phpdocumentor-argument-list">
  938. <dt class="phpdocumentor-argument-list__entry">
  939. <span class="phpdocumentor-signature__argument__name">$data</span>
  940. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  941. </dt>
  942. <dd class="phpdocumentor-argument-list__definition">
  943. <section class="phpdocumentor-description"></section>
  944. </dd>
  945. </dl>
  946. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  947. <span class="phpdocumentor-signature__response_type">self</span>
  948. &mdash;
  949. </article>
  950. <article
  951. class="phpdocumentor-element
  952. -method
  953. -public
  954. "
  955. >
  956. <h4 class="phpdocumentor-element__name" id="method_addNumberSegment">
  957. addNumberSegment()
  958. <a href="classes/chillerlan-QRCode-QRCode.html#method_addNumberSegment" class="headerlink"><i class="fas fa-link"></i></a>
  959. </h4>
  960. <aside class="phpdocumentor-element-found-in">
  961. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  962. :
  963. <span class="phpdocumentor-element-found-in__line">263</span>
  964. </aside>
  965. <p class="phpdocumentor-summary">ISO/IEC 18004:2000 8.3.2 - Numeric Mode</p>
  966. <code class="phpdocumentor-code phpdocumentor-signature ">
  967. <span class="phpdocumentor-signature__visibility">public</span>
  968. <span class="phpdocumentor-signature__name">addNumberSegment</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  969. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  970. <dl class="phpdocumentor-argument-list">
  971. <dt class="phpdocumentor-argument-list__entry">
  972. <span class="phpdocumentor-signature__argument__name">$data</span>
  973. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  974. </dt>
  975. <dd class="phpdocumentor-argument-list__definition">
  976. <section class="phpdocumentor-description"></section>
  977. </dd>
  978. </dl>
  979. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  980. <span class="phpdocumentor-signature__response_type">self</span>
  981. &mdash;
  982. </article>
  983. <article
  984. class="phpdocumentor-element
  985. -method
  986. -public
  987. "
  988. >
  989. <h4 class="phpdocumentor-element__name" id="method_clearSegments">
  990. clearSegments()
  991. <a href="classes/chillerlan-QRCode-QRCode.html#method_clearSegments" class="headerlink"><i class="fas fa-link"></i></a>
  992. </h4>
  993. <aside class="phpdocumentor-element-found-in">
  994. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  995. :
  996. <span class="phpdocumentor-element-found-in__line">254</span>
  997. </aside>
  998. <p class="phpdocumentor-summary">Clears the data segments array</p>
  999. <code class="phpdocumentor-code phpdocumentor-signature ">
  1000. <span class="phpdocumentor-signature__visibility">public</span>
  1001. <span class="phpdocumentor-signature__name">clearSegments</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1002. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1003. <span class="phpdocumentor-signature__response_type">self</span>
  1004. &mdash;
  1005. </article>
  1006. <article
  1007. class="phpdocumentor-element
  1008. -method
  1009. -public
  1010. "
  1011. >
  1012. <h4 class="phpdocumentor-element__name" id="method_getMatrix">
  1013. getMatrix()
  1014. <a href="classes/chillerlan-QRCode-QRCode.html#method_getMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  1015. </h4>
  1016. <aside class="phpdocumentor-element-found-in">
  1017. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1018. :
  1019. <span class="phpdocumentor-element-found-in__line">153</span>
  1020. </aside>
  1021. <p class="phpdocumentor-summary">Returns a QRMatrix object for the given $data and current QROptions</p>
  1022. <code class="phpdocumentor-code phpdocumentor-signature ">
  1023. <span class="phpdocumentor-signature__visibility">public</span>
  1024. <span class="phpdocumentor-signature__name">getMatrix</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span></code>
  1025. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1026. Tags
  1027. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1028. </h5>
  1029. <dl class="phpdocumentor-tag-list">
  1030. <dt class="phpdocumentor-tag-list__entry">
  1031. <span class="phpdocumentor-tag__name">throws</span>
  1032. </dt>
  1033. <dd class="phpdocumentor-tag-list__definition">
  1034. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  1035. </dd>
  1036. </dl>
  1037. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1038. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  1039. &mdash;
  1040. </article>
  1041. <article
  1042. class="phpdocumentor-element
  1043. -method
  1044. -public
  1045. "
  1046. >
  1047. <h4 class="phpdocumentor-element__name" id="method_isAlphaNum">
  1048. isAlphaNum()
  1049. <a href="classes/chillerlan-QRCode-QRCode.html#method_isAlphaNum" class="headerlink"><i class="fas fa-link"></i></a>
  1050. </h4>
  1051. <aside class="phpdocumentor-element-found-in">
  1052. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1053. :
  1054. <span class="phpdocumentor-element-found-in__line">225</span>
  1055. </aside>
  1056. <p class="phpdocumentor-summary">checks if a string qualifies as alphanumeric (convenience method)</p>
  1057. <code class="phpdocumentor-code phpdocumentor-signature ">
  1058. <span class="phpdocumentor-signature__visibility">public</span>
  1059. <span class="phpdocumentor-signature__name">isAlphaNum</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1060. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1061. <dl class="phpdocumentor-argument-list">
  1062. <dt class="phpdocumentor-argument-list__entry">
  1063. <span class="phpdocumentor-signature__argument__name">$string</span>
  1064. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1065. </dt>
  1066. <dd class="phpdocumentor-argument-list__definition">
  1067. <section class="phpdocumentor-description"></section>
  1068. </dd>
  1069. </dl>
  1070. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1071. <span class="phpdocumentor-signature__response_type">bool</span>
  1072. &mdash;
  1073. </article>
  1074. <article
  1075. class="phpdocumentor-element
  1076. -method
  1077. -public
  1078. "
  1079. >
  1080. <h4 class="phpdocumentor-element__name" id="method_isByte">
  1081. isByte()
  1082. <a href="classes/chillerlan-QRCode-QRCode.html#method_isByte" class="headerlink"><i class="fas fa-link"></i></a>
  1083. </h4>
  1084. <aside class="phpdocumentor-element-found-in">
  1085. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1086. :
  1087. <span class="phpdocumentor-element-found-in__line">239</span>
  1088. </aside>
  1089. <p class="phpdocumentor-summary">a dummy (convenience method)</p>
  1090. <code class="phpdocumentor-code phpdocumentor-signature ">
  1091. <span class="phpdocumentor-signature__visibility">public</span>
  1092. <span class="phpdocumentor-signature__name">isByte</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1093. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1094. <dl class="phpdocumentor-argument-list">
  1095. <dt class="phpdocumentor-argument-list__entry">
  1096. <span class="phpdocumentor-signature__argument__name">$string</span>
  1097. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1098. </dt>
  1099. <dd class="phpdocumentor-argument-list__definition">
  1100. <section class="phpdocumentor-description"></section>
  1101. </dd>
  1102. </dl>
  1103. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1104. <span class="phpdocumentor-signature__response_type">bool</span>
  1105. &mdash;
  1106. </article>
  1107. <article
  1108. class="phpdocumentor-element
  1109. -method
  1110. -public
  1111. "
  1112. >
  1113. <h4 class="phpdocumentor-element__name" id="method_isKanji">
  1114. isKanji()
  1115. <a href="classes/chillerlan-QRCode-QRCode.html#method_isKanji" class="headerlink"><i class="fas fa-link"></i></a>
  1116. </h4>
  1117. <aside class="phpdocumentor-element-found-in">
  1118. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1119. :
  1120. <span class="phpdocumentor-element-found-in__line">232</span>
  1121. </aside>
  1122. <p class="phpdocumentor-summary">checks if a string qualifies as Kanji (convenience method)</p>
  1123. <code class="phpdocumentor-code phpdocumentor-signature ">
  1124. <span class="phpdocumentor-signature__visibility">public</span>
  1125. <span class="phpdocumentor-signature__name">isKanji</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1126. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1127. <dl class="phpdocumentor-argument-list">
  1128. <dt class="phpdocumentor-argument-list__entry">
  1129. <span class="phpdocumentor-signature__argument__name">$string</span>
  1130. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1131. </dt>
  1132. <dd class="phpdocumentor-argument-list__definition">
  1133. <section class="phpdocumentor-description"></section>
  1134. </dd>
  1135. </dl>
  1136. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1137. <span class="phpdocumentor-signature__response_type">bool</span>
  1138. &mdash;
  1139. </article>
  1140. <article
  1141. class="phpdocumentor-element
  1142. -method
  1143. -public
  1144. "
  1145. >
  1146. <h4 class="phpdocumentor-element__name" id="method_isNumber">
  1147. isNumber()
  1148. <a href="classes/chillerlan-QRCode-QRCode.html#method_isNumber" class="headerlink"><i class="fas fa-link"></i></a>
  1149. </h4>
  1150. <aside class="phpdocumentor-element-found-in">
  1151. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1152. :
  1153. <span class="phpdocumentor-element-found-in__line">218</span>
  1154. </aside>
  1155. <p class="phpdocumentor-summary">checks if a string qualifies as numeric (convenience method)</p>
  1156. <code class="phpdocumentor-code phpdocumentor-signature ">
  1157. <span class="phpdocumentor-signature__visibility">public</span>
  1158. <span class="phpdocumentor-signature__name">isNumber</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
  1159. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1160. <dl class="phpdocumentor-argument-list">
  1161. <dt class="phpdocumentor-argument-list__entry">
  1162. <span class="phpdocumentor-signature__argument__name">$string</span>
  1163. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1164. </dt>
  1165. <dd class="phpdocumentor-argument-list__definition">
  1166. <section class="phpdocumentor-description"></section>
  1167. </dd>
  1168. </dl>
  1169. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1170. <span class="phpdocumentor-signature__response_type">bool</span>
  1171. &mdash;
  1172. </article>
  1173. <article
  1174. class="phpdocumentor-element
  1175. -method
  1176. -public
  1177. "
  1178. >
  1179. <h4 class="phpdocumentor-element__name" id="method_readFromBlob">
  1180. readFromBlob()
  1181. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromBlob" class="headerlink"><i class="fas fa-link"></i></a>
  1182. </h4>
  1183. <aside class="phpdocumentor-element-found-in">
  1184. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1185. :
  1186. <span class="phpdocumentor-element-found-in__line">339</span>
  1187. </aside>
  1188. <p class="phpdocumentor-summary">Reads a QR Code from the given data blob</p>
  1189. <code class="phpdocumentor-code phpdocumentor-signature ">
  1190. <span class="phpdocumentor-signature__visibility">public</span>
  1191. <span class="phpdocumentor-signature__name">readFromBlob</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$blob</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span></code>
  1192. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1193. <dl class="phpdocumentor-argument-list">
  1194. <dt class="phpdocumentor-argument-list__entry">
  1195. <span class="phpdocumentor-signature__argument__name">$blob</span>
  1196. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1197. </dt>
  1198. <dd class="phpdocumentor-argument-list__definition">
  1199. <section class="phpdocumentor-description"></section>
  1200. </dd>
  1201. </dl>
  1202. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1203. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  1204. &mdash;
  1205. </article>
  1206. <article
  1207. class="phpdocumentor-element
  1208. -method
  1209. -public
  1210. "
  1211. >
  1212. <h4 class="phpdocumentor-element__name" id="method_readFromFile">
  1213. readFromFile()
  1214. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromFile" class="headerlink"><i class="fas fa-link"></i></a>
  1215. </h4>
  1216. <aside class="phpdocumentor-element-found-in">
  1217. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1218. :
  1219. <span class="phpdocumentor-element-found-in__line">331</span>
  1220. </aside>
  1221. <p class="phpdocumentor-summary">Reads a QR Code from a given file</p>
  1222. <code class="phpdocumentor-code phpdocumentor-signature ">
  1223. <span class="phpdocumentor-signature__visibility">public</span>
  1224. <span class="phpdocumentor-signature__name">readFromFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$path</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span></code>
  1225. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1226. <dl class="phpdocumentor-argument-list">
  1227. <dt class="phpdocumentor-argument-list__entry">
  1228. <span class="phpdocumentor-signature__argument__name">$path</span>
  1229. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1230. </dt>
  1231. <dd class="phpdocumentor-argument-list__definition">
  1232. <section class="phpdocumentor-description"></section>
  1233. </dd>
  1234. </dl>
  1235. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1236. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  1237. &mdash;
  1238. </article>
  1239. <article
  1240. class="phpdocumentor-element
  1241. -method
  1242. -public
  1243. "
  1244. >
  1245. <h4 class="phpdocumentor-element__name" id="method_readFromSource">
  1246. readFromSource()
  1247. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromSource" class="headerlink"><i class="fas fa-link"></i></a>
  1248. </h4>
  1249. <aside class="phpdocumentor-element-found-in">
  1250. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1251. :
  1252. <span class="phpdocumentor-element-found-in__line">347</span>
  1253. </aside>
  1254. <p class="phpdocumentor-summary">Reads a QR Code from the given luminance source</p>
  1255. <code class="phpdocumentor-code phpdocumentor-signature ">
  1256. <span class="phpdocumentor-signature__visibility">public</span>
  1257. <span class="phpdocumentor-signature__name">readFromSource</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceInterface.html"><abbr title="\chillerlan\QRCode\Decoder\LuminanceSourceInterface">LuminanceSourceInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$source</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span></code>
  1258. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1259. <dl class="phpdocumentor-argument-list">
  1260. <dt class="phpdocumentor-argument-list__entry">
  1261. <span class="phpdocumentor-signature__argument__name">$source</span>
  1262. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Decoder-LuminanceSourceInterface.html"><abbr title="\chillerlan\QRCode\Decoder\LuminanceSourceInterface">LuminanceSourceInterface</abbr></a></span>
  1263. </dt>
  1264. <dd class="phpdocumentor-argument-list__definition">
  1265. <section class="phpdocumentor-description"></section>
  1266. </dd>
  1267. </dl>
  1268. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1269. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  1270. &mdash;
  1271. </article>
  1272. <article
  1273. class="phpdocumentor-element
  1274. -method
  1275. -public
  1276. "
  1277. >
  1278. <h4 class="phpdocumentor-element__name" id="method_render">
  1279. render()
  1280. <a href="classes/chillerlan-QRCode-QRCode.html#method_render" class="headerlink"><i class="fas fa-link"></i></a>
  1281. </h4>
  1282. <aside class="phpdocumentor-element-found-in">
  1283. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1284. :
  1285. <span class="phpdocumentor-element-found-in__line">129</span>
  1286. </aside>
  1287. <p class="phpdocumentor-summary">Renders a QR Code for the given $data and QROptions</p>
  1288. <code class="phpdocumentor-code phpdocumentor-signature ">
  1289. <span class="phpdocumentor-signature__visibility">public</span>
  1290. <span class="phpdocumentor-signature__name">render</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">$data</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><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>
  1291. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1292. <dl class="phpdocumentor-argument-list">
  1293. <dt class="phpdocumentor-argument-list__entry">
  1294. <span class="phpdocumentor-signature__argument__name">$data</span>
  1295. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1296. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1297. <dd class="phpdocumentor-argument-list__definition">
  1298. <section class="phpdocumentor-description"></section>
  1299. </dd>
  1300. <dt class="phpdocumentor-argument-list__entry">
  1301. <span class="phpdocumentor-signature__argument__name">$file</span>
  1302. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1303. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1304. <dd class="phpdocumentor-argument-list__definition">
  1305. <section class="phpdocumentor-description"></section>
  1306. </dd>
  1307. </dl>
  1308. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1309. <span class="phpdocumentor-signature__response_type">mixed</span>
  1310. &mdash;
  1311. </article>
  1312. <article
  1313. class="phpdocumentor-element
  1314. -method
  1315. -protected
  1316. "
  1317. >
  1318. <h4 class="phpdocumentor-element__name" id="method_addSegment">
  1319. addSegment()
  1320. <a href="classes/chillerlan-QRCode-QRCode.html#method_addSegment" class="headerlink"><i class="fas fa-link"></i></a>
  1321. </h4>
  1322. <aside class="phpdocumentor-element-found-in">
  1323. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1324. :
  1325. <span class="phpdocumentor-element-found-in__line">247</span>
  1326. </aside>
  1327. <p class="phpdocumentor-summary">ISO/IEC 18004:2000 8.3.6 - Mixing modes
  1328. ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length</p>
  1329. <code class="phpdocumentor-code phpdocumentor-signature ">
  1330. <span class="phpdocumentor-signature__visibility">protected</span>
  1331. <span class="phpdocumentor-signature__name">addSegment</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeInterface">QRDataModeInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$segment</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1332. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1333. <dl class="phpdocumentor-argument-list">
  1334. <dt class="phpdocumentor-argument-list__entry">
  1335. <span class="phpdocumentor-signature__argument__name">$segment</span>
  1336. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeInterface">QRDataModeInterface</abbr></a></span>
  1337. </dt>
  1338. <dd class="phpdocumentor-argument-list__definition">
  1339. <section class="phpdocumentor-description"></section>
  1340. </dd>
  1341. </dl>
  1342. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1343. <span class="phpdocumentor-signature__response_type">void</span>
  1344. &mdash;
  1345. </article>
  1346. <article
  1347. class="phpdocumentor-element
  1348. -method
  1349. -protected
  1350. "
  1351. >
  1352. <h4 class="phpdocumentor-element__name" id="method_initCustomOutputInterface">
  1353. initCustomOutputInterface()
  1354. <a href="classes/chillerlan-QRCode-QRCode.html#method_initCustomOutputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  1355. </h4>
  1356. <aside class="phpdocumentor-element-found-in">
  1357. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1358. :
  1359. <span class="phpdocumentor-element-found-in__line">201</span>
  1360. </aside>
  1361. <p class="phpdocumentor-summary">initializes a custom output module after checking the existence of the class and if it implemnts the required interface</p>
  1362. <code class="phpdocumentor-code phpdocumentor-signature ">
  1363. <span class="phpdocumentor-signature__visibility">protected</span>
  1364. <span class="phpdocumentor-signature__name">initCustomOutputInterface</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></span></code>
  1365. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1366. Tags
  1367. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1368. </h5>
  1369. <dl class="phpdocumentor-tag-list">
  1370. <dt class="phpdocumentor-tag-list__entry">
  1371. <span class="phpdocumentor-tag__name">throws</span>
  1372. </dt>
  1373. <dd class="phpdocumentor-tag-list__definition">
  1374. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1375. </dd>
  1376. </dl>
  1377. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1378. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></span>
  1379. &mdash;
  1380. </article>
  1381. <article
  1382. class="phpdocumentor-element
  1383. -method
  1384. -protected
  1385. "
  1386. >
  1387. <h4 class="phpdocumentor-element__name" id="method_initOutputInterface">
  1388. initOutputInterface()
  1389. <a href="classes/chillerlan-QRCode-QRCode.html#method_initOutputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  1390. </h4>
  1391. <aside class="phpdocumentor-element-found-in">
  1392. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1393. :
  1394. <span class="phpdocumentor-element-found-in__line">179</span>
  1395. </aside>
  1396. <p class="phpdocumentor-summary">returns a fresh (built-in) QROutputInterface</p>
  1397. <code class="phpdocumentor-code phpdocumentor-signature ">
  1398. <span class="phpdocumentor-signature__visibility">protected</span>
  1399. <span class="phpdocumentor-signature__name">initOutputInterface</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></span></code>
  1400. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1401. Tags
  1402. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1403. </h5>
  1404. <dl class="phpdocumentor-tag-list">
  1405. <dt class="phpdocumentor-tag-list__entry">
  1406. <span class="phpdocumentor-tag__name">throws</span>
  1407. </dt>
  1408. <dd class="phpdocumentor-tag-list__definition">
  1409. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1410. </dd>
  1411. </dl>
  1412. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1413. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></span>
  1414. &mdash;
  1415. </article>
  1416. </section>
  1417. <script type="text/javascript">
  1418. function loadExternalCodeSnippets(line) {
  1419. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1420. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  1421. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  1422. var language = 'php';
  1423. var code = document.createElement('code');
  1424. code.className = 'language-' + language;
  1425. pre.textContent = '';
  1426. pre.setAttribute('data-line', line)
  1427. code.textContent = 'Loading…';
  1428. pre.appendChild(code);
  1429. var xhr = new XMLHttpRequest();
  1430. xhr.open('GET', src, true);
  1431. xhr.onreadystatechange = function () {
  1432. if (xhr.readyState == 4) {
  1433. if (xhr.status < 400 && xhr.responseText) {
  1434. code.textContent = xhr.responseText;
  1435. Prism.highlightElement(code);
  1436. }
  1437. else if (xhr.status >= 400) {
  1438. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1439. }
  1440. else {
  1441. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  1442. }
  1443. }
  1444. };
  1445. xhr.send(null);
  1446. });
  1447. }
  1448. var modals = document.querySelectorAll("[data-modal]");
  1449. modals.forEach(function (trigger) {
  1450. trigger.addEventListener("click", function (event) {
  1451. //event.preventDefault();
  1452. const modal = document.getElementById(trigger.dataset.modal);
  1453. modal.classList.add("phpdocumentor-modal__open");
  1454. loadExternalCodeSnippets(trigger.dataset.line)
  1455. const exits = modal.querySelectorAll("[data-exit-button]");
  1456. exits.forEach(function (exit) {
  1457. exit.addEventListener("click", function (event) {
  1458. event.preventDefault();
  1459. modal.classList.remove("phpdocumentor-modal__open");
  1460. });
  1461. });
  1462. });
  1463. });
  1464. </script>
  1465. </article>
  1466. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1467. <section class="phpdocumentor-search-results__dialog">
  1468. <header class="phpdocumentor-search-results__header">
  1469. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1470. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1471. </header>
  1472. <section class="phpdocumentor-search-results__body">
  1473. <ul class="phpdocumentor-search-results__entries"></ul>
  1474. </section>
  1475. </section>
  1476. </section>
  1477. </div>
  1478. </div>
  1479. <a href="classes/chillerlan-QRCode-QRCode.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1480. </main>
  1481. <script>
  1482. cssVars({});
  1483. </script>
  1484. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1485. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1486. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1487. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1488. </body>
  1489. </html>