chillerlan-QRCode-QRCode.html 133 KB

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