chillerlan-QRCode-QRCode.html 159 KB

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