chillerlan-QRCode-QRCode.html 132 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Documentation</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <base href="../">
  8. <link rel="icon" href="images/favicon.ico"/>
  9. <link rel="stylesheet" href="css/normalize.css">
  10. <link rel="stylesheet" href="css/base.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com">
  12. <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  13. <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
  14. <link rel="stylesheet" href="css/template.css">
  15. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
  16. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
  17. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
  18. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
  19. <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
  20. <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
  21. <script src="js/search.js"></script>
  22. <script defer src="js/searchIndex.js"></script>
  23. </head>
  24. <body id="top">
  25. <header class="phpdocumentor-header phpdocumentor-section">
  26. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  27. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  28. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  29. <i class="fas fa-bars"></i>
  30. </label>
  31. <section data-search-form class="phpdocumentor-search">
  32. <label>
  33. <span class="visually-hidden">Search for</span>
  34. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  35. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  36. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  37. </svg>
  38. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  39. </label>
  40. </section>
  41. <nav class="phpdocumentor-topnav">
  42. <ul class="phpdocumentor-topnav__menu">
  43. </ul>
  44. </nav>
  45. </header>
  46. <main class="phpdocumentor">
  47. <div class="phpdocumentor-section">
  48. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  49. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  50. Menu
  51. </label>
  52. <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
  53. <section class="phpdocumentor-sidebar__category">
  54. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  55. <h4 class="phpdocumentor-sidebar__root-namespace">
  56. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  57. </h4>
  58. <ul class="phpdocumentor-list">
  59. <li>
  60. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  61. </li>
  62. <li>
  63. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  64. </li>
  65. </ul>
  66. </section>
  67. <section class="phpdocumentor-sidebar__category">
  68. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  69. <h4 class="phpdocumentor-sidebar__root-namespace">
  70. <a href="packages/Application.html" class="">Application</a>
  71. </h4>
  72. </section>
  73. <section class="phpdocumentor-sidebar__category">
  74. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  75. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  76. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  77. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  78. </section>
  79. <section class="phpdocumentor-sidebar__category">
  80. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  81. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  82. </section>
  83. </aside>
  84. <div class="phpdocumentor-column -eight phpdocumentor-content">
  85. <ul class="phpdocumentor-breadcrumbs">
  86. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  87. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  88. </ul>
  89. <article class="phpdocumentor-element -class">
  90. <h2 class="phpdocumentor-content__title">
  91. QRCode
  92. <div class="phpdocumentor-element__package">
  93. in package
  94. <ul class="phpdocumentor-breadcrumbs">
  95. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  96. </ul>
  97. </div>
  98. </h2>
  99. <aside class="phpdocumentor-element-found-in">
  100. <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>
  101. :
  102. <span class="phpdocumentor-element-found-in__line">29</span>
  103. </aside>
  104. <p class="phpdocumentor-summary">Turns a text string into a Model 2 QR Code</p>
  105. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  106. Tags
  107. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  108. </h5>
  109. <dl class="phpdocumentor-tag-list">
  110. <dt class="phpdocumentor-tag-list__entry">
  111. <span class="phpdocumentor-tag__name">see</span>
  112. </dt>
  113. <dd class="phpdocumentor-tag-list__definition">
  114. <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>
  115. </dd>
  116. <dt class="phpdocumentor-tag-list__entry">
  117. <span class="phpdocumentor-tag__name">see</span>
  118. </dt>
  119. <dd class="phpdocumentor-tag-list__definition">
  120. <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>
  121. </dd>
  122. <dt class="phpdocumentor-tag-list__entry">
  123. <span class="phpdocumentor-tag__name">see</span>
  124. </dt>
  125. <dd class="phpdocumentor-tag-list__definition">
  126. <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>
  127. </dd>
  128. <dt class="phpdocumentor-tag-list__entry">
  129. <span class="phpdocumentor-tag__name">see</span>
  130. </dt>
  131. <dd class="phpdocumentor-tag-list__definition">
  132. <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>
  133. </dd>
  134. <dt class="phpdocumentor-tag-list__entry">
  135. <span class="phpdocumentor-tag__name">see</span>
  136. </dt>
  137. <dd class="phpdocumentor-tag-list__definition">
  138. <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>
  139. </dd>
  140. </dl>
  141. <h3 id="toc">
  142. Table of Contents
  143. <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
  144. </h3>
  145. <dl class="phpdocumentor-table-of-contents">
  146. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  147. <a href="classes/chillerlan-QRCode-QRCode.html#constant_ECC_H">ECC_H</a>
  148. <span>
  149. &nbsp;= \chillerlan\QRCode\Common\EccLevel::H </span>
  150. </dt>
  151. <dd></dd>
  152. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  153. <a href="classes/chillerlan-QRCode-QRCode.html#constant_ECC_L">ECC_L</a>
  154. <span>
  155. &nbsp;= \chillerlan\QRCode\Common\EccLevel::L </span>
  156. </dt>
  157. <dd></dd>
  158. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  159. <a href="classes/chillerlan-QRCode-QRCode.html#constant_ECC_M">ECC_M</a>
  160. <span>
  161. &nbsp;= \chillerlan\QRCode\Common\EccLevel::M </span>
  162. </dt>
  163. <dd></dd>
  164. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  165. <a href="classes/chillerlan-QRCode-QRCode.html#constant_ECC_Q">ECC_Q</a>
  166. <span>
  167. &nbsp;= \chillerlan\QRCode\Common\EccLevel::Q </span>
  168. </dt>
  169. <dd></dd>
  170. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  171. <a href="classes/chillerlan-QRCode-QRCode.html#constant_MASK_PATTERN_AUTO">MASK_PATTERN_AUTO</a>
  172. <span>
  173. &nbsp;= \chillerlan\QRCode\Common\MaskPattern::AUTO </span>
  174. </dt>
  175. <dd></dd>
  176. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  177. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_CUSTOM">OUTPUT_CUSTOM</a>
  178. <span>
  179. &nbsp;= \chillerlan\QRCode\Output\QROutputInterface::CUSTOM </span>
  180. </dt>
  181. <dd></dd>
  182. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  183. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_EPS">OUTPUT_EPS</a>
  184. <span>
  185. &nbsp;= \chillerlan\QRCode\Output\QROutputInterface::EPS </span>
  186. </dt>
  187. <dd></dd>
  188. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  189. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_FPDF">OUTPUT_FPDF</a>
  190. <span>
  191. &nbsp;= \chillerlan\QRCode\Output\QROutputInterface::FPDF </span>
  192. </dt>
  193. <dd></dd>
  194. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  195. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_GIF">OUTPUT_IMAGE_GIF</a>
  196. <span>
  197. &nbsp;= \chillerlan\QRCode\Output\QROutputInterface::GDIMAGE_GIF </span>
  198. </dt>
  199. <dd></dd>
  200. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  201. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_JPG">OUTPUT_IMAGE_JPG</a>
  202. <span>
  203. &nbsp;= \chillerlan\QRCode\Output\QROutputInterface::GDIMAGE_JPG </span>
  204. </dt>
  205. <dd></dd>
  206. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  207. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_PNG">OUTPUT_IMAGE_PNG</a>
  208. <span>
  209. &nbsp;= \chillerlan\QRCode\Output\QROutputInterface::GDIMAGE_PNG </span>
  210. </dt>
  211. <dd></dd>
  212. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  213. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGICK">OUTPUT_IMAGICK</a>
  214. <span>
  215. &nbsp;= \chillerlan\QRCode\Output\QROutputInterface::IMAGICK </span>
  216. </dt>
  217. <dd></dd>
  218. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  219. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MARKUP_HTML">OUTPUT_MARKUP_HTML</a>
  220. <span>
  221. &nbsp;= \chillerlan\QRCode\Output\QROutputInterface::MARKUP_HTML </span>
  222. </dt>
  223. <dd></dd>
  224. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  225. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MARKUP_SVG">OUTPUT_MARKUP_SVG</a>
  226. <span>
  227. &nbsp;= \chillerlan\QRCode\Output\QROutputInterface::MARKUP_SVG </span>
  228. </dt>
  229. <dd></dd>
  230. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  231. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MODES">OUTPUT_MODES</a>
  232. <span>
  233. &nbsp;= \chillerlan\QRCode\Output\QROutputInterface::MODES </span>
  234. </dt>
  235. <dd></dd>
  236. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  237. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_STRING_JSON">OUTPUT_STRING_JSON</a>
  238. <span>
  239. &nbsp;= \chillerlan\QRCode\Output\QROutputInterface::STRING_JSON </span>
  240. </dt>
  241. <dd></dd>
  242. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  243. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_STRING_TEXT">OUTPUT_STRING_TEXT</a>
  244. <span>
  245. &nbsp;= \chillerlan\QRCode\Output\QROutputInterface::STRING_TEXT </span>
  246. </dt>
  247. <dd></dd>
  248. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  249. <a href="classes/chillerlan-QRCode-QRCode.html#constant_VERSION_AUTO">VERSION_AUTO</a>
  250. <span>
  251. &nbsp;= \chillerlan\QRCode\Common\Version::AUTO </span>
  252. </dt>
  253. <dd></dd>
  254. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  255. <a href="classes/chillerlan-QRCode-QRCode.html#property_dataSegments">$dataSegments</a>
  256. <span>
  257. &nbsp;: array&lt;string|int, mixed&gt; </span>
  258. </dt>
  259. <dd>A collection of one or more data segments of [classname, data] to write</dd>
  260. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  261. <a href="classes/chillerlan-QRCode-QRCode.html#property_luminanceSourceFQN">$luminanceSourceFQN</a>
  262. <span>
  263. &nbsp;: string </span>
  264. </dt>
  265. <dd>The luminance source for the reader</dd>
  266. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  267. <a href="classes/chillerlan-QRCode-QRCode.html#property_options">$options</a>
  268. <span>
  269. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  270. </dt>
  271. <dd>The settings container</dd>
  272. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  273. <a href="classes/chillerlan-QRCode-QRCode.html#method___construct">__construct()</a>
  274. <span>
  275. &nbsp;: mixed </span>
  276. </dt>
  277. <dd>QRCode constructor.</dd>
  278. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  279. <a href="classes/chillerlan-QRCode-QRCode.html#method_addAlphaNumSegment">addAlphaNumSegment()</a>
  280. <span>
  281. &nbsp;: self </span>
  282. </dt>
  283. <dd>Adds an alphanumeric data segment</dd>
  284. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  285. <a href="classes/chillerlan-QRCode-QRCode.html#method_addByteSegment">addByteSegment()</a>
  286. <span>
  287. &nbsp;: self </span>
  288. </dt>
  289. <dd>Adds an 8-bit byte data segment</dd>
  290. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  291. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciDesignator">addEciDesignator()</a>
  292. <span>
  293. &nbsp;: self </span>
  294. </dt>
  295. <dd>Adds a standalone ECI designator</dd>
  296. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  297. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciSegment">addEciSegment()</a>
  298. <span>
  299. &nbsp;: self </span>
  300. </dt>
  301. <dd>Adds an ECI data segment (including designator)</dd>
  302. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  303. <a href="classes/chillerlan-QRCode-QRCode.html#method_addKanjiSegment">addKanjiSegment()</a>
  304. <span>
  305. &nbsp;: self </span>
  306. </dt>
  307. <dd>Adds a Kanji data segment</dd>
  308. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  309. <a href="classes/chillerlan-QRCode-QRCode.html#method_addNumericSegment">addNumericSegment()</a>
  310. <span>
  311. &nbsp;: self </span>
  312. </dt>
  313. <dd>Adds a numeric data segment</dd>
  314. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  315. <a href="classes/chillerlan-QRCode-QRCode.html#method_clearSegments">clearSegments()</a>
  316. <span>
  317. &nbsp;: self </span>
  318. </dt>
  319. <dd>Clears the data segments array</dd>
  320. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  321. <a href="classes/chillerlan-QRCode-QRCode.html#method_getMatrix">getMatrix()</a>
  322. <span>
  323. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  324. </dt>
  325. <dd>Returns a QRMatrix object for the given $data and current QROptions</dd>
  326. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  327. <a href="classes/chillerlan-QRCode-QRCode.html#method_isAlphaNum">isAlphaNum()</a>
  328. <span>
  329. &nbsp;: bool </span>
  330. </dt>
  331. <dd>checks if a string qualifies as alphanumeric (convenience method)</dd>
  332. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  333. <a href="classes/chillerlan-QRCode-QRCode.html#method_isByte">isByte()</a>
  334. <span>
  335. &nbsp;: bool </span>
  336. </dt>
  337. <dd>a dummy (convenience method)</dd>
  338. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  339. <a href="classes/chillerlan-QRCode-QRCode.html#method_isKanji">isKanji()</a>
  340. <span>
  341. &nbsp;: bool </span>
  342. </dt>
  343. <dd>checks if a string qualifies as Kanji (convenience method)</dd>
  344. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  345. <a href="classes/chillerlan-QRCode-QRCode.html#method_isNumber">isNumber()</a>
  346. <span>
  347. &nbsp;: bool </span>
  348. </dt>
  349. <dd>checks if a string qualifies as numeric (convenience method)</dd>
  350. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  351. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromBlob">readFromBlob()</a>
  352. <span>
  353. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  354. </dt>
  355. <dd>Reads a QR Code from the given data blob</dd>
  356. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  357. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromFile">readFromFile()</a>
  358. <span>
  359. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  360. </dt>
  361. <dd>Reads a QR Code from a given file</dd>
  362. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  363. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromSource">readFromSource()</a>
  364. <span>
  365. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  366. </dt>
  367. <dd>Reads a QR Code from the given luminance source</dd>
  368. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  369. <a href="classes/chillerlan-QRCode-QRCode.html#method_render">render()</a>
  370. <span>
  371. &nbsp;: mixed </span>
  372. </dt>
  373. <dd>Renders a QR Code for the given $data and QROptions, saves $file optionally</dd>
  374. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  375. <a href="classes/chillerlan-QRCode-QRCode.html#method_addSegment">addSegment()</a>
  376. <span>
  377. &nbsp;: void </span>
  378. </dt>
  379. <dd>Adds a data segment</dd>
  380. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  381. <a href="classes/chillerlan-QRCode-QRCode.html#method_initCustomOutputInterface">initCustomOutputInterface()</a>
  382. <span>
  383. &nbsp;: <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a> </span>
  384. </dt>
  385. <dd>initializes a custom output module after checking the existence of the class and if it implemnts the required interface</dd>
  386. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  387. <a href="classes/chillerlan-QRCode-QRCode.html#method_initOutputInterface">initOutputInterface()</a>
  388. <span>
  389. &nbsp;: <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a> </span>
  390. </dt>
  391. <dd>returns a fresh (built-in) QROutputInterface</dd>
  392. </dl>
  393. <section class="phpdocumentor-constants">
  394. <h3 class="phpdocumentor-elements__header" id="constants">
  395. Constants
  396. <a href="classes/chillerlan-QRCode-QRCode.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  397. </h3>
  398. <article class="phpdocumentor-element -constant -public -deprecated">
  399. <h4 class="phpdocumentor-element__name" id="constant_ECC_H">
  400. ECC_H
  401. <a href="classes/chillerlan-QRCode-QRCode.html#constant_ECC_H" class="headerlink"><i class="fas fa-link"></i></a>
  402. </h4>
  403. <aside class="phpdocumentor-element-found-in">
  404. <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>
  405. :
  406. <span class="phpdocumentor-element-found-in__line">71</span>
  407. </aside>
  408. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  409. <span class="phpdocumentor-signature__visibility">public</span>
  410. <span class="phpdocumentor-signature__type">int</span>
  411. <span class="phpdocumentor-signature__name">ECC_H</span>
  412. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::H</span>
  413. </code>
  414. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  415. Tags
  416. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  417. </h5>
  418. <dl class="phpdocumentor-tag-list">
  419. <dt class="phpdocumentor-tag-list__entry">
  420. <span class="phpdocumentor-tag__name">deprecated</span>
  421. </dt>
  422. <dd class="phpdocumentor-tag-list__definition">
  423. <span class="phpdocumentor-tag-link">5.0.0</span>
  424. <section class="phpdocumentor-description"><p>use EccLevel::H instead</p>
  425. </section>
  426. </dd>
  427. <dt class="phpdocumentor-tag-list__entry">
  428. <span class="phpdocumentor-tag__name">see</span>
  429. </dt>
  430. <dd class="phpdocumentor-tag-list__definition">
  431. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-EccLevel.html#constant_H"><abbr title="\chillerlan\QRCode\Common\EccLevel::H">EccLevel::H</abbr></a></span>
  432. </dd>
  433. </dl>
  434. </article>
  435. <article class="phpdocumentor-element -constant -public -deprecated">
  436. <h4 class="phpdocumentor-element__name" id="constant_ECC_L">
  437. ECC_L
  438. <a href="classes/chillerlan-QRCode-QRCode.html#constant_ECC_L" class="headerlink"><i class="fas fa-link"></i></a>
  439. </h4>
  440. <aside class="phpdocumentor-element-found-in">
  441. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  442. :
  443. <span class="phpdocumentor-element-found-in__line">50</span>
  444. </aside>
  445. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  446. <span class="phpdocumentor-signature__visibility">public</span>
  447. <span class="phpdocumentor-signature__type">int</span>
  448. <span class="phpdocumentor-signature__name">ECC_L</span>
  449. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::L</span>
  450. </code>
  451. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  452. Tags
  453. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  454. </h5>
  455. <dl class="phpdocumentor-tag-list">
  456. <dt class="phpdocumentor-tag-list__entry">
  457. <span class="phpdocumentor-tag__name">deprecated</span>
  458. </dt>
  459. <dd class="phpdocumentor-tag-list__definition">
  460. <span class="phpdocumentor-tag-link">5.0.0</span>
  461. <section class="phpdocumentor-description"><p>use EccLevel::L instead</p>
  462. </section>
  463. </dd>
  464. <dt class="phpdocumentor-tag-list__entry">
  465. <span class="phpdocumentor-tag__name">see</span>
  466. </dt>
  467. <dd class="phpdocumentor-tag-list__definition">
  468. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-EccLevel.html#constant_L"><abbr title="\chillerlan\QRCode\Common\EccLevel::L">EccLevel::L</abbr></a></span>
  469. </dd>
  470. </dl>
  471. </article>
  472. <article class="phpdocumentor-element -constant -public -deprecated">
  473. <h4 class="phpdocumentor-element__name" id="constant_ECC_M">
  474. ECC_M
  475. <a href="classes/chillerlan-QRCode-QRCode.html#constant_ECC_M" class="headerlink"><i class="fas fa-link"></i></a>
  476. </h4>
  477. <aside class="phpdocumentor-element-found-in">
  478. <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>
  479. :
  480. <span class="phpdocumentor-element-found-in__line">57</span>
  481. </aside>
  482. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  483. <span class="phpdocumentor-signature__visibility">public</span>
  484. <span class="phpdocumentor-signature__type">int</span>
  485. <span class="phpdocumentor-signature__name">ECC_M</span>
  486. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::M</span>
  487. </code>
  488. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  489. Tags
  490. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  491. </h5>
  492. <dl class="phpdocumentor-tag-list">
  493. <dt class="phpdocumentor-tag-list__entry">
  494. <span class="phpdocumentor-tag__name">deprecated</span>
  495. </dt>
  496. <dd class="phpdocumentor-tag-list__definition">
  497. <span class="phpdocumentor-tag-link">5.0.0</span>
  498. <section class="phpdocumentor-description"><p>use EccLevel::M instead</p>
  499. </section>
  500. </dd>
  501. <dt class="phpdocumentor-tag-list__entry">
  502. <span class="phpdocumentor-tag__name">see</span>
  503. </dt>
  504. <dd class="phpdocumentor-tag-list__definition">
  505. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-EccLevel.html#constant_M"><abbr title="\chillerlan\QRCode\Common\EccLevel::M">EccLevel::M</abbr></a></span>
  506. </dd>
  507. </dl>
  508. </article>
  509. <article class="phpdocumentor-element -constant -public -deprecated">
  510. <h4 class="phpdocumentor-element__name" id="constant_ECC_Q">
  511. ECC_Q
  512. <a href="classes/chillerlan-QRCode-QRCode.html#constant_ECC_Q" class="headerlink"><i class="fas fa-link"></i></a>
  513. </h4>
  514. <aside class="phpdocumentor-element-found-in">
  515. <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>
  516. :
  517. <span class="phpdocumentor-element-found-in__line">64</span>
  518. </aside>
  519. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  520. <span class="phpdocumentor-signature__visibility">public</span>
  521. <span class="phpdocumentor-signature__type">int</span>
  522. <span class="phpdocumentor-signature__name">ECC_Q</span>
  523. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::Q</span>
  524. </code>
  525. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  526. Tags
  527. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  528. </h5>
  529. <dl class="phpdocumentor-tag-list">
  530. <dt class="phpdocumentor-tag-list__entry">
  531. <span class="phpdocumentor-tag__name">deprecated</span>
  532. </dt>
  533. <dd class="phpdocumentor-tag-list__definition">
  534. <span class="phpdocumentor-tag-link">5.0.0</span>
  535. <section class="phpdocumentor-description"><p>use EccLevel::Q instead</p>
  536. </section>
  537. </dd>
  538. <dt class="phpdocumentor-tag-list__entry">
  539. <span class="phpdocumentor-tag__name">see</span>
  540. </dt>
  541. <dd class="phpdocumentor-tag-list__definition">
  542. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-EccLevel.html#constant_Q"><abbr title="\chillerlan\QRCode\Common\EccLevel::Q">EccLevel::Q</abbr></a></span>
  543. </dd>
  544. </dl>
  545. </article>
  546. <article class="phpdocumentor-element -constant -public -deprecated">
  547. <h4 class="phpdocumentor-element__name" id="constant_MASK_PATTERN_AUTO">
  548. MASK_PATTERN_AUTO
  549. <a href="classes/chillerlan-QRCode-QRCode.html#constant_MASK_PATTERN_AUTO" class="headerlink"><i class="fas fa-link"></i></a>
  550. </h4>
  551. <aside class="phpdocumentor-element-found-in">
  552. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  553. :
  554. <span class="phpdocumentor-element-found-in__line">43</span>
  555. </aside>
  556. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  557. <span class="phpdocumentor-signature__visibility">public</span>
  558. <span class="phpdocumentor-signature__type">int</span>
  559. <span class="phpdocumentor-signature__name">MASK_PATTERN_AUTO</span>
  560. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\MaskPattern::AUTO</span>
  561. </code>
  562. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  563. Tags
  564. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  565. </h5>
  566. <dl class="phpdocumentor-tag-list">
  567. <dt class="phpdocumentor-tag-list__entry">
  568. <span class="phpdocumentor-tag__name">deprecated</span>
  569. </dt>
  570. <dd class="phpdocumentor-tag-list__definition">
  571. <span class="phpdocumentor-tag-link">5.0.0</span>
  572. <section class="phpdocumentor-description"><p>use MaskPattern::AUTO instead</p>
  573. </section>
  574. </dd>
  575. <dt class="phpdocumentor-tag-list__entry">
  576. <span class="phpdocumentor-tag__name">see</span>
  577. </dt>
  578. <dd class="phpdocumentor-tag-list__definition">
  579. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-MaskPattern.html#constant_AUTO"><abbr title="\chillerlan\QRCode\Common\MaskPattern::AUTO">MaskPattern::AUTO</abbr></a></span>
  580. </dd>
  581. </dl>
  582. </article>
  583. <article class="phpdocumentor-element -constant -public -deprecated">
  584. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_CUSTOM">
  585. OUTPUT_CUSTOM
  586. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_CUSTOM" class="headerlink"><i class="fas fa-link"></i></a>
  587. </h4>
  588. <aside class="phpdocumentor-element-found-in">
  589. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  590. :
  591. <span class="phpdocumentor-element-found-in__line">148</span>
  592. </aside>
  593. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  594. <span class="phpdocumentor-signature__visibility">public</span>
  595. <span class="phpdocumentor-signature__type">string</span>
  596. <span class="phpdocumentor-signature__name">OUTPUT_CUSTOM</span>
  597. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::CUSTOM</span>
  598. </code>
  599. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  600. Tags
  601. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  602. </h5>
  603. <dl class="phpdocumentor-tag-list">
  604. <dt class="phpdocumentor-tag-list__entry">
  605. <span class="phpdocumentor-tag__name">deprecated</span>
  606. </dt>
  607. <dd class="phpdocumentor-tag-list__definition">
  608. <span class="phpdocumentor-tag-link">5.0.0</span>
  609. <section class="phpdocumentor-description"><p>use QROutputInterface::CUSTOM instead</p>
  610. </section>
  611. </dd>
  612. <dt class="phpdocumentor-tag-list__entry">
  613. <span class="phpdocumentor-tag__name">see</span>
  614. </dt>
  615. <dd class="phpdocumentor-tag-list__definition">
  616. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_CUSTOM"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::CUSTOM">QROutputInterface::CUSTOM</abbr></a></span>
  617. </dd>
  618. </dl>
  619. </article>
  620. <article class="phpdocumentor-element -constant -public -deprecated">
  621. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_EPS">
  622. OUTPUT_EPS
  623. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_EPS" class="headerlink"><i class="fas fa-link"></i></a>
  624. </h4>
  625. <aside class="phpdocumentor-element-found-in">
  626. <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>
  627. :
  628. <span class="phpdocumentor-element-found-in__line">141</span>
  629. </aside>
  630. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  631. <span class="phpdocumentor-signature__visibility">public</span>
  632. <span class="phpdocumentor-signature__type">string</span>
  633. <span class="phpdocumentor-signature__name">OUTPUT_EPS</span>
  634. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::EPS</span>
  635. </code>
  636. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  637. Tags
  638. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  639. </h5>
  640. <dl class="phpdocumentor-tag-list">
  641. <dt class="phpdocumentor-tag-list__entry">
  642. <span class="phpdocumentor-tag__name">deprecated</span>
  643. </dt>
  644. <dd class="phpdocumentor-tag-list__definition">
  645. <span class="phpdocumentor-tag-link">5.0.0</span>
  646. <section class="phpdocumentor-description"><p>use QROutputInterface::EPS instead</p>
  647. </section>
  648. </dd>
  649. <dt class="phpdocumentor-tag-list__entry">
  650. <span class="phpdocumentor-tag__name">see</span>
  651. </dt>
  652. <dd class="phpdocumentor-tag-list__definition">
  653. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_EPS"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::EPS">QROutputInterface::EPS</abbr></a></span>
  654. </dd>
  655. </dl>
  656. </article>
  657. <article class="phpdocumentor-element -constant -public -deprecated">
  658. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_FPDF">
  659. OUTPUT_FPDF
  660. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_FPDF" class="headerlink"><i class="fas fa-link"></i></a>
  661. </h4>
  662. <aside class="phpdocumentor-element-found-in">
  663. <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>
  664. :
  665. <span class="phpdocumentor-element-found-in__line">134</span>
  666. </aside>
  667. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  668. <span class="phpdocumentor-signature__visibility">public</span>
  669. <span class="phpdocumentor-signature__type">string</span>
  670. <span class="phpdocumentor-signature__name">OUTPUT_FPDF</span>
  671. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::FPDF</span>
  672. </code>
  673. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  674. Tags
  675. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  676. </h5>
  677. <dl class="phpdocumentor-tag-list">
  678. <dt class="phpdocumentor-tag-list__entry">
  679. <span class="phpdocumentor-tag__name">deprecated</span>
  680. </dt>
  681. <dd class="phpdocumentor-tag-list__definition">
  682. <span class="phpdocumentor-tag-link">5.0.0</span>
  683. <section class="phpdocumentor-description"><p>use QROutputInterface::FPDF instead</p>
  684. </section>
  685. </dd>
  686. <dt class="phpdocumentor-tag-list__entry">
  687. <span class="phpdocumentor-tag__name">see</span>
  688. </dt>
  689. <dd class="phpdocumentor-tag-list__definition">
  690. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_FPDF"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::FPDF">QROutputInterface::FPDF</abbr></a></span>
  691. </dd>
  692. </dl>
  693. </article>
  694. <article class="phpdocumentor-element -constant -public -deprecated">
  695. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_IMAGE_GIF">
  696. OUTPUT_IMAGE_GIF
  697. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_GIF" class="headerlink"><i class="fas fa-link"></i></a>
  698. </h4>
  699. <aside class="phpdocumentor-element-found-in">
  700. <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>
  701. :
  702. <span class="phpdocumentor-element-found-in__line">106</span>
  703. </aside>
  704. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  705. <span class="phpdocumentor-signature__visibility">public</span>
  706. <span class="phpdocumentor-signature__type">string</span>
  707. <span class="phpdocumentor-signature__name">OUTPUT_IMAGE_GIF</span>
  708. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::GDIMAGE_GIF</span>
  709. </code>
  710. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  711. Tags
  712. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  713. </h5>
  714. <dl class="phpdocumentor-tag-list">
  715. <dt class="phpdocumentor-tag-list__entry">
  716. <span class="phpdocumentor-tag__name">deprecated</span>
  717. </dt>
  718. <dd class="phpdocumentor-tag-list__definition">
  719. <span class="phpdocumentor-tag-link">5.0.0</span>
  720. <section class="phpdocumentor-description"><p>use QROutputInterface::GDIMAGE_GIF instead</p>
  721. </section>
  722. </dd>
  723. <dt class="phpdocumentor-tag-list__entry">
  724. <span class="phpdocumentor-tag__name">see</span>
  725. </dt>
  726. <dd class="phpdocumentor-tag-list__definition">
  727. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_GIF"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::GDIMAGE_GIF">QROutputInterface::GDIMAGE_GIF</abbr></a></span>
  728. </dd>
  729. </dl>
  730. </article>
  731. <article class="phpdocumentor-element -constant -public -deprecated">
  732. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_IMAGE_JPG">
  733. OUTPUT_IMAGE_JPG
  734. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_JPG" class="headerlink"><i class="fas fa-link"></i></a>
  735. </h4>
  736. <aside class="phpdocumentor-element-found-in">
  737. <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>
  738. :
  739. <span class="phpdocumentor-element-found-in__line">99</span>
  740. </aside>
  741. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  742. <span class="phpdocumentor-signature__visibility">public</span>
  743. <span class="phpdocumentor-signature__type">string</span>
  744. <span class="phpdocumentor-signature__name">OUTPUT_IMAGE_JPG</span>
  745. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::GDIMAGE_JPG</span>
  746. </code>
  747. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  748. Tags
  749. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  750. </h5>
  751. <dl class="phpdocumentor-tag-list">
  752. <dt class="phpdocumentor-tag-list__entry">
  753. <span class="phpdocumentor-tag__name">deprecated</span>
  754. </dt>
  755. <dd class="phpdocumentor-tag-list__definition">
  756. <span class="phpdocumentor-tag-link">5.0.0</span>
  757. <section class="phpdocumentor-description"><p>use QROutputInterface::GDIMAGE_JPG instead</p>
  758. </section>
  759. </dd>
  760. <dt class="phpdocumentor-tag-list__entry">
  761. <span class="phpdocumentor-tag__name">see</span>
  762. </dt>
  763. <dd class="phpdocumentor-tag-list__definition">
  764. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_JPG"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::GDIMAGE_JPG">QROutputInterface::GDIMAGE_JPG</abbr></a></span>
  765. </dd>
  766. </dl>
  767. </article>
  768. <article class="phpdocumentor-element -constant -public -deprecated">
  769. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_IMAGE_PNG">
  770. OUTPUT_IMAGE_PNG
  771. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_PNG" class="headerlink"><i class="fas fa-link"></i></a>
  772. </h4>
  773. <aside class="phpdocumentor-element-found-in">
  774. <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>
  775. :
  776. <span class="phpdocumentor-element-found-in__line">92</span>
  777. </aside>
  778. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  779. <span class="phpdocumentor-signature__visibility">public</span>
  780. <span class="phpdocumentor-signature__type">string</span>
  781. <span class="phpdocumentor-signature__name">OUTPUT_IMAGE_PNG</span>
  782. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::GDIMAGE_PNG</span>
  783. </code>
  784. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  785. Tags
  786. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  787. </h5>
  788. <dl class="phpdocumentor-tag-list">
  789. <dt class="phpdocumentor-tag-list__entry">
  790. <span class="phpdocumentor-tag__name">deprecated</span>
  791. </dt>
  792. <dd class="phpdocumentor-tag-list__definition">
  793. <span class="phpdocumentor-tag-link">5.0.0</span>
  794. <section class="phpdocumentor-description"><p>use QROutputInterface::GDIMAGE_PNG instead</p>
  795. </section>
  796. </dd>
  797. <dt class="phpdocumentor-tag-list__entry">
  798. <span class="phpdocumentor-tag__name">see</span>
  799. </dt>
  800. <dd class="phpdocumentor-tag-list__definition">
  801. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_GDIMAGE_PNG"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::GDIMAGE_PNG">QROutputInterface::GDIMAGE_PNG</abbr></a></span>
  802. </dd>
  803. </dl>
  804. </article>
  805. <article class="phpdocumentor-element -constant -public -deprecated">
  806. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_IMAGICK">
  807. OUTPUT_IMAGICK
  808. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGICK" class="headerlink"><i class="fas fa-link"></i></a>
  809. </h4>
  810. <aside class="phpdocumentor-element-found-in">
  811. <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>
  812. :
  813. <span class="phpdocumentor-element-found-in__line">127</span>
  814. </aside>
  815. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  816. <span class="phpdocumentor-signature__visibility">public</span>
  817. <span class="phpdocumentor-signature__type">string</span>
  818. <span class="phpdocumentor-signature__name">OUTPUT_IMAGICK</span>
  819. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::IMAGICK</span>
  820. </code>
  821. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  822. Tags
  823. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  824. </h5>
  825. <dl class="phpdocumentor-tag-list">
  826. <dt class="phpdocumentor-tag-list__entry">
  827. <span class="phpdocumentor-tag__name">deprecated</span>
  828. </dt>
  829. <dd class="phpdocumentor-tag-list__definition">
  830. <span class="phpdocumentor-tag-link">5.0.0</span>
  831. <section class="phpdocumentor-description"><p>use QROutputInterface::IMAGICK instead</p>
  832. </section>
  833. </dd>
  834. <dt class="phpdocumentor-tag-list__entry">
  835. <span class="phpdocumentor-tag__name">see</span>
  836. </dt>
  837. <dd class="phpdocumentor-tag-list__definition">
  838. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_IMAGICK"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::IMAGICK">QROutputInterface::IMAGICK</abbr></a></span>
  839. </dd>
  840. </dl>
  841. </article>
  842. <article class="phpdocumentor-element -constant -public -deprecated">
  843. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_MARKUP_HTML">
  844. OUTPUT_MARKUP_HTML
  845. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MARKUP_HTML" class="headerlink"><i class="fas fa-link"></i></a>
  846. </h4>
  847. <aside class="phpdocumentor-element-found-in">
  848. <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>
  849. :
  850. <span class="phpdocumentor-element-found-in__line">78</span>
  851. </aside>
  852. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  853. <span class="phpdocumentor-signature__visibility">public</span>
  854. <span class="phpdocumentor-signature__type">string</span>
  855. <span class="phpdocumentor-signature__name">OUTPUT_MARKUP_HTML</span>
  856. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::MARKUP_HTML</span>
  857. </code>
  858. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  859. Tags
  860. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  861. </h5>
  862. <dl class="phpdocumentor-tag-list">
  863. <dt class="phpdocumentor-tag-list__entry">
  864. <span class="phpdocumentor-tag__name">deprecated</span>
  865. </dt>
  866. <dd class="phpdocumentor-tag-list__definition">
  867. <span class="phpdocumentor-tag-link">5.0.0</span>
  868. <section class="phpdocumentor-description"><p>use QROutputInterface::MARKUP_HTML instead</p>
  869. </section>
  870. </dd>
  871. <dt class="phpdocumentor-tag-list__entry">
  872. <span class="phpdocumentor-tag__name">see</span>
  873. </dt>
  874. <dd class="phpdocumentor-tag-list__definition">
  875. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MARKUP_HTML"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::MARKUP_HTML">QROutputInterface::MARKUP_HTML</abbr></a></span>
  876. </dd>
  877. </dl>
  878. </article>
  879. <article class="phpdocumentor-element -constant -public -deprecated">
  880. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_MARKUP_SVG">
  881. OUTPUT_MARKUP_SVG
  882. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MARKUP_SVG" class="headerlink"><i class="fas fa-link"></i></a>
  883. </h4>
  884. <aside class="phpdocumentor-element-found-in">
  885. <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>
  886. :
  887. <span class="phpdocumentor-element-found-in__line">85</span>
  888. </aside>
  889. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  890. <span class="phpdocumentor-signature__visibility">public</span>
  891. <span class="phpdocumentor-signature__type">string</span>
  892. <span class="phpdocumentor-signature__name">OUTPUT_MARKUP_SVG</span>
  893. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::MARKUP_SVG</span>
  894. </code>
  895. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  896. Tags
  897. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  898. </h5>
  899. <dl class="phpdocumentor-tag-list">
  900. <dt class="phpdocumentor-tag-list__entry">
  901. <span class="phpdocumentor-tag__name">deprecated</span>
  902. </dt>
  903. <dd class="phpdocumentor-tag-list__definition">
  904. <span class="phpdocumentor-tag-link">5.0.0</span>
  905. <section class="phpdocumentor-description"><p>use QROutputInterface::MARKUP_SVG instead</p>
  906. </section>
  907. </dd>
  908. <dt class="phpdocumentor-tag-list__entry">
  909. <span class="phpdocumentor-tag__name">see</span>
  910. </dt>
  911. <dd class="phpdocumentor-tag-list__definition">
  912. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MARKUP_SVG"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::MARKUP_SVG">QROutputInterface::MARKUP_SVG</abbr></a></span>
  913. </dd>
  914. </dl>
  915. </article>
  916. <article class="phpdocumentor-element -constant -public -deprecated">
  917. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_MODES">
  918. OUTPUT_MODES
  919. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MODES" class="headerlink"><i class="fas fa-link"></i></a>
  920. </h4>
  921. <aside class="phpdocumentor-element-found-in">
  922. <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>
  923. :
  924. <span class="phpdocumentor-element-found-in__line">155</span>
  925. </aside>
  926. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  927. <span class="phpdocumentor-signature__visibility">public</span>
  928. <span class="phpdocumentor-signature__type">array&lt;string|int, string&gt;</span>
  929. <span class="phpdocumentor-signature__name">OUTPUT_MODES</span>
  930. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::MODES</span>
  931. </code>
  932. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  933. Tags
  934. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  935. </h5>
  936. <dl class="phpdocumentor-tag-list">
  937. <dt class="phpdocumentor-tag-list__entry">
  938. <span class="phpdocumentor-tag__name">deprecated</span>
  939. </dt>
  940. <dd class="phpdocumentor-tag-list__definition">
  941. <span class="phpdocumentor-tag-link">5.0.0</span>
  942. <section class="phpdocumentor-description"><p>use QROutputInterface::MODES instead</p>
  943. </section>
  944. </dd>
  945. <dt class="phpdocumentor-tag-list__entry">
  946. <span class="phpdocumentor-tag__name">see</span>
  947. </dt>
  948. <dd class="phpdocumentor-tag-list__definition">
  949. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_MODES"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::MODES">QROutputInterface::MODES</abbr></a></span>
  950. </dd>
  951. </dl>
  952. </article>
  953. <article class="phpdocumentor-element -constant -public -deprecated">
  954. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_STRING_JSON">
  955. OUTPUT_STRING_JSON
  956. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_STRING_JSON" class="headerlink"><i class="fas fa-link"></i></a>
  957. </h4>
  958. <aside class="phpdocumentor-element-found-in">
  959. <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>
  960. :
  961. <span class="phpdocumentor-element-found-in__line">113</span>
  962. </aside>
  963. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  964. <span class="phpdocumentor-signature__visibility">public</span>
  965. <span class="phpdocumentor-signature__type">string</span>
  966. <span class="phpdocumentor-signature__name">OUTPUT_STRING_JSON</span>
  967. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::STRING_JSON</span>
  968. </code>
  969. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  970. Tags
  971. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  972. </h5>
  973. <dl class="phpdocumentor-tag-list">
  974. <dt class="phpdocumentor-tag-list__entry">
  975. <span class="phpdocumentor-tag__name">deprecated</span>
  976. </dt>
  977. <dd class="phpdocumentor-tag-list__definition">
  978. <span class="phpdocumentor-tag-link">5.0.0</span>
  979. <section class="phpdocumentor-description"><p>use QROutputInterface::STRING_JSON instead</p>
  980. </section>
  981. </dd>
  982. <dt class="phpdocumentor-tag-list__entry">
  983. <span class="phpdocumentor-tag__name">see</span>
  984. </dt>
  985. <dd class="phpdocumentor-tag-list__definition">
  986. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_STRING_JSON"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::STRING_JSON">QROutputInterface::STRING_JSON</abbr></a></span>
  987. </dd>
  988. </dl>
  989. </article>
  990. <article class="phpdocumentor-element -constant -public -deprecated">
  991. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_STRING_TEXT">
  992. OUTPUT_STRING_TEXT
  993. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_STRING_TEXT" class="headerlink"><i class="fas fa-link"></i></a>
  994. </h4>
  995. <aside class="phpdocumentor-element-found-in">
  996. <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>
  997. :
  998. <span class="phpdocumentor-element-found-in__line">120</span>
  999. </aside>
  1000. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  1001. <span class="phpdocumentor-signature__visibility">public</span>
  1002. <span class="phpdocumentor-signature__type">string</span>
  1003. <span class="phpdocumentor-signature__name">OUTPUT_STRING_TEXT</span>
  1004. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Output\QROutputInterface::STRING_TEXT</span>
  1005. </code>
  1006. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1007. Tags
  1008. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1009. </h5>
  1010. <dl class="phpdocumentor-tag-list">
  1011. <dt class="phpdocumentor-tag-list__entry">
  1012. <span class="phpdocumentor-tag__name">deprecated</span>
  1013. </dt>
  1014. <dd class="phpdocumentor-tag-list__definition">
  1015. <span class="phpdocumentor-tag-link">5.0.0</span>
  1016. <section class="phpdocumentor-description"><p>use QROutputInterface::STRING_TEXT instead</p>
  1017. </section>
  1018. </dd>
  1019. <dt class="phpdocumentor-tag-list__entry">
  1020. <span class="phpdocumentor-tag__name">see</span>
  1021. </dt>
  1022. <dd class="phpdocumentor-tag-list__definition">
  1023. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html#constant_STRING_TEXT"><abbr title="\chillerlan\QRCode\Output\QROutputInterface::STRING_TEXT">QROutputInterface::STRING_TEXT</abbr></a></span>
  1024. </dd>
  1025. </dl>
  1026. </article>
  1027. <article class="phpdocumentor-element -constant -public -deprecated">
  1028. <h4 class="phpdocumentor-element__name" id="constant_VERSION_AUTO">
  1029. VERSION_AUTO
  1030. <a href="classes/chillerlan-QRCode-QRCode.html#constant_VERSION_AUTO" class="headerlink"><i class="fas fa-link"></i></a>
  1031. </h4>
  1032. <aside class="phpdocumentor-element-found-in">
  1033. <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>
  1034. :
  1035. <span class="phpdocumentor-element-found-in__line">36</span>
  1036. </aside>
  1037. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  1038. <span class="phpdocumentor-signature__visibility">public</span>
  1039. <span class="phpdocumentor-signature__type">int</span>
  1040. <span class="phpdocumentor-signature__name">VERSION_AUTO</span>
  1041. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\Version::AUTO</span>
  1042. </code>
  1043. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1044. Tags
  1045. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1046. </h5>
  1047. <dl class="phpdocumentor-tag-list">
  1048. <dt class="phpdocumentor-tag-list__entry">
  1049. <span class="phpdocumentor-tag__name">deprecated</span>
  1050. </dt>
  1051. <dd class="phpdocumentor-tag-list__definition">
  1052. <span class="phpdocumentor-tag-link">5.0.0</span>
  1053. <section class="phpdocumentor-description"><p>use Version::AUTO instead</p>
  1054. </section>
  1055. </dd>
  1056. <dt class="phpdocumentor-tag-list__entry">
  1057. <span class="phpdocumentor-tag__name">see</span>
  1058. </dt>
  1059. <dd class="phpdocumentor-tag-list__definition">
  1060. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Common-Version.html#constant_AUTO"><abbr title="\chillerlan\QRCode\Common\Version::AUTO">Version::AUTO</abbr></a></span>
  1061. </dd>
  1062. </dl>
  1063. </article>
  1064. </section>
  1065. <section class="phpdocumentor-properties">
  1066. <h3 class="phpdocumentor-elements__header" id="properties">
  1067. Properties
  1068. <a href="classes/chillerlan-QRCode-QRCode.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  1069. </h3>
  1070. <article
  1071. class="
  1072. phpdocumentor-element
  1073. -property
  1074. -protected
  1075. "
  1076. >
  1077. <h4 class="phpdocumentor-element__name" id="property_dataSegments">
  1078. $dataSegments
  1079. <a href="classes/chillerlan-QRCode-QRCode.html#property_dataSegments" class="headerlink"><i class="fas fa-link"></i></a>
  1080. <span class="phpdocumentor-element__modifiers">
  1081. </span>
  1082. </h4>
  1083. <aside class="phpdocumentor-element-found-in">
  1084. <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>
  1085. :
  1086. <span class="phpdocumentor-element-found-in__line">171</span>
  1087. </aside>
  1088. <p class="phpdocumentor-summary">A collection of one or more data segments of [classname, data] to write</p>
  1089. <code class="phpdocumentor-code phpdocumentor-signature ">
  1090. <span class="phpdocumentor-signature__visibility">protected</span>
  1091. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  1092. <span class="phpdocumentor-signature__name">$dataSegments</span>
  1093. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  1094. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1095. Tags
  1096. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1097. </h5>
  1098. <dl class="phpdocumentor-tag-list">
  1099. <dt class="phpdocumentor-tag-list__entry">
  1100. <span class="phpdocumentor-tag__name">see</span>
  1101. </dt>
  1102. <dd class="phpdocumentor-tag-list__definition">
  1103. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeInterface">QRDataModeInterface</abbr></a></span>
  1104. </dd>
  1105. </dl>
  1106. </article>
  1107. <article
  1108. class="
  1109. phpdocumentor-element
  1110. -property
  1111. -protected
  1112. "
  1113. >
  1114. <h4 class="phpdocumentor-element__name" id="property_luminanceSourceFQN">
  1115. $luminanceSourceFQN
  1116. <a href="classes/chillerlan-QRCode-QRCode.html#property_luminanceSourceFQN" class="headerlink"><i class="fas fa-link"></i></a>
  1117. <span class="phpdocumentor-element__modifiers">
  1118. </span>
  1119. </h4>
  1120. <aside class="phpdocumentor-element-found-in">
  1121. <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>
  1122. :
  1123. <span class="phpdocumentor-element-found-in__line">176</span>
  1124. </aside>
  1125. <p class="phpdocumentor-summary">The luminance source for the reader</p>
  1126. <code class="phpdocumentor-code phpdocumentor-signature ">
  1127. <span class="phpdocumentor-signature__visibility">protected</span>
  1128. <span class="phpdocumentor-signature__type">string</span>
  1129. <span class="phpdocumentor-signature__name">$luminanceSourceFQN</span>
  1130. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Decoder\GDLuminanceSource::class</span></code>
  1131. <section class="phpdocumentor-description"></section>
  1132. </article>
  1133. <article
  1134. class="
  1135. phpdocumentor-element
  1136. -property
  1137. -protected
  1138. "
  1139. >
  1140. <h4 class="phpdocumentor-element__name" id="property_options">
  1141. $options
  1142. <a href="classes/chillerlan-QRCode-QRCode.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  1143. <span class="phpdocumentor-element__modifiers">
  1144. </span>
  1145. </h4>
  1146. <aside class="phpdocumentor-element-found-in">
  1147. <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>
  1148. :
  1149. <span class="phpdocumentor-element-found-in__line">162</span>
  1150. </aside>
  1151. <p class="phpdocumentor-summary">The settings container</p>
  1152. <code class="phpdocumentor-code phpdocumentor-signature ">
  1153. <span class="phpdocumentor-signature__visibility">protected</span>
  1154. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  1155. <span class="phpdocumentor-signature__name">$options</span>
  1156. </code>
  1157. </article>
  1158. </section>
  1159. <section class="phpdocumentor-methods">
  1160. <h3 class="phpdocumentor-elements__header" id="methods">
  1161. Methods
  1162. <a href="classes/chillerlan-QRCode-QRCode.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  1163. </h3>
  1164. <article
  1165. class="phpdocumentor-element
  1166. -method
  1167. -public
  1168. "
  1169. >
  1170. <h4 class="phpdocumentor-element__name" id="method___construct">
  1171. __construct()
  1172. <a href="classes/chillerlan-QRCode-QRCode.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  1173. </h4>
  1174. <aside class="phpdocumentor-element-found-in">
  1175. <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>
  1176. :
  1177. <span class="phpdocumentor-element-found-in__line">183</span>
  1178. </aside>
  1179. <p class="phpdocumentor-summary">QRCode constructor.</p>
  1180. <code class="phpdocumentor-code phpdocumentor-signature ">
  1181. <span class="phpdocumentor-signature__visibility">public</span>
  1182. <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>
  1183. <section class="phpdocumentor-description"><p>Sets the options instance</p>
  1184. </section>
  1185. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1186. <dl class="phpdocumentor-argument-list">
  1187. <dt class="phpdocumentor-argument-list__entry">
  1188. <span class="phpdocumentor-signature__argument__name">$options</span>
  1189. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  1190. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1191. <dd class="phpdocumentor-argument-list__definition">
  1192. <section class="phpdocumentor-description"></section>
  1193. </dd>
  1194. </dl>
  1195. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1196. <span class="phpdocumentor-signature__response_type">mixed</span>
  1197. &mdash;
  1198. </article>
  1199. <article
  1200. class="phpdocumentor-element
  1201. -method
  1202. -public
  1203. "
  1204. >
  1205. <h4 class="phpdocumentor-element__name" id="method_addAlphaNumSegment">
  1206. addAlphaNumSegment()
  1207. <a href="classes/chillerlan-QRCode-QRCode.html#method_addAlphaNumSegment" class="headerlink"><i class="fas fa-link"></i></a>
  1208. </h4>
  1209. <aside class="phpdocumentor-element-found-in">
  1210. <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>
  1211. :
  1212. <span class="phpdocumentor-element-found-in__line">367</span>
  1213. </aside>
  1214. <p class="phpdocumentor-summary">Adds an alphanumeric data segment</p>
  1215. <code class="phpdocumentor-code phpdocumentor-signature ">
  1216. <span class="phpdocumentor-signature__visibility">public</span>
  1217. <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>
  1218. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.3 - Alphanumeric Mode</p>
  1219. </section>
  1220. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1221. <dl class="phpdocumentor-argument-list">
  1222. <dt class="phpdocumentor-argument-list__entry">
  1223. <span class="phpdocumentor-signature__argument__name">$data</span>
  1224. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1225. </dt>
  1226. <dd class="phpdocumentor-argument-list__definition">
  1227. <section class="phpdocumentor-description"></section>
  1228. </dd>
  1229. </dl>
  1230. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1231. <span class="phpdocumentor-signature__response_type">self</span>
  1232. &mdash;
  1233. </article>
  1234. <article
  1235. class="phpdocumentor-element
  1236. -method
  1237. -public
  1238. "
  1239. >
  1240. <h4 class="phpdocumentor-element__name" id="method_addByteSegment">
  1241. addByteSegment()
  1242. <a href="classes/chillerlan-QRCode-QRCode.html#method_addByteSegment" class="headerlink"><i class="fas fa-link"></i></a>
  1243. </h4>
  1244. <aside class="phpdocumentor-element-found-in">
  1245. <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>
  1246. :
  1247. <span class="phpdocumentor-element-found-in__line">389</span>
  1248. </aside>
  1249. <p class="phpdocumentor-summary">Adds an 8-bit byte data segment</p>
  1250. <code class="phpdocumentor-code phpdocumentor-signature ">
  1251. <span class="phpdocumentor-signature__visibility">public</span>
  1252. <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>
  1253. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.4 - 8-bit Byte Mode</p>
  1254. </section>
  1255. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1256. <dl class="phpdocumentor-argument-list">
  1257. <dt class="phpdocumentor-argument-list__entry">
  1258. <span class="phpdocumentor-signature__argument__name">$data</span>
  1259. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1260. </dt>
  1261. <dd class="phpdocumentor-argument-list__definition">
  1262. <section class="phpdocumentor-description"></section>
  1263. </dd>
  1264. </dl>
  1265. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1266. <span class="phpdocumentor-signature__response_type">self</span>
  1267. &mdash;
  1268. </article>
  1269. <article
  1270. class="phpdocumentor-element
  1271. -method
  1272. -public
  1273. "
  1274. >
  1275. <h4 class="phpdocumentor-element__name" id="method_addEciDesignator">
  1276. addEciDesignator()
  1277. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciDesignator" class="headerlink"><i class="fas fa-link"></i></a>
  1278. </h4>
  1279. <aside class="phpdocumentor-element-found-in">
  1280. <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>
  1281. :
  1282. <span class="phpdocumentor-element-found-in__line">400</span>
  1283. </aside>
  1284. <p class="phpdocumentor-summary">Adds a standalone ECI designator</p>
  1285. <code class="phpdocumentor-code phpdocumentor-signature ">
  1286. <span class="phpdocumentor-signature__visibility">public</span>
  1287. <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>
  1288. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.1 - Extended Channel Interpretation (ECI) Mode</p>
  1289. </section>
  1290. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1291. <dl class="phpdocumentor-argument-list">
  1292. <dt class="phpdocumentor-argument-list__entry">
  1293. <span class="phpdocumentor-signature__argument__name">$encoding</span>
  1294. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1295. </dt>
  1296. <dd class="phpdocumentor-argument-list__definition">
  1297. <section class="phpdocumentor-description"></section>
  1298. </dd>
  1299. </dl>
  1300. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1301. <span class="phpdocumentor-signature__response_type">self</span>
  1302. &mdash;
  1303. </article>
  1304. <article
  1305. class="phpdocumentor-element
  1306. -method
  1307. -public
  1308. "
  1309. >
  1310. <h4 class="phpdocumentor-element__name" id="method_addEciSegment">
  1311. addEciSegment()
  1312. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciSegment" class="headerlink"><i class="fas fa-link"></i></a>
  1313. </h4>
  1314. <aside class="phpdocumentor-element-found-in">
  1315. <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>
  1316. :
  1317. <span class="phpdocumentor-element-found-in__line">413</span>
  1318. </aside>
  1319. <p class="phpdocumentor-summary">Adds an ECI data segment (including designator)</p>
  1320. <code class="phpdocumentor-code phpdocumentor-signature ">
  1321. <span class="phpdocumentor-signature__visibility">public</span>
  1322. <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>
  1323. <section class="phpdocumentor-description"><p>i hate this somehow but i'll leave it for now</p>
  1324. </section>
  1325. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1326. <dl class="phpdocumentor-argument-list">
  1327. <dt class="phpdocumentor-argument-list__entry">
  1328. <span class="phpdocumentor-signature__argument__name">$encoding</span>
  1329. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1330. </dt>
  1331. <dd class="phpdocumentor-argument-list__definition">
  1332. <section class="phpdocumentor-description"></section>
  1333. </dd>
  1334. <dt class="phpdocumentor-argument-list__entry">
  1335. <span class="phpdocumentor-signature__argument__name">$data</span>
  1336. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1337. </dt>
  1338. <dd class="phpdocumentor-argument-list__definition">
  1339. <section class="phpdocumentor-description"></section>
  1340. </dd>
  1341. </dl>
  1342. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1343. Tags
  1344. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1345. </h5>
  1346. <dl class="phpdocumentor-tag-list">
  1347. <dt class="phpdocumentor-tag-list__entry">
  1348. <span class="phpdocumentor-tag__name">throws</span>
  1349. </dt>
  1350. <dd class="phpdocumentor-tag-list__definition">
  1351. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  1352. </dd>
  1353. </dl>
  1354. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1355. <span class="phpdocumentor-signature__response_type">self</span>
  1356. &mdash;
  1357. </article>
  1358. <article
  1359. class="phpdocumentor-element
  1360. -method
  1361. -public
  1362. "
  1363. >
  1364. <h4 class="phpdocumentor-element__name" id="method_addKanjiSegment">
  1365. addKanjiSegment()
  1366. <a href="classes/chillerlan-QRCode-QRCode.html#method_addKanjiSegment" class="headerlink"><i class="fas fa-link"></i></a>
  1367. </h4>
  1368. <aside class="phpdocumentor-element-found-in">
  1369. <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>
  1370. :
  1371. <span class="phpdocumentor-element-found-in__line">378</span>
  1372. </aside>
  1373. <p class="phpdocumentor-summary">Adds a Kanji data segment</p>
  1374. <code class="phpdocumentor-code phpdocumentor-signature ">
  1375. <span class="phpdocumentor-signature__visibility">public</span>
  1376. <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>
  1377. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.5 - Kanji Mode</p>
  1378. </section>
  1379. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1380. <dl class="phpdocumentor-argument-list">
  1381. <dt class="phpdocumentor-argument-list__entry">
  1382. <span class="phpdocumentor-signature__argument__name">$data</span>
  1383. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1384. </dt>
  1385. <dd class="phpdocumentor-argument-list__definition">
  1386. <section class="phpdocumentor-description"></section>
  1387. </dd>
  1388. </dl>
  1389. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1390. <span class="phpdocumentor-signature__response_type">self</span>
  1391. &mdash;
  1392. </article>
  1393. <article
  1394. class="phpdocumentor-element
  1395. -method
  1396. -public
  1397. "
  1398. >
  1399. <h4 class="phpdocumentor-element__name" id="method_addNumericSegment">
  1400. addNumericSegment()
  1401. <a href="classes/chillerlan-QRCode-QRCode.html#method_addNumericSegment" class="headerlink"><i class="fas fa-link"></i></a>
  1402. </h4>
  1403. <aside class="phpdocumentor-element-found-in">
  1404. <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>
  1405. :
  1406. <span class="phpdocumentor-element-found-in__line">356</span>
  1407. </aside>
  1408. <p class="phpdocumentor-summary">Adds a numeric data segment</p>
  1409. <code class="phpdocumentor-code phpdocumentor-signature ">
  1410. <span class="phpdocumentor-signature__visibility">public</span>
  1411. <span class="phpdocumentor-signature__name">addNumericSegment</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>
  1412. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.2 - Numeric Mode</p>
  1413. </section>
  1414. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1415. <dl class="phpdocumentor-argument-list">
  1416. <dt class="phpdocumentor-argument-list__entry">
  1417. <span class="phpdocumentor-signature__argument__name">$data</span>
  1418. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1419. </dt>
  1420. <dd class="phpdocumentor-argument-list__definition">
  1421. <section class="phpdocumentor-description"></section>
  1422. </dd>
  1423. </dl>
  1424. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1425. <span class="phpdocumentor-signature__response_type">self</span>
  1426. &mdash;
  1427. </article>
  1428. <article
  1429. class="phpdocumentor-element
  1430. -method
  1431. -public
  1432. "
  1433. >
  1434. <h4 class="phpdocumentor-element__name" id="method_clearSegments">
  1435. clearSegments()
  1436. <a href="classes/chillerlan-QRCode-QRCode.html#method_clearSegments" class="headerlink"><i class="fas fa-link"></i></a>
  1437. </h4>
  1438. <aside class="phpdocumentor-element-found-in">
  1439. <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>
  1440. :
  1441. <span class="phpdocumentor-element-found-in__line">345</span>
  1442. </aside>
  1443. <p class="phpdocumentor-summary">Clears the data segments array</p>
  1444. <code class="phpdocumentor-code phpdocumentor-signature ">
  1445. <span class="phpdocumentor-signature__visibility">public</span>
  1446. <span class="phpdocumentor-signature__name">clearSegments</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1447. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1448. <span class="phpdocumentor-signature__response_type">self</span>
  1449. &mdash;
  1450. </article>
  1451. <article
  1452. class="phpdocumentor-element
  1453. -method
  1454. -public
  1455. "
  1456. >
  1457. <h4 class="phpdocumentor-element__name" id="method_getMatrix">
  1458. getMatrix()
  1459. <a href="classes/chillerlan-QRCode-QRCode.html#method_getMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  1460. </h4>
  1461. <aside class="phpdocumentor-element-found-in">
  1462. <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>
  1463. :
  1464. <span class="phpdocumentor-element-found-in__line">219</span>
  1465. </aside>
  1466. <p class="phpdocumentor-summary">Returns a QRMatrix object for the given $data and current QROptions</p>
  1467. <code class="phpdocumentor-code phpdocumentor-signature ">
  1468. <span class="phpdocumentor-signature__visibility">public</span>
  1469. <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>
  1470. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1471. Tags
  1472. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1473. </h5>
  1474. <dl class="phpdocumentor-tag-list">
  1475. <dt class="phpdocumentor-tag-list__entry">
  1476. <span class="phpdocumentor-tag__name">throws</span>
  1477. </dt>
  1478. <dd class="phpdocumentor-tag-list__definition">
  1479. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  1480. </dd>
  1481. </dl>
  1482. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1483. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  1484. &mdash;
  1485. </article>
  1486. <article
  1487. class="phpdocumentor-element
  1488. -method
  1489. -public
  1490. -deprecated "
  1491. >
  1492. <h4 class="phpdocumentor-element__name" id="method_isAlphaNum">
  1493. isAlphaNum()
  1494. <a href="classes/chillerlan-QRCode-QRCode.html#method_isAlphaNum" class="headerlink"><i class="fas fa-link"></i></a>
  1495. </h4>
  1496. <aside class="phpdocumentor-element-found-in">
  1497. <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>
  1498. :
  1499. <span class="phpdocumentor-element-found-in__line">306</span>
  1500. </aside>
  1501. <p class="phpdocumentor-summary">checks if a string qualifies as alphanumeric (convenience method)</p>
  1502. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1503. <span class="phpdocumentor-signature__visibility">public</span>
  1504. <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>
  1505. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1506. <dl class="phpdocumentor-argument-list">
  1507. <dt class="phpdocumentor-argument-list__entry">
  1508. <span class="phpdocumentor-signature__argument__name">$string</span>
  1509. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1510. </dt>
  1511. <dd class="phpdocumentor-argument-list__definition">
  1512. <section class="phpdocumentor-description"></section>
  1513. </dd>
  1514. </dl>
  1515. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1516. Tags
  1517. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1518. </h5>
  1519. <dl class="phpdocumentor-tag-list">
  1520. <dt class="phpdocumentor-tag-list__entry">
  1521. <span class="phpdocumentor-tag__name">deprecated</span>
  1522. </dt>
  1523. <dd class="phpdocumentor-tag-list__definition">
  1524. <span class="phpdocumentor-tag-link">5.0.0</span>
  1525. <section class="phpdocumentor-description"><p>use AlphaNum::validateString() instead</p>
  1526. </section>
  1527. </dd>
  1528. <dt class="phpdocumentor-tag-list__entry">
  1529. <span class="phpdocumentor-tag__name">see</span>
  1530. </dt>
  1531. <dd class="phpdocumentor-tag-list__definition">
  1532. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-AlphaNum.html#method_validateString"><abbr title="\chillerlan\QRCode\Data\AlphaNum::validateString()">AlphaNum::validateString()</abbr></a></span>
  1533. </dd>
  1534. <dt class="phpdocumentor-tag-list__entry">
  1535. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1536. </dt>
  1537. <dd class="phpdocumentor-tag-list__definition">
  1538. </dd>
  1539. </dl>
  1540. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1541. <span class="phpdocumentor-signature__response_type">bool</span>
  1542. &mdash;
  1543. </article>
  1544. <article
  1545. class="phpdocumentor-element
  1546. -method
  1547. -public
  1548. -deprecated "
  1549. >
  1550. <h4 class="phpdocumentor-element__name" id="method_isByte">
  1551. isByte()
  1552. <a href="classes/chillerlan-QRCode-QRCode.html#method_isByte" class="headerlink"><i class="fas fa-link"></i></a>
  1553. </h4>
  1554. <aside class="phpdocumentor-element-found-in">
  1555. <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>
  1556. :
  1557. <span class="phpdocumentor-element-found-in__line">328</span>
  1558. </aside>
  1559. <p class="phpdocumentor-summary">a dummy (convenience method)</p>
  1560. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1561. <span class="phpdocumentor-signature__visibility">public</span>
  1562. <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>
  1563. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1564. <dl class="phpdocumentor-argument-list">
  1565. <dt class="phpdocumentor-argument-list__entry">
  1566. <span class="phpdocumentor-signature__argument__name">$string</span>
  1567. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1568. </dt>
  1569. <dd class="phpdocumentor-argument-list__definition">
  1570. <section class="phpdocumentor-description"></section>
  1571. </dd>
  1572. </dl>
  1573. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1574. Tags
  1575. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1576. </h5>
  1577. <dl class="phpdocumentor-tag-list">
  1578. <dt class="phpdocumentor-tag-list__entry">
  1579. <span class="phpdocumentor-tag__name">deprecated</span>
  1580. </dt>
  1581. <dd class="phpdocumentor-tag-list__definition">
  1582. <span class="phpdocumentor-tag-link">5.0.0</span>
  1583. <section class="phpdocumentor-description"><p>use Byte::validateString() instead</p>
  1584. </section>
  1585. </dd>
  1586. <dt class="phpdocumentor-tag-list__entry">
  1587. <span class="phpdocumentor-tag__name">see</span>
  1588. </dt>
  1589. <dd class="phpdocumentor-tag-list__definition">
  1590. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-Byte.html#method_validateString"><abbr title="\chillerlan\QRCode\Data\Byte::validateString()">Byte::validateString()</abbr></a></span>
  1591. </dd>
  1592. <dt class="phpdocumentor-tag-list__entry">
  1593. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1594. </dt>
  1595. <dd class="phpdocumentor-tag-list__definition">
  1596. </dd>
  1597. </dl>
  1598. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1599. <span class="phpdocumentor-signature__response_type">bool</span>
  1600. &mdash;
  1601. </article>
  1602. <article
  1603. class="phpdocumentor-element
  1604. -method
  1605. -public
  1606. -deprecated "
  1607. >
  1608. <h4 class="phpdocumentor-element__name" id="method_isKanji">
  1609. isKanji()
  1610. <a href="classes/chillerlan-QRCode-QRCode.html#method_isKanji" class="headerlink"><i class="fas fa-link"></i></a>
  1611. </h4>
  1612. <aside class="phpdocumentor-element-found-in">
  1613. <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>
  1614. :
  1615. <span class="phpdocumentor-element-found-in__line">317</span>
  1616. </aside>
  1617. <p class="phpdocumentor-summary">checks if a string qualifies as Kanji (convenience method)</p>
  1618. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1619. <span class="phpdocumentor-signature__visibility">public</span>
  1620. <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>
  1621. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1622. <dl class="phpdocumentor-argument-list">
  1623. <dt class="phpdocumentor-argument-list__entry">
  1624. <span class="phpdocumentor-signature__argument__name">$string</span>
  1625. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1626. </dt>
  1627. <dd class="phpdocumentor-argument-list__definition">
  1628. <section class="phpdocumentor-description"></section>
  1629. </dd>
  1630. </dl>
  1631. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1632. Tags
  1633. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1634. </h5>
  1635. <dl class="phpdocumentor-tag-list">
  1636. <dt class="phpdocumentor-tag-list__entry">
  1637. <span class="phpdocumentor-tag__name">deprecated</span>
  1638. </dt>
  1639. <dd class="phpdocumentor-tag-list__definition">
  1640. <span class="phpdocumentor-tag-link">5.0.0</span>
  1641. <section class="phpdocumentor-description"><p>use Kanji::validateString() instead</p>
  1642. </section>
  1643. </dd>
  1644. <dt class="phpdocumentor-tag-list__entry">
  1645. <span class="phpdocumentor-tag__name">see</span>
  1646. </dt>
  1647. <dd class="phpdocumentor-tag-list__definition">
  1648. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-Kanji.html#method_validateString"><abbr title="\chillerlan\QRCode\Data\Kanji::validateString()">Kanji::validateString()</abbr></a></span>
  1649. </dd>
  1650. <dt class="phpdocumentor-tag-list__entry">
  1651. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1652. </dt>
  1653. <dd class="phpdocumentor-tag-list__definition">
  1654. </dd>
  1655. </dl>
  1656. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1657. <span class="phpdocumentor-signature__response_type">bool</span>
  1658. &mdash;
  1659. </article>
  1660. <article
  1661. class="phpdocumentor-element
  1662. -method
  1663. -public
  1664. -deprecated "
  1665. >
  1666. <h4 class="phpdocumentor-element__name" id="method_isNumber">
  1667. isNumber()
  1668. <a href="classes/chillerlan-QRCode-QRCode.html#method_isNumber" class="headerlink"><i class="fas fa-link"></i></a>
  1669. </h4>
  1670. <aside class="phpdocumentor-element-found-in">
  1671. <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>
  1672. :
  1673. <span class="phpdocumentor-element-found-in__line">295</span>
  1674. </aside>
  1675. <p class="phpdocumentor-summary">checks if a string qualifies as numeric (convenience method)</p>
  1676. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1677. <span class="phpdocumentor-signature__visibility">public</span>
  1678. <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>
  1679. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1680. <dl class="phpdocumentor-argument-list">
  1681. <dt class="phpdocumentor-argument-list__entry">
  1682. <span class="phpdocumentor-signature__argument__name">$string</span>
  1683. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1684. </dt>
  1685. <dd class="phpdocumentor-argument-list__definition">
  1686. <section class="phpdocumentor-description"></section>
  1687. </dd>
  1688. </dl>
  1689. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1690. Tags
  1691. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1692. </h5>
  1693. <dl class="phpdocumentor-tag-list">
  1694. <dt class="phpdocumentor-tag-list__entry">
  1695. <span class="phpdocumentor-tag__name">deprecated</span>
  1696. </dt>
  1697. <dd class="phpdocumentor-tag-list__definition">
  1698. <span class="phpdocumentor-tag-link">5.0.0</span>
  1699. <section class="phpdocumentor-description"><p>use Number::validateString() instead</p>
  1700. </section>
  1701. </dd>
  1702. <dt class="phpdocumentor-tag-list__entry">
  1703. <span class="phpdocumentor-tag__name">see</span>
  1704. </dt>
  1705. <dd class="phpdocumentor-tag-list__definition">
  1706. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-Number.html#method_validateString"><abbr title="\chillerlan\QRCode\Data\Number::validateString()">Number::validateString()</abbr></a></span>
  1707. </dd>
  1708. <dt class="phpdocumentor-tag-list__entry">
  1709. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1710. </dt>
  1711. <dd class="phpdocumentor-tag-list__definition">
  1712. </dd>
  1713. </dl>
  1714. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1715. <span class="phpdocumentor-signature__response_type">bool</span>
  1716. &mdash;
  1717. </article>
  1718. <article
  1719. class="phpdocumentor-element
  1720. -method
  1721. -public
  1722. "
  1723. >
  1724. <h4 class="phpdocumentor-element__name" id="method_readFromBlob">
  1725. readFromBlob()
  1726. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromBlob" class="headerlink"><i class="fas fa-link"></i></a>
  1727. </h4>
  1728. <aside class="phpdocumentor-element-found-in">
  1729. <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>
  1730. :
  1731. <span class="phpdocumentor-element-found-in__line">445</span>
  1732. </aside>
  1733. <p class="phpdocumentor-summary">Reads a QR Code from the given data blob</p>
  1734. <code class="phpdocumentor-code phpdocumentor-signature ">
  1735. <span class="phpdocumentor-signature__visibility">public</span>
  1736. <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>
  1737. <section class="phpdocumentor-description"><p>@noinspection PhpUndefinedMethodInspection</p>
  1738. </section>
  1739. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1740. <dl class="phpdocumentor-argument-list">
  1741. <dt class="phpdocumentor-argument-list__entry">
  1742. <span class="phpdocumentor-signature__argument__name">$blob</span>
  1743. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1744. </dt>
  1745. <dd class="phpdocumentor-argument-list__definition">
  1746. <section class="phpdocumentor-description"></section>
  1747. </dd>
  1748. </dl>
  1749. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1750. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  1751. &mdash;
  1752. </article>
  1753. <article
  1754. class="phpdocumentor-element
  1755. -method
  1756. -public
  1757. "
  1758. >
  1759. <h4 class="phpdocumentor-element__name" id="method_readFromFile">
  1760. readFromFile()
  1761. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromFile" class="headerlink"><i class="fas fa-link"></i></a>
  1762. </h4>
  1763. <aside class="phpdocumentor-element-found-in">
  1764. <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>
  1765. :
  1766. <span class="phpdocumentor-element-found-in__line">436</span>
  1767. </aside>
  1768. <p class="phpdocumentor-summary">Reads a QR Code from a given file</p>
  1769. <code class="phpdocumentor-code phpdocumentor-signature ">
  1770. <span class="phpdocumentor-signature__visibility">public</span>
  1771. <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>
  1772. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1773. <dl class="phpdocumentor-argument-list">
  1774. <dt class="phpdocumentor-argument-list__entry">
  1775. <span class="phpdocumentor-signature__argument__name">$path</span>
  1776. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1777. </dt>
  1778. <dd class="phpdocumentor-argument-list__definition">
  1779. <section class="phpdocumentor-description"></section>
  1780. </dd>
  1781. </dl>
  1782. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1783. Tags
  1784. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1785. </h5>
  1786. <dl class="phpdocumentor-tag-list">
  1787. <dt class="phpdocumentor-tag-list__entry">
  1788. <span class="phpdocumentor-tag__name">noinspection</span>
  1789. </dt>
  1790. <dd class="phpdocumentor-tag-list__definition">
  1791. <section class="phpdocumentor-description"><p>PhpUndefinedMethodInspection</p>
  1792. </section>
  1793. </dd>
  1794. </dl>
  1795. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1796. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  1797. &mdash;
  1798. </article>
  1799. <article
  1800. class="phpdocumentor-element
  1801. -method
  1802. -public
  1803. "
  1804. >
  1805. <h4 class="phpdocumentor-element__name" id="method_readFromSource">
  1806. readFromSource()
  1807. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromSource" class="headerlink"><i class="fas fa-link"></i></a>
  1808. </h4>
  1809. <aside class="phpdocumentor-element-found-in">
  1810. <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>
  1811. :
  1812. <span class="phpdocumentor-element-found-in__line">452</span>
  1813. </aside>
  1814. <p class="phpdocumentor-summary">Reads a QR Code from the given luminance source</p>
  1815. <code class="phpdocumentor-code phpdocumentor-signature ">
  1816. <span class="phpdocumentor-signature__visibility">public</span>
  1817. <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>
  1818. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1819. <dl class="phpdocumentor-argument-list">
  1820. <dt class="phpdocumentor-argument-list__entry">
  1821. <span class="phpdocumentor-signature__argument__name">$source</span>
  1822. : <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>
  1823. </dt>
  1824. <dd class="phpdocumentor-argument-list__definition">
  1825. <section class="phpdocumentor-description"></section>
  1826. </dd>
  1827. </dl>
  1828. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1829. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  1830. &mdash;
  1831. </article>
  1832. <article
  1833. class="phpdocumentor-element
  1834. -method
  1835. -public
  1836. "
  1837. >
  1838. <h4 class="phpdocumentor-element__name" id="method_render">
  1839. render()
  1840. <a href="classes/chillerlan-QRCode-QRCode.html#method_render" class="headerlink"><i class="fas fa-link"></i></a>
  1841. </h4>
  1842. <aside class="phpdocumentor-element-found-in">
  1843. <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>
  1844. :
  1845. <span class="phpdocumentor-element-found-in__line">197</span>
  1846. </aside>
  1847. <p class="phpdocumentor-summary">Renders a QR Code for the given $data and QROptions, saves $file optionally</p>
  1848. <code class="phpdocumentor-code phpdocumentor-signature ">
  1849. <span class="phpdocumentor-signature__visibility">public</span>
  1850. <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>
  1851. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1852. <dl class="phpdocumentor-argument-list">
  1853. <dt class="phpdocumentor-argument-list__entry">
  1854. <span class="phpdocumentor-signature__argument__name">$data</span>
  1855. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1856. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1857. <dd class="phpdocumentor-argument-list__definition">
  1858. <section class="phpdocumentor-description"></section>
  1859. </dd>
  1860. <dt class="phpdocumentor-argument-list__entry">
  1861. <span class="phpdocumentor-signature__argument__name">$file</span>
  1862. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1863. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1864. <dd class="phpdocumentor-argument-list__definition">
  1865. <section class="phpdocumentor-description"></section>
  1866. </dd>
  1867. </dl>
  1868. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1869. <span class="phpdocumentor-signature__response_type">mixed</span>
  1870. &mdash;
  1871. </article>
  1872. <article
  1873. class="phpdocumentor-element
  1874. -method
  1875. -protected
  1876. "
  1877. >
  1878. <h4 class="phpdocumentor-element__name" id="method_addSegment">
  1879. addSegment()
  1880. <a href="classes/chillerlan-QRCode-QRCode.html#method_addSegment" class="headerlink"><i class="fas fa-link"></i></a>
  1881. </h4>
  1882. <aside class="phpdocumentor-element-found-in">
  1883. <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>
  1884. :
  1885. <span class="phpdocumentor-element-found-in__line">338</span>
  1886. </aside>
  1887. <p class="phpdocumentor-summary">Adds a data segment</p>
  1888. <code class="phpdocumentor-code phpdocumentor-signature ">
  1889. <span class="phpdocumentor-signature__visibility">protected</span>
  1890. <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>
  1891. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.6 - Mixing modes
  1892. ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length</p>
  1893. </section>
  1894. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1895. <dl class="phpdocumentor-argument-list">
  1896. <dt class="phpdocumentor-argument-list__entry">
  1897. <span class="phpdocumentor-signature__argument__name">$segment</span>
  1898. : <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>
  1899. </dt>
  1900. <dd class="phpdocumentor-argument-list__definition">
  1901. <section class="phpdocumentor-description"></section>
  1902. </dd>
  1903. </dl>
  1904. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1905. <span class="phpdocumentor-signature__response_type">void</span>
  1906. &mdash;
  1907. </article>
  1908. <article
  1909. class="phpdocumentor-element
  1910. -method
  1911. -protected
  1912. "
  1913. >
  1914. <h4 class="phpdocumentor-element__name" id="method_initCustomOutputInterface">
  1915. initCustomOutputInterface()
  1916. <a href="classes/chillerlan-QRCode-QRCode.html#method_initCustomOutputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  1917. </h4>
  1918. <aside class="phpdocumentor-element-found-in">
  1919. <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>
  1920. :
  1921. <span class="phpdocumentor-element-found-in__line">274</span>
  1922. </aside>
  1923. <p class="phpdocumentor-summary">initializes a custom output module after checking the existence of the class and if it implemnts the required interface</p>
  1924. <code class="phpdocumentor-code phpdocumentor-signature ">
  1925. <span class="phpdocumentor-signature__visibility">protected</span>
  1926. <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>
  1927. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1928. Tags
  1929. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1930. </h5>
  1931. <dl class="phpdocumentor-tag-list">
  1932. <dt class="phpdocumentor-tag-list__entry">
  1933. <span class="phpdocumentor-tag__name">throws</span>
  1934. </dt>
  1935. <dd class="phpdocumentor-tag-list__definition">
  1936. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1937. </dd>
  1938. </dl>
  1939. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1940. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></span>
  1941. &mdash;
  1942. </article>
  1943. <article
  1944. class="phpdocumentor-element
  1945. -method
  1946. -protected
  1947. "
  1948. >
  1949. <h4 class="phpdocumentor-element__name" id="method_initOutputInterface">
  1950. initOutputInterface()
  1951. <a href="classes/chillerlan-QRCode-QRCode.html#method_initOutputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  1952. </h4>
  1953. <aside class="phpdocumentor-element-found-in">
  1954. <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>
  1955. :
  1956. <span class="phpdocumentor-element-found-in__line">254</span>
  1957. </aside>
  1958. <p class="phpdocumentor-summary">returns a fresh (built-in) QROutputInterface</p>
  1959. <code class="phpdocumentor-code phpdocumentor-signature ">
  1960. <span class="phpdocumentor-signature__visibility">protected</span>
  1961. <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>
  1962. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1963. Tags
  1964. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1965. </h5>
  1966. <dl class="phpdocumentor-tag-list">
  1967. <dt class="phpdocumentor-tag-list__entry">
  1968. <span class="phpdocumentor-tag__name">throws</span>
  1969. </dt>
  1970. <dd class="phpdocumentor-tag-list__definition">
  1971. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1972. </dd>
  1973. </dl>
  1974. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1975. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></span>
  1976. &mdash;
  1977. </article>
  1978. </section>
  1979. <script type="text/javascript">
  1980. function loadExternalCodeSnippets(line) {
  1981. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1982. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  1983. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  1984. var language = 'php';
  1985. var code = document.createElement('code');
  1986. code.className = 'language-' + language;
  1987. pre.textContent = '';
  1988. pre.setAttribute('data-line', line)
  1989. code.textContent = 'Loading…';
  1990. pre.appendChild(code);
  1991. var xhr = new XMLHttpRequest();
  1992. xhr.open('GET', src, true);
  1993. xhr.onreadystatechange = function () {
  1994. if (xhr.readyState == 4) {
  1995. if (xhr.status < 400 && xhr.responseText) {
  1996. code.textContent = xhr.responseText;
  1997. Prism.highlightElement(code);
  1998. }
  1999. else if (xhr.status >= 400) {
  2000. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  2001. }
  2002. else {
  2003. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  2004. }
  2005. }
  2006. };
  2007. xhr.send(null);
  2008. });
  2009. }
  2010. var modals = document.querySelectorAll("[data-modal]");
  2011. modals.forEach(function (trigger) {
  2012. trigger.addEventListener("click", function (event) {
  2013. //event.preventDefault();
  2014. const modal = document.getElementById(trigger.dataset.modal);
  2015. modal.classList.add("phpdocumentor-modal__open");
  2016. loadExternalCodeSnippets(trigger.dataset.line)
  2017. const exits = modal.querySelectorAll("[data-exit-button]");
  2018. exits.forEach(function (exit) {
  2019. exit.addEventListener("click", function (event) {
  2020. event.preventDefault();
  2021. modal.classList.remove("phpdocumentor-modal__open");
  2022. });
  2023. });
  2024. });
  2025. });
  2026. </script>
  2027. </article>
  2028. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  2029. <section class="phpdocumentor-search-results__dialog">
  2030. <header class="phpdocumentor-search-results__header">
  2031. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  2032. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  2033. </header>
  2034. <section class="phpdocumentor-search-results__body">
  2035. <ul class="phpdocumentor-search-results__entries"></ul>
  2036. </section>
  2037. </section>
  2038. </section>
  2039. </div>
  2040. </div>
  2041. <a href="classes/chillerlan-QRCode-QRCode.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  2042. </main>
  2043. <script>
  2044. cssVars({});
  2045. </script>
  2046. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  2047. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  2048. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  2049. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  2050. </body>
  2051. </html>