chillerlan-QRCode-QRCode.html 107 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241
  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;= -1 </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;= &#039;custom&#039; </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_FPDF">OUTPUT_FPDF</a>
  184. <span>
  185. &nbsp;= &#039;fpdf&#039; </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_IMAGE_GIF">OUTPUT_IMAGE_GIF</a>
  190. <span>
  191. &nbsp;= &#039;gif&#039; </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_JPG">OUTPUT_IMAGE_JPG</a>
  196. <span>
  197. &nbsp;= &#039;jpg&#039; </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_PNG">OUTPUT_IMAGE_PNG</a>
  202. <span>
  203. &nbsp;= &#039;png&#039; </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_IMAGICK">OUTPUT_IMAGICK</a>
  208. <span>
  209. &nbsp;= &#039;imagick&#039; </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_MARKUP_HTML">OUTPUT_MARKUP_HTML</a>
  214. <span>
  215. &nbsp;= &#039;html&#039; </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_SVG">OUTPUT_MARKUP_SVG</a>
  220. <span>
  221. &nbsp;= &#039;svg&#039; </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_MODES">OUTPUT_MODES</a>
  226. <span>
  227. &nbsp;= [self::OUTPUT_MARKUP_SVG =&gt; \chillerlan\QRCode\Output\QRMarkup::class, self::OUTPUT_MARKUP_HTML =&gt; \chillerlan\QRCode\Output\QRMarkup::class, self::OUTPUT_IMAGE_PNG =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::OUTPUT_IMAGE_GIF =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::OUTPUT_IMAGE_JPG =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::OUTPUT_STRING_JSON =&gt; \chillerlan\QRCode\Output\QRString::class, self::OUTPUT_STRING_TEXT =&gt; \chillerlan\QRCode\Output\QRString::class, self::OUTPUT_IMAGICK =&gt; \chillerlan\QRCode\Output\QRImagick::class, self::OUTPUT_FPDF =&gt; \chillerlan\QRCode\Output\QRFpdf::class] </span>
  228. </dt>
  229. <dd>Map of built-in output modes =&gt; modules</dd>
  230. <dt class="phpdocumentor-table-of-contents__entry -constant -public">
  231. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_STRING_JSON">OUTPUT_STRING_JSON</a>
  232. <span>
  233. &nbsp;= &#039;json&#039; </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_TEXT">OUTPUT_STRING_TEXT</a>
  238. <span>
  239. &nbsp;= &#039;text&#039; </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_VERSION_AUTO">VERSION_AUTO</a>
  244. <span>
  245. &nbsp;= -1 </span>
  246. </dt>
  247. <dd></dd>
  248. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  249. <a href="classes/chillerlan-QRCode-QRCode.html#property_dataSegments">$dataSegments</a>
  250. <span>
  251. &nbsp;: array&lt;string|int, mixed&gt; </span>
  252. </dt>
  253. <dd>A collection of one or more data segments of [classname, data] to write</dd>
  254. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  255. <a href="classes/chillerlan-QRCode-QRCode.html#property_options">$options</a>
  256. <span>
  257. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr> </span>
  258. </dt>
  259. <dd>The settings container</dd>
  260. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  261. <a href="classes/chillerlan-QRCode-QRCode.html#method___construct">__construct()</a>
  262. <span>
  263. &nbsp;: mixed </span>
  264. </dt>
  265. <dd>QRCode constructor.</dd>
  266. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  267. <a href="classes/chillerlan-QRCode-QRCode.html#method_addAlphaNumSegment">addAlphaNumSegment()</a>
  268. <span>
  269. &nbsp;: self </span>
  270. </dt>
  271. <dd>Adds an alphanumeric data segment</dd>
  272. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  273. <a href="classes/chillerlan-QRCode-QRCode.html#method_addByteSegment">addByteSegment()</a>
  274. <span>
  275. &nbsp;: self </span>
  276. </dt>
  277. <dd>Adds an 8-bit byte data segment</dd>
  278. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  279. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciDesignator">addEciDesignator()</a>
  280. <span>
  281. &nbsp;: self </span>
  282. </dt>
  283. <dd>Adds a standalone ECI designator</dd>
  284. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  285. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciSegment">addEciSegment()</a>
  286. <span>
  287. &nbsp;: self </span>
  288. </dt>
  289. <dd>Adds an ECI data segment (including designator)</dd>
  290. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  291. <a href="classes/chillerlan-QRCode-QRCode.html#method_addKanjiSegment">addKanjiSegment()</a>
  292. <span>
  293. &nbsp;: self </span>
  294. </dt>
  295. <dd>Adds a Kanji data segment</dd>
  296. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  297. <a href="classes/chillerlan-QRCode-QRCode.html#method_addNumericSegment">addNumericSegment()</a>
  298. <span>
  299. &nbsp;: self </span>
  300. </dt>
  301. <dd>Adds a numeric data segment</dd>
  302. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  303. <a href="classes/chillerlan-QRCode-QRCode.html#method_clearSegments">clearSegments()</a>
  304. <span>
  305. &nbsp;: self </span>
  306. </dt>
  307. <dd>Clears the data segments array</dd>
  308. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  309. <a href="classes/chillerlan-QRCode-QRCode.html#method_getMatrix">getMatrix()</a>
  310. <span>
  311. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  312. </dt>
  313. <dd>Returns a QRMatrix object for the given $data and current QROptions</dd>
  314. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  315. <a href="classes/chillerlan-QRCode-QRCode.html#method_isAlphaNum">isAlphaNum()</a>
  316. <span>
  317. &nbsp;: bool </span>
  318. </dt>
  319. <dd>checks if a string qualifies as alphanumeric (convenience method)</dd>
  320. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  321. <a href="classes/chillerlan-QRCode-QRCode.html#method_isByte">isByte()</a>
  322. <span>
  323. &nbsp;: bool </span>
  324. </dt>
  325. <dd>a dummy (convenience method)</dd>
  326. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  327. <a href="classes/chillerlan-QRCode-QRCode.html#method_isKanji">isKanji()</a>
  328. <span>
  329. &nbsp;: bool </span>
  330. </dt>
  331. <dd>checks if a string qualifies as Kanji (convenience method)</dd>
  332. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  333. <a href="classes/chillerlan-QRCode-QRCode.html#method_isNumber">isNumber()</a>
  334. <span>
  335. &nbsp;: bool </span>
  336. </dt>
  337. <dd>checks if a string qualifies as numeric (convenience method)</dd>
  338. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  339. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromBlob">readFromBlob()</a>
  340. <span>
  341. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  342. </dt>
  343. <dd>Reads a QR Code from the given data blob</dd>
  344. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  345. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromFile">readFromFile()</a>
  346. <span>
  347. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  348. </dt>
  349. <dd>Reads a QR Code from a given file</dd>
  350. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  351. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromSource">readFromSource()</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 luminance source</dd>
  356. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  357. <a href="classes/chillerlan-QRCode-QRCode.html#method_render">render()</a>
  358. <span>
  359. &nbsp;: mixed </span>
  360. </dt>
  361. <dd>Renders a QR Code for the given $data and QROptions</dd>
  362. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  363. <a href="classes/chillerlan-QRCode-QRCode.html#method_addSegment">addSegment()</a>
  364. <span>
  365. &nbsp;: void </span>
  366. </dt>
  367. <dd>Adds a data segment</dd>
  368. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  369. <a href="classes/chillerlan-QRCode-QRCode.html#method_initCustomOutputInterface">initCustomOutputInterface()</a>
  370. <span>
  371. &nbsp;: <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a> </span>
  372. </dt>
  373. <dd>initializes a custom output module after checking the existence of the class and if it implemnts the required interface</dd>
  374. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  375. <a href="classes/chillerlan-QRCode-QRCode.html#method_initOutputInterface">initOutputInterface()</a>
  376. <span>
  377. &nbsp;: <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a> </span>
  378. </dt>
  379. <dd>returns a fresh (built-in) QROutputInterface</dd>
  380. </dl>
  381. <section class="phpdocumentor-constants">
  382. <h3 class="phpdocumentor-elements__header" id="constants">
  383. Constants
  384. <a href="classes/chillerlan-QRCode-QRCode.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
  385. </h3>
  386. <article class="phpdocumentor-element -constant -public -deprecated">
  387. <h4 class="phpdocumentor-element__name" id="constant_ECC_H">
  388. ECC_H
  389. <a href="classes/chillerlan-QRCode-QRCode.html#constant_ECC_H" class="headerlink"><i class="fas fa-link"></i></a>
  390. </h4>
  391. <aside class="phpdocumentor-element-found-in">
  392. <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>
  393. :
  394. <span class="phpdocumentor-element-found-in__line">62</span>
  395. </aside>
  396. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  397. <span class="phpdocumentor-signature__visibility">public</span>
  398. <span class="phpdocumentor-signature__type">int</span>
  399. <span class="phpdocumentor-signature__name">ECC_H</span>
  400. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::H</span>
  401. </code>
  402. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  403. Tags
  404. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  405. </h5>
  406. <dl class="phpdocumentor-tag-list">
  407. <dt class="phpdocumentor-tag-list__entry">
  408. <span class="phpdocumentor-tag__name">deprecated</span>
  409. </dt>
  410. <dd class="phpdocumentor-tag-list__definition">
  411. <span class="phpdocumentor-tag-link">5.0.0</span>
  412. </dd>
  413. <dt class="phpdocumentor-tag-list__entry">
  414. <span class="phpdocumentor-tag__name">see</span>
  415. </dt>
  416. <dd class="phpdocumentor-tag-list__definition">
  417. <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>
  418. </dd>
  419. </dl>
  420. </article>
  421. <article class="phpdocumentor-element -constant -public -deprecated">
  422. <h4 class="phpdocumentor-element__name" id="constant_ECC_L">
  423. ECC_L
  424. <a href="classes/chillerlan-QRCode-QRCode.html#constant_ECC_L" class="headerlink"><i class="fas fa-link"></i></a>
  425. </h4>
  426. <aside class="phpdocumentor-element-found-in">
  427. <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>
  428. :
  429. <span class="phpdocumentor-element-found-in__line">41</span>
  430. </aside>
  431. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  432. <span class="phpdocumentor-signature__visibility">public</span>
  433. <span class="phpdocumentor-signature__type">int</span>
  434. <span class="phpdocumentor-signature__name">ECC_L</span>
  435. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::L</span>
  436. </code>
  437. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  438. Tags
  439. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  440. </h5>
  441. <dl class="phpdocumentor-tag-list">
  442. <dt class="phpdocumentor-tag-list__entry">
  443. <span class="phpdocumentor-tag__name">deprecated</span>
  444. </dt>
  445. <dd class="phpdocumentor-tag-list__definition">
  446. <span class="phpdocumentor-tag-link">5.0.0</span>
  447. </dd>
  448. <dt class="phpdocumentor-tag-list__entry">
  449. <span class="phpdocumentor-tag__name">see</span>
  450. </dt>
  451. <dd class="phpdocumentor-tag-list__definition">
  452. <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>
  453. </dd>
  454. </dl>
  455. </article>
  456. <article class="phpdocumentor-element -constant -public -deprecated">
  457. <h4 class="phpdocumentor-element__name" id="constant_ECC_M">
  458. ECC_M
  459. <a href="classes/chillerlan-QRCode-QRCode.html#constant_ECC_M" class="headerlink"><i class="fas fa-link"></i></a>
  460. </h4>
  461. <aside class="phpdocumentor-element-found-in">
  462. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  463. :
  464. <span class="phpdocumentor-element-found-in__line">48</span>
  465. </aside>
  466. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  467. <span class="phpdocumentor-signature__visibility">public</span>
  468. <span class="phpdocumentor-signature__type">int</span>
  469. <span class="phpdocumentor-signature__name">ECC_M</span>
  470. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::M</span>
  471. </code>
  472. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  473. Tags
  474. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  475. </h5>
  476. <dl class="phpdocumentor-tag-list">
  477. <dt class="phpdocumentor-tag-list__entry">
  478. <span class="phpdocumentor-tag__name">deprecated</span>
  479. </dt>
  480. <dd class="phpdocumentor-tag-list__definition">
  481. <span class="phpdocumentor-tag-link">5.0.0</span>
  482. </dd>
  483. <dt class="phpdocumentor-tag-list__entry">
  484. <span class="phpdocumentor-tag__name">see</span>
  485. </dt>
  486. <dd class="phpdocumentor-tag-list__definition">
  487. <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>
  488. </dd>
  489. </dl>
  490. </article>
  491. <article class="phpdocumentor-element -constant -public -deprecated">
  492. <h4 class="phpdocumentor-element__name" id="constant_ECC_Q">
  493. ECC_Q
  494. <a href="classes/chillerlan-QRCode-QRCode.html#constant_ECC_Q" class="headerlink"><i class="fas fa-link"></i></a>
  495. </h4>
  496. <aside class="phpdocumentor-element-found-in">
  497. <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>
  498. :
  499. <span class="phpdocumentor-element-found-in__line">55</span>
  500. </aside>
  501. <code class="phpdocumentor-signature phpdocumentor-code -deprecated">
  502. <span class="phpdocumentor-signature__visibility">public</span>
  503. <span class="phpdocumentor-signature__type">int</span>
  504. <span class="phpdocumentor-signature__name">ECC_Q</span>
  505. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\EccLevel::Q</span>
  506. </code>
  507. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  508. Tags
  509. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  510. </h5>
  511. <dl class="phpdocumentor-tag-list">
  512. <dt class="phpdocumentor-tag-list__entry">
  513. <span class="phpdocumentor-tag__name">deprecated</span>
  514. </dt>
  515. <dd class="phpdocumentor-tag-list__definition">
  516. <span class="phpdocumentor-tag-link">5.0.0</span>
  517. </dd>
  518. <dt class="phpdocumentor-tag-list__entry">
  519. <span class="phpdocumentor-tag__name">see</span>
  520. </dt>
  521. <dd class="phpdocumentor-tag-list__definition">
  522. <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>
  523. </dd>
  524. </dl>
  525. </article>
  526. <article class="phpdocumentor-element -constant -public ">
  527. <h4 class="phpdocumentor-element__name" id="constant_MASK_PATTERN_AUTO">
  528. MASK_PATTERN_AUTO
  529. <a href="classes/chillerlan-QRCode-QRCode.html#constant_MASK_PATTERN_AUTO" class="headerlink"><i class="fas fa-link"></i></a>
  530. </h4>
  531. <aside class="phpdocumentor-element-found-in">
  532. <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>
  533. :
  534. <span class="phpdocumentor-element-found-in__line">34</span>
  535. </aside>
  536. <code class="phpdocumentor-signature phpdocumentor-code ">
  537. <span class="phpdocumentor-signature__visibility">public</span>
  538. <span class="phpdocumentor-signature__type">int</span>
  539. <span class="phpdocumentor-signature__name">MASK_PATTERN_AUTO</span>
  540. = <span class="phpdocumentor-signature__default-value">-1</span>
  541. </code>
  542. </article>
  543. <article class="phpdocumentor-element -constant -public ">
  544. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_CUSTOM">
  545. OUTPUT_CUSTOM
  546. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_CUSTOM" class="headerlink"><i class="fas fa-link"></i></a>
  547. </h4>
  548. <aside class="phpdocumentor-element-found-in">
  549. <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>
  550. :
  551. <span class="phpdocumentor-element-found-in__line">83</span>
  552. </aside>
  553. <code class="phpdocumentor-signature phpdocumentor-code ">
  554. <span class="phpdocumentor-signature__visibility">public</span>
  555. <span class="phpdocumentor-signature__type">string</span>
  556. <span class="phpdocumentor-signature__name">OUTPUT_CUSTOM</span>
  557. = <span class="phpdocumentor-signature__default-value">&#039;custom&#039;</span>
  558. </code>
  559. </article>
  560. <article class="phpdocumentor-element -constant -public ">
  561. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_FPDF">
  562. OUTPUT_FPDF
  563. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_FPDF" class="headerlink"><i class="fas fa-link"></i></a>
  564. </h4>
  565. <aside class="phpdocumentor-element-found-in">
  566. <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>
  567. :
  568. <span class="phpdocumentor-element-found-in__line">81</span>
  569. </aside>
  570. <code class="phpdocumentor-signature phpdocumentor-code ">
  571. <span class="phpdocumentor-signature__visibility">public</span>
  572. <span class="phpdocumentor-signature__type">string</span>
  573. <span class="phpdocumentor-signature__name">OUTPUT_FPDF</span>
  574. = <span class="phpdocumentor-signature__default-value">&#039;fpdf&#039;</span>
  575. </code>
  576. </article>
  577. <article class="phpdocumentor-element -constant -public ">
  578. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_IMAGE_GIF">
  579. OUTPUT_IMAGE_GIF
  580. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_GIF" class="headerlink"><i class="fas fa-link"></i></a>
  581. </h4>
  582. <aside class="phpdocumentor-element-found-in">
  583. <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>
  584. :
  585. <span class="phpdocumentor-element-found-in__line">73</span>
  586. </aside>
  587. <code class="phpdocumentor-signature phpdocumentor-code ">
  588. <span class="phpdocumentor-signature__visibility">public</span>
  589. <span class="phpdocumentor-signature__type">string</span>
  590. <span class="phpdocumentor-signature__name">OUTPUT_IMAGE_GIF</span>
  591. = <span class="phpdocumentor-signature__default-value">&#039;gif&#039;</span>
  592. </code>
  593. </article>
  594. <article class="phpdocumentor-element -constant -public ">
  595. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_IMAGE_JPG">
  596. OUTPUT_IMAGE_JPG
  597. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_JPG" class="headerlink"><i class="fas fa-link"></i></a>
  598. </h4>
  599. <aside class="phpdocumentor-element-found-in">
  600. <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>
  601. :
  602. <span class="phpdocumentor-element-found-in__line">71</span>
  603. </aside>
  604. <code class="phpdocumentor-signature phpdocumentor-code ">
  605. <span class="phpdocumentor-signature__visibility">public</span>
  606. <span class="phpdocumentor-signature__type">string</span>
  607. <span class="phpdocumentor-signature__name">OUTPUT_IMAGE_JPG</span>
  608. = <span class="phpdocumentor-signature__default-value">&#039;jpg&#039;</span>
  609. </code>
  610. </article>
  611. <article class="phpdocumentor-element -constant -public ">
  612. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_IMAGE_PNG">
  613. OUTPUT_IMAGE_PNG
  614. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGE_PNG" class="headerlink"><i class="fas fa-link"></i></a>
  615. </h4>
  616. <aside class="phpdocumentor-element-found-in">
  617. <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>
  618. :
  619. <span class="phpdocumentor-element-found-in__line">69</span>
  620. </aside>
  621. <code class="phpdocumentor-signature phpdocumentor-code ">
  622. <span class="phpdocumentor-signature__visibility">public</span>
  623. <span class="phpdocumentor-signature__type">string</span>
  624. <span class="phpdocumentor-signature__name">OUTPUT_IMAGE_PNG</span>
  625. = <span class="phpdocumentor-signature__default-value">&#039;png&#039;</span>
  626. </code>
  627. </article>
  628. <article class="phpdocumentor-element -constant -public ">
  629. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_IMAGICK">
  630. OUTPUT_IMAGICK
  631. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_IMAGICK" class="headerlink"><i class="fas fa-link"></i></a>
  632. </h4>
  633. <aside class="phpdocumentor-element-found-in">
  634. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  635. :
  636. <span class="phpdocumentor-element-found-in__line">79</span>
  637. </aside>
  638. <code class="phpdocumentor-signature phpdocumentor-code ">
  639. <span class="phpdocumentor-signature__visibility">public</span>
  640. <span class="phpdocumentor-signature__type">string</span>
  641. <span class="phpdocumentor-signature__name">OUTPUT_IMAGICK</span>
  642. = <span class="phpdocumentor-signature__default-value">&#039;imagick&#039;</span>
  643. </code>
  644. </article>
  645. <article class="phpdocumentor-element -constant -public ">
  646. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_MARKUP_HTML">
  647. OUTPUT_MARKUP_HTML
  648. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MARKUP_HTML" class="headerlink"><i class="fas fa-link"></i></a>
  649. </h4>
  650. <aside class="phpdocumentor-element-found-in">
  651. <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>
  652. :
  653. <span class="phpdocumentor-element-found-in__line">65</span>
  654. </aside>
  655. <code class="phpdocumentor-signature phpdocumentor-code ">
  656. <span class="phpdocumentor-signature__visibility">public</span>
  657. <span class="phpdocumentor-signature__type">string</span>
  658. <span class="phpdocumentor-signature__name">OUTPUT_MARKUP_HTML</span>
  659. = <span class="phpdocumentor-signature__default-value">&#039;html&#039;</span>
  660. </code>
  661. </article>
  662. <article class="phpdocumentor-element -constant -public ">
  663. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_MARKUP_SVG">
  664. OUTPUT_MARKUP_SVG
  665. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MARKUP_SVG" class="headerlink"><i class="fas fa-link"></i></a>
  666. </h4>
  667. <aside class="phpdocumentor-element-found-in">
  668. <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>
  669. :
  670. <span class="phpdocumentor-element-found-in__line">67</span>
  671. </aside>
  672. <code class="phpdocumentor-signature phpdocumentor-code ">
  673. <span class="phpdocumentor-signature__visibility">public</span>
  674. <span class="phpdocumentor-signature__type">string</span>
  675. <span class="phpdocumentor-signature__name">OUTPUT_MARKUP_SVG</span>
  676. = <span class="phpdocumentor-signature__default-value">&#039;svg&#039;</span>
  677. </code>
  678. </article>
  679. <article class="phpdocumentor-element -constant -public ">
  680. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_MODES">
  681. OUTPUT_MODES
  682. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_MODES" class="headerlink"><i class="fas fa-link"></i></a>
  683. </h4>
  684. <aside class="phpdocumentor-element-found-in">
  685. <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>
  686. :
  687. <span class="phpdocumentor-element-found-in__line">90</span>
  688. </aside>
  689. <p class="phpdocumentor-summary">Map of built-in output modes =&gt; modules</p>
  690. <code class="phpdocumentor-signature phpdocumentor-code ">
  691. <span class="phpdocumentor-signature__visibility">public</span>
  692. <span class="phpdocumentor-signature__type">array&lt;string|int, string&gt;</span>
  693. <span class="phpdocumentor-signature__name">OUTPUT_MODES</span>
  694. = <span class="phpdocumentor-signature__default-value">[self::OUTPUT_MARKUP_SVG =&gt; \chillerlan\QRCode\Output\QRMarkup::class, self::OUTPUT_MARKUP_HTML =&gt; \chillerlan\QRCode\Output\QRMarkup::class, self::OUTPUT_IMAGE_PNG =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::OUTPUT_IMAGE_GIF =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::OUTPUT_IMAGE_JPG =&gt; \chillerlan\QRCode\Output\QRGdImage::class, self::OUTPUT_STRING_JSON =&gt; \chillerlan\QRCode\Output\QRString::class, self::OUTPUT_STRING_TEXT =&gt; \chillerlan\QRCode\Output\QRString::class, self::OUTPUT_IMAGICK =&gt; \chillerlan\QRCode\Output\QRImagick::class, self::OUTPUT_FPDF =&gt; \chillerlan\QRCode\Output\QRFpdf::class]</span>
  695. </code>
  696. </article>
  697. <article class="phpdocumentor-element -constant -public ">
  698. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_STRING_JSON">
  699. OUTPUT_STRING_JSON
  700. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_STRING_JSON" class="headerlink"><i class="fas fa-link"></i></a>
  701. </h4>
  702. <aside class="phpdocumentor-element-found-in">
  703. <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>
  704. :
  705. <span class="phpdocumentor-element-found-in__line">75</span>
  706. </aside>
  707. <code class="phpdocumentor-signature phpdocumentor-code ">
  708. <span class="phpdocumentor-signature__visibility">public</span>
  709. <span class="phpdocumentor-signature__type">string</span>
  710. <span class="phpdocumentor-signature__name">OUTPUT_STRING_JSON</span>
  711. = <span class="phpdocumentor-signature__default-value">&#039;json&#039;</span>
  712. </code>
  713. </article>
  714. <article class="phpdocumentor-element -constant -public ">
  715. <h4 class="phpdocumentor-element__name" id="constant_OUTPUT_STRING_TEXT">
  716. OUTPUT_STRING_TEXT
  717. <a href="classes/chillerlan-QRCode-QRCode.html#constant_OUTPUT_STRING_TEXT" class="headerlink"><i class="fas fa-link"></i></a>
  718. </h4>
  719. <aside class="phpdocumentor-element-found-in">
  720. <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>
  721. :
  722. <span class="phpdocumentor-element-found-in__line">77</span>
  723. </aside>
  724. <code class="phpdocumentor-signature phpdocumentor-code ">
  725. <span class="phpdocumentor-signature__visibility">public</span>
  726. <span class="phpdocumentor-signature__type">string</span>
  727. <span class="phpdocumentor-signature__name">OUTPUT_STRING_TEXT</span>
  728. = <span class="phpdocumentor-signature__default-value">&#039;text&#039;</span>
  729. </code>
  730. </article>
  731. <article class="phpdocumentor-element -constant -public ">
  732. <h4 class="phpdocumentor-element__name" id="constant_VERSION_AUTO">
  733. VERSION_AUTO
  734. <a href="classes/chillerlan-QRCode-QRCode.html#constant_VERSION_AUTO" 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">32</span>
  740. </aside>
  741. <code class="phpdocumentor-signature phpdocumentor-code ">
  742. <span class="phpdocumentor-signature__visibility">public</span>
  743. <span class="phpdocumentor-signature__type">int</span>
  744. <span class="phpdocumentor-signature__name">VERSION_AUTO</span>
  745. = <span class="phpdocumentor-signature__default-value">-1</span>
  746. </code>
  747. </article>
  748. </section>
  749. <section class="phpdocumentor-properties">
  750. <h3 class="phpdocumentor-elements__header" id="properties">
  751. Properties
  752. <a href="classes/chillerlan-QRCode-QRCode.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  753. </h3>
  754. <article
  755. class="
  756. phpdocumentor-element
  757. -property
  758. -protected
  759. "
  760. >
  761. <h4 class="phpdocumentor-element__name" id="property_dataSegments">
  762. $dataSegments
  763. <a href="classes/chillerlan-QRCode-QRCode.html#property_dataSegments" class="headerlink"><i class="fas fa-link"></i></a>
  764. <span class="phpdocumentor-element__modifiers">
  765. </span>
  766. </h4>
  767. <aside class="phpdocumentor-element-found-in">
  768. <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>
  769. :
  770. <span class="phpdocumentor-element-found-in__line">116</span>
  771. </aside>
  772. <p class="phpdocumentor-summary">A collection of one or more data segments of [classname, data] to write</p>
  773. <code class="phpdocumentor-code phpdocumentor-signature ">
  774. <span class="phpdocumentor-signature__visibility">protected</span>
  775. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  776. <span class="phpdocumentor-signature__name">$dataSegments</span>
  777. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  778. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  779. Tags
  780. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  781. </h5>
  782. <dl class="phpdocumentor-tag-list">
  783. <dt class="phpdocumentor-tag-list__entry">
  784. <span class="phpdocumentor-tag__name">see</span>
  785. </dt>
  786. <dd class="phpdocumentor-tag-list__definition">
  787. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeInterface">QRDataModeInterface</abbr></a></span>
  788. </dd>
  789. </dl>
  790. </article>
  791. <article
  792. class="
  793. phpdocumentor-element
  794. -property
  795. -protected
  796. "
  797. >
  798. <h4 class="phpdocumentor-element__name" id="property_options">
  799. $options
  800. <a href="classes/chillerlan-QRCode-QRCode.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  801. <span class="phpdocumentor-element__modifiers">
  802. </span>
  803. </h4>
  804. <aside class="phpdocumentor-element-found-in">
  805. <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>
  806. :
  807. <span class="phpdocumentor-element-found-in__line">107</span>
  808. </aside>
  809. <p class="phpdocumentor-summary">The settings container</p>
  810. <code class="phpdocumentor-code phpdocumentor-signature ">
  811. <span class="phpdocumentor-signature__visibility">protected</span>
  812. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  813. <span class="phpdocumentor-signature__name">$options</span>
  814. </code>
  815. </article>
  816. </section>
  817. <section class="phpdocumentor-methods">
  818. <h3 class="phpdocumentor-elements__header" id="methods">
  819. Methods
  820. <a href="classes/chillerlan-QRCode-QRCode.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  821. </h3>
  822. <article
  823. class="phpdocumentor-element
  824. -method
  825. -public
  826. "
  827. >
  828. <h4 class="phpdocumentor-element__name" id="method___construct">
  829. __construct()
  830. <a href="classes/chillerlan-QRCode-QRCode.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  831. </h4>
  832. <aside class="phpdocumentor-element-found-in">
  833. <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>
  834. :
  835. <span class="phpdocumentor-element-found-in__line">123</span>
  836. </aside>
  837. <p class="phpdocumentor-summary">QRCode constructor.</p>
  838. <code class="phpdocumentor-code phpdocumentor-signature ">
  839. <span class="phpdocumentor-signature__visibility">public</span>
  840. <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>
  841. <section class="phpdocumentor-description"><p>Sets the options instance</p>
  842. </section>
  843. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  844. <dl class="phpdocumentor-argument-list">
  845. <dt class="phpdocumentor-argument-list__entry">
  846. <span class="phpdocumentor-signature__argument__name">$options</span>
  847. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  848. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  849. <dd class="phpdocumentor-argument-list__definition">
  850. <section class="phpdocumentor-description"></section>
  851. </dd>
  852. </dl>
  853. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  854. <span class="phpdocumentor-signature__response_type">mixed</span>
  855. &mdash;
  856. </article>
  857. <article
  858. class="phpdocumentor-element
  859. -method
  860. -public
  861. "
  862. >
  863. <h4 class="phpdocumentor-element__name" id="method_addAlphaNumSegment">
  864. addAlphaNumSegment()
  865. <a href="classes/chillerlan-QRCode-QRCode.html#method_addAlphaNumSegment" class="headerlink"><i class="fas fa-link"></i></a>
  866. </h4>
  867. <aside class="phpdocumentor-element-found-in">
  868. <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>
  869. :
  870. <span class="phpdocumentor-element-found-in__line">302</span>
  871. </aside>
  872. <p class="phpdocumentor-summary">Adds an alphanumeric data segment</p>
  873. <code class="phpdocumentor-code phpdocumentor-signature ">
  874. <span class="phpdocumentor-signature__visibility">public</span>
  875. <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>
  876. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.3 - Alphanumeric Mode</p>
  877. </section>
  878. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  879. <dl class="phpdocumentor-argument-list">
  880. <dt class="phpdocumentor-argument-list__entry">
  881. <span class="phpdocumentor-signature__argument__name">$data</span>
  882. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  883. </dt>
  884. <dd class="phpdocumentor-argument-list__definition">
  885. <section class="phpdocumentor-description"></section>
  886. </dd>
  887. </dl>
  888. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  889. <span class="phpdocumentor-signature__response_type">self</span>
  890. &mdash;
  891. </article>
  892. <article
  893. class="phpdocumentor-element
  894. -method
  895. -public
  896. "
  897. >
  898. <h4 class="phpdocumentor-element__name" id="method_addByteSegment">
  899. addByteSegment()
  900. <a href="classes/chillerlan-QRCode-QRCode.html#method_addByteSegment" class="headerlink"><i class="fas fa-link"></i></a>
  901. </h4>
  902. <aside class="phpdocumentor-element-found-in">
  903. <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>
  904. :
  905. <span class="phpdocumentor-element-found-in__line">324</span>
  906. </aside>
  907. <p class="phpdocumentor-summary">Adds an 8-bit byte data segment</p>
  908. <code class="phpdocumentor-code phpdocumentor-signature ">
  909. <span class="phpdocumentor-signature__visibility">public</span>
  910. <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>
  911. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.4 - 8-bit Byte Mode</p>
  912. </section>
  913. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  914. <dl class="phpdocumentor-argument-list">
  915. <dt class="phpdocumentor-argument-list__entry">
  916. <span class="phpdocumentor-signature__argument__name">$data</span>
  917. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  918. </dt>
  919. <dd class="phpdocumentor-argument-list__definition">
  920. <section class="phpdocumentor-description"></section>
  921. </dd>
  922. </dl>
  923. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  924. <span class="phpdocumentor-signature__response_type">self</span>
  925. &mdash;
  926. </article>
  927. <article
  928. class="phpdocumentor-element
  929. -method
  930. -public
  931. "
  932. >
  933. <h4 class="phpdocumentor-element__name" id="method_addEciDesignator">
  934. addEciDesignator()
  935. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciDesignator" class="headerlink"><i class="fas fa-link"></i></a>
  936. </h4>
  937. <aside class="phpdocumentor-element-found-in">
  938. <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>
  939. :
  940. <span class="phpdocumentor-element-found-in__line">335</span>
  941. </aside>
  942. <p class="phpdocumentor-summary">Adds a standalone ECI designator</p>
  943. <code class="phpdocumentor-code phpdocumentor-signature ">
  944. <span class="phpdocumentor-signature__visibility">public</span>
  945. <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>
  946. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.1 - Extended Channel Interpretation (ECI) Mode</p>
  947. </section>
  948. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  949. <dl class="phpdocumentor-argument-list">
  950. <dt class="phpdocumentor-argument-list__entry">
  951. <span class="phpdocumentor-signature__argument__name">$encoding</span>
  952. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  953. </dt>
  954. <dd class="phpdocumentor-argument-list__definition">
  955. <section class="phpdocumentor-description"></section>
  956. </dd>
  957. </dl>
  958. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  959. <span class="phpdocumentor-signature__response_type">self</span>
  960. &mdash;
  961. </article>
  962. <article
  963. class="phpdocumentor-element
  964. -method
  965. -public
  966. "
  967. >
  968. <h4 class="phpdocumentor-element__name" id="method_addEciSegment">
  969. addEciSegment()
  970. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciSegment" class="headerlink"><i class="fas fa-link"></i></a>
  971. </h4>
  972. <aside class="phpdocumentor-element-found-in">
  973. <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>
  974. :
  975. <span class="phpdocumentor-element-found-in__line">348</span>
  976. </aside>
  977. <p class="phpdocumentor-summary">Adds an ECI data segment (including designator)</p>
  978. <code class="phpdocumentor-code phpdocumentor-signature ">
  979. <span class="phpdocumentor-signature__visibility">public</span>
  980. <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>
  981. <section class="phpdocumentor-description"><p>i hate this somehow but i'll leave it for now</p>
  982. </section>
  983. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  984. <dl class="phpdocumentor-argument-list">
  985. <dt class="phpdocumentor-argument-list__entry">
  986. <span class="phpdocumentor-signature__argument__name">$encoding</span>
  987. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  988. </dt>
  989. <dd class="phpdocumentor-argument-list__definition">
  990. <section class="phpdocumentor-description"></section>
  991. </dd>
  992. <dt class="phpdocumentor-argument-list__entry">
  993. <span class="phpdocumentor-signature__argument__name">$data</span>
  994. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  995. </dt>
  996. <dd class="phpdocumentor-argument-list__definition">
  997. <section class="phpdocumentor-description"></section>
  998. </dd>
  999. </dl>
  1000. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1001. Tags
  1002. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1003. </h5>
  1004. <dl class="phpdocumentor-tag-list">
  1005. <dt class="phpdocumentor-tag-list__entry">
  1006. <span class="phpdocumentor-tag__name">throws</span>
  1007. </dt>
  1008. <dd class="phpdocumentor-tag-list__definition">
  1009. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  1010. </dd>
  1011. </dl>
  1012. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1013. <span class="phpdocumentor-signature__response_type">self</span>
  1014. &mdash;
  1015. </article>
  1016. <article
  1017. class="phpdocumentor-element
  1018. -method
  1019. -public
  1020. "
  1021. >
  1022. <h4 class="phpdocumentor-element__name" id="method_addKanjiSegment">
  1023. addKanjiSegment()
  1024. <a href="classes/chillerlan-QRCode-QRCode.html#method_addKanjiSegment" class="headerlink"><i class="fas fa-link"></i></a>
  1025. </h4>
  1026. <aside class="phpdocumentor-element-found-in">
  1027. <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>
  1028. :
  1029. <span class="phpdocumentor-element-found-in__line">313</span>
  1030. </aside>
  1031. <p class="phpdocumentor-summary">Adds a Kanji data segment</p>
  1032. <code class="phpdocumentor-code phpdocumentor-signature ">
  1033. <span class="phpdocumentor-signature__visibility">public</span>
  1034. <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>
  1035. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.5 - Kanji Mode</p>
  1036. </section>
  1037. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1038. <dl class="phpdocumentor-argument-list">
  1039. <dt class="phpdocumentor-argument-list__entry">
  1040. <span class="phpdocumentor-signature__argument__name">$data</span>
  1041. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1042. </dt>
  1043. <dd class="phpdocumentor-argument-list__definition">
  1044. <section class="phpdocumentor-description"></section>
  1045. </dd>
  1046. </dl>
  1047. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1048. <span class="phpdocumentor-signature__response_type">self</span>
  1049. &mdash;
  1050. </article>
  1051. <article
  1052. class="phpdocumentor-element
  1053. -method
  1054. -public
  1055. "
  1056. >
  1057. <h4 class="phpdocumentor-element__name" id="method_addNumericSegment">
  1058. addNumericSegment()
  1059. <a href="classes/chillerlan-QRCode-QRCode.html#method_addNumericSegment" class="headerlink"><i class="fas fa-link"></i></a>
  1060. </h4>
  1061. <aside class="phpdocumentor-element-found-in">
  1062. <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>
  1063. :
  1064. <span class="phpdocumentor-element-found-in__line">291</span>
  1065. </aside>
  1066. <p class="phpdocumentor-summary">Adds a numeric data segment</p>
  1067. <code class="phpdocumentor-code phpdocumentor-signature ">
  1068. <span class="phpdocumentor-signature__visibility">public</span>
  1069. <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>
  1070. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.2 - Numeric Mode</p>
  1071. </section>
  1072. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1073. <dl class="phpdocumentor-argument-list">
  1074. <dt class="phpdocumentor-argument-list__entry">
  1075. <span class="phpdocumentor-signature__argument__name">$data</span>
  1076. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1077. </dt>
  1078. <dd class="phpdocumentor-argument-list__definition">
  1079. <section class="phpdocumentor-description"></section>
  1080. </dd>
  1081. </dl>
  1082. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1083. <span class="phpdocumentor-signature__response_type">self</span>
  1084. &mdash;
  1085. </article>
  1086. <article
  1087. class="phpdocumentor-element
  1088. -method
  1089. -public
  1090. "
  1091. >
  1092. <h4 class="phpdocumentor-element__name" id="method_clearSegments">
  1093. clearSegments()
  1094. <a href="classes/chillerlan-QRCode-QRCode.html#method_clearSegments" class="headerlink"><i class="fas fa-link"></i></a>
  1095. </h4>
  1096. <aside class="phpdocumentor-element-found-in">
  1097. <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>
  1098. :
  1099. <span class="phpdocumentor-element-found-in__line">280</span>
  1100. </aside>
  1101. <p class="phpdocumentor-summary">Clears the data segments array</p>
  1102. <code class="phpdocumentor-code phpdocumentor-signature ">
  1103. <span class="phpdocumentor-signature__visibility">public</span>
  1104. <span class="phpdocumentor-signature__name">clearSegments</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
  1105. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1106. <span class="phpdocumentor-signature__response_type">self</span>
  1107. &mdash;
  1108. </article>
  1109. <article
  1110. class="phpdocumentor-element
  1111. -method
  1112. -public
  1113. "
  1114. >
  1115. <h4 class="phpdocumentor-element__name" id="method_getMatrix">
  1116. getMatrix()
  1117. <a href="classes/chillerlan-QRCode-QRCode.html#method_getMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  1118. </h4>
  1119. <aside class="phpdocumentor-element-found-in">
  1120. <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>
  1121. :
  1122. <span class="phpdocumentor-element-found-in__line">154</span>
  1123. </aside>
  1124. <p class="phpdocumentor-summary">Returns a QRMatrix object for the given $data and current QROptions</p>
  1125. <code class="phpdocumentor-code phpdocumentor-signature ">
  1126. <span class="phpdocumentor-signature__visibility">public</span>
  1127. <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>
  1128. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1129. Tags
  1130. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1131. </h5>
  1132. <dl class="phpdocumentor-tag-list">
  1133. <dt class="phpdocumentor-tag-list__entry">
  1134. <span class="phpdocumentor-tag__name">throws</span>
  1135. </dt>
  1136. <dd class="phpdocumentor-tag-list__definition">
  1137. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRCodeDataException.html"><abbr title="\chillerlan\QRCode\Data\QRCodeDataException">QRCodeDataException</abbr></a></span>
  1138. </dd>
  1139. </dl>
  1140. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1141. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  1142. &mdash;
  1143. </article>
  1144. <article
  1145. class="phpdocumentor-element
  1146. -method
  1147. -public
  1148. -deprecated "
  1149. >
  1150. <h4 class="phpdocumentor-element__name" id="method_isAlphaNum">
  1151. isAlphaNum()
  1152. <a href="classes/chillerlan-QRCode-QRCode.html#method_isAlphaNum" class="headerlink"><i class="fas fa-link"></i></a>
  1153. </h4>
  1154. <aside class="phpdocumentor-element-found-in">
  1155. <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>
  1156. :
  1157. <span class="phpdocumentor-element-found-in__line">241</span>
  1158. </aside>
  1159. <p class="phpdocumentor-summary">checks if a string qualifies as alphanumeric (convenience method)</p>
  1160. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1161. <span class="phpdocumentor-signature__visibility">public</span>
  1162. <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>
  1163. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1164. <dl class="phpdocumentor-argument-list">
  1165. <dt class="phpdocumentor-argument-list__entry">
  1166. <span class="phpdocumentor-signature__argument__name">$string</span>
  1167. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1168. </dt>
  1169. <dd class="phpdocumentor-argument-list__definition">
  1170. <section class="phpdocumentor-description"></section>
  1171. </dd>
  1172. </dl>
  1173. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1174. Tags
  1175. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1176. </h5>
  1177. <dl class="phpdocumentor-tag-list">
  1178. <dt class="phpdocumentor-tag-list__entry">
  1179. <span class="phpdocumentor-tag__name">deprecated</span>
  1180. </dt>
  1181. <dd class="phpdocumentor-tag-list__definition">
  1182. <span class="phpdocumentor-tag-link">5.0.0</span>
  1183. </dd>
  1184. <dt class="phpdocumentor-tag-list__entry">
  1185. <span class="phpdocumentor-tag__name">see</span>
  1186. </dt>
  1187. <dd class="phpdocumentor-tag-list__definition">
  1188. <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>
  1189. </dd>
  1190. <dt class="phpdocumentor-tag-list__entry">
  1191. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1192. </dt>
  1193. <dd class="phpdocumentor-tag-list__definition">
  1194. </dd>
  1195. </dl>
  1196. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1197. <span class="phpdocumentor-signature__response_type">bool</span>
  1198. &mdash;
  1199. </article>
  1200. <article
  1201. class="phpdocumentor-element
  1202. -method
  1203. -public
  1204. -deprecated "
  1205. >
  1206. <h4 class="phpdocumentor-element__name" id="method_isByte">
  1207. isByte()
  1208. <a href="classes/chillerlan-QRCode-QRCode.html#method_isByte" class="headerlink"><i class="fas fa-link"></i></a>
  1209. </h4>
  1210. <aside class="phpdocumentor-element-found-in">
  1211. <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>
  1212. :
  1213. <span class="phpdocumentor-element-found-in__line">263</span>
  1214. </aside>
  1215. <p class="phpdocumentor-summary">a dummy (convenience method)</p>
  1216. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1217. <span class="phpdocumentor-signature__visibility">public</span>
  1218. <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>
  1219. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1220. <dl class="phpdocumentor-argument-list">
  1221. <dt class="phpdocumentor-argument-list__entry">
  1222. <span class="phpdocumentor-signature__argument__name">$string</span>
  1223. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1224. </dt>
  1225. <dd class="phpdocumentor-argument-list__definition">
  1226. <section class="phpdocumentor-description"></section>
  1227. </dd>
  1228. </dl>
  1229. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1230. Tags
  1231. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1232. </h5>
  1233. <dl class="phpdocumentor-tag-list">
  1234. <dt class="phpdocumentor-tag-list__entry">
  1235. <span class="phpdocumentor-tag__name">deprecated</span>
  1236. </dt>
  1237. <dd class="phpdocumentor-tag-list__definition">
  1238. <span class="phpdocumentor-tag-link">5.0.0</span>
  1239. </dd>
  1240. <dt class="phpdocumentor-tag-list__entry">
  1241. <span class="phpdocumentor-tag__name">see</span>
  1242. </dt>
  1243. <dd class="phpdocumentor-tag-list__definition">
  1244. <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>
  1245. </dd>
  1246. <dt class="phpdocumentor-tag-list__entry">
  1247. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1248. </dt>
  1249. <dd class="phpdocumentor-tag-list__definition">
  1250. </dd>
  1251. </dl>
  1252. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1253. <span class="phpdocumentor-signature__response_type">bool</span>
  1254. &mdash;
  1255. </article>
  1256. <article
  1257. class="phpdocumentor-element
  1258. -method
  1259. -public
  1260. -deprecated "
  1261. >
  1262. <h4 class="phpdocumentor-element__name" id="method_isKanji">
  1263. isKanji()
  1264. <a href="classes/chillerlan-QRCode-QRCode.html#method_isKanji" class="headerlink"><i class="fas fa-link"></i></a>
  1265. </h4>
  1266. <aside class="phpdocumentor-element-found-in">
  1267. <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>
  1268. :
  1269. <span class="phpdocumentor-element-found-in__line">252</span>
  1270. </aside>
  1271. <p class="phpdocumentor-summary">checks if a string qualifies as Kanji (convenience method)</p>
  1272. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1273. <span class="phpdocumentor-signature__visibility">public</span>
  1274. <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>
  1275. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1276. <dl class="phpdocumentor-argument-list">
  1277. <dt class="phpdocumentor-argument-list__entry">
  1278. <span class="phpdocumentor-signature__argument__name">$string</span>
  1279. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1280. </dt>
  1281. <dd class="phpdocumentor-argument-list__definition">
  1282. <section class="phpdocumentor-description"></section>
  1283. </dd>
  1284. </dl>
  1285. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1286. Tags
  1287. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1288. </h5>
  1289. <dl class="phpdocumentor-tag-list">
  1290. <dt class="phpdocumentor-tag-list__entry">
  1291. <span class="phpdocumentor-tag__name">deprecated</span>
  1292. </dt>
  1293. <dd class="phpdocumentor-tag-list__definition">
  1294. <span class="phpdocumentor-tag-link">5.0.0</span>
  1295. </dd>
  1296. <dt class="phpdocumentor-tag-list__entry">
  1297. <span class="phpdocumentor-tag__name">see</span>
  1298. </dt>
  1299. <dd class="phpdocumentor-tag-list__definition">
  1300. <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>
  1301. </dd>
  1302. <dt class="phpdocumentor-tag-list__entry">
  1303. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1304. </dt>
  1305. <dd class="phpdocumentor-tag-list__definition">
  1306. </dd>
  1307. </dl>
  1308. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1309. <span class="phpdocumentor-signature__response_type">bool</span>
  1310. &mdash;
  1311. </article>
  1312. <article
  1313. class="phpdocumentor-element
  1314. -method
  1315. -public
  1316. -deprecated "
  1317. >
  1318. <h4 class="phpdocumentor-element__name" id="method_isNumber">
  1319. isNumber()
  1320. <a href="classes/chillerlan-QRCode-QRCode.html#method_isNumber" class="headerlink"><i class="fas fa-link"></i></a>
  1321. </h4>
  1322. <aside class="phpdocumentor-element-found-in">
  1323. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1324. :
  1325. <span class="phpdocumentor-element-found-in__line">230</span>
  1326. </aside>
  1327. <p class="phpdocumentor-summary">checks if a string qualifies as numeric (convenience method)</p>
  1328. <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
  1329. <span class="phpdocumentor-signature__visibility">public</span>
  1330. <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>
  1331. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1332. <dl class="phpdocumentor-argument-list">
  1333. <dt class="phpdocumentor-argument-list__entry">
  1334. <span class="phpdocumentor-signature__argument__name">$string</span>
  1335. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1336. </dt>
  1337. <dd class="phpdocumentor-argument-list__definition">
  1338. <section class="phpdocumentor-description"></section>
  1339. </dd>
  1340. </dl>
  1341. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1342. Tags
  1343. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1344. </h5>
  1345. <dl class="phpdocumentor-tag-list">
  1346. <dt class="phpdocumentor-tag-list__entry">
  1347. <span class="phpdocumentor-tag__name">deprecated</span>
  1348. </dt>
  1349. <dd class="phpdocumentor-tag-list__definition">
  1350. <span class="phpdocumentor-tag-link">5.0.0</span>
  1351. </dd>
  1352. <dt class="phpdocumentor-tag-list__entry">
  1353. <span class="phpdocumentor-tag__name">see</span>
  1354. </dt>
  1355. <dd class="phpdocumentor-tag-list__definition">
  1356. <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>
  1357. </dd>
  1358. <dt class="phpdocumentor-tag-list__entry">
  1359. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  1360. </dt>
  1361. <dd class="phpdocumentor-tag-list__definition">
  1362. </dd>
  1363. </dl>
  1364. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1365. <span class="phpdocumentor-signature__response_type">bool</span>
  1366. &mdash;
  1367. </article>
  1368. <article
  1369. class="phpdocumentor-element
  1370. -method
  1371. -public
  1372. "
  1373. >
  1374. <h4 class="phpdocumentor-element__name" id="method_readFromBlob">
  1375. readFromBlob()
  1376. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromBlob" class="headerlink"><i class="fas fa-link"></i></a>
  1377. </h4>
  1378. <aside class="phpdocumentor-element-found-in">
  1379. <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>
  1380. :
  1381. <span class="phpdocumentor-element-found-in__line">376</span>
  1382. </aside>
  1383. <p class="phpdocumentor-summary">Reads a QR Code from the given data blob</p>
  1384. <code class="phpdocumentor-code phpdocumentor-signature ">
  1385. <span class="phpdocumentor-signature__visibility">public</span>
  1386. <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>
  1387. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1388. <dl class="phpdocumentor-argument-list">
  1389. <dt class="phpdocumentor-argument-list__entry">
  1390. <span class="phpdocumentor-signature__argument__name">$blob</span>
  1391. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1392. </dt>
  1393. <dd class="phpdocumentor-argument-list__definition">
  1394. <section class="phpdocumentor-description"></section>
  1395. </dd>
  1396. </dl>
  1397. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1398. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  1399. &mdash;
  1400. </article>
  1401. <article
  1402. class="phpdocumentor-element
  1403. -method
  1404. -public
  1405. "
  1406. >
  1407. <h4 class="phpdocumentor-element__name" id="method_readFromFile">
  1408. readFromFile()
  1409. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromFile" class="headerlink"><i class="fas fa-link"></i></a>
  1410. </h4>
  1411. <aside class="phpdocumentor-element-found-in">
  1412. <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>
  1413. :
  1414. <span class="phpdocumentor-element-found-in__line">369</span>
  1415. </aside>
  1416. <p class="phpdocumentor-summary">Reads a QR Code from a given file</p>
  1417. <code class="phpdocumentor-code phpdocumentor-signature ">
  1418. <span class="phpdocumentor-signature__visibility">public</span>
  1419. <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>
  1420. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1421. <dl class="phpdocumentor-argument-list">
  1422. <dt class="phpdocumentor-argument-list__entry">
  1423. <span class="phpdocumentor-signature__argument__name">$path</span>
  1424. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1425. </dt>
  1426. <dd class="phpdocumentor-argument-list__definition">
  1427. <section class="phpdocumentor-description"></section>
  1428. </dd>
  1429. </dl>
  1430. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1431. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  1432. &mdash;
  1433. </article>
  1434. <article
  1435. class="phpdocumentor-element
  1436. -method
  1437. -public
  1438. "
  1439. >
  1440. <h4 class="phpdocumentor-element__name" id="method_readFromSource">
  1441. readFromSource()
  1442. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromSource" class="headerlink"><i class="fas fa-link"></i></a>
  1443. </h4>
  1444. <aside class="phpdocumentor-element-found-in">
  1445. <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>
  1446. :
  1447. <span class="phpdocumentor-element-found-in__line">383</span>
  1448. </aside>
  1449. <p class="phpdocumentor-summary">Reads a QR Code from the given luminance source</p>
  1450. <code class="phpdocumentor-code phpdocumentor-signature ">
  1451. <span class="phpdocumentor-signature__visibility">public</span>
  1452. <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>
  1453. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1454. <dl class="phpdocumentor-argument-list">
  1455. <dt class="phpdocumentor-argument-list__entry">
  1456. <span class="phpdocumentor-signature__argument__name">$source</span>
  1457. : <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>
  1458. </dt>
  1459. <dd class="phpdocumentor-argument-list__definition">
  1460. <section class="phpdocumentor-description"></section>
  1461. </dd>
  1462. </dl>
  1463. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1464. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  1465. &mdash;
  1466. </article>
  1467. <article
  1468. class="phpdocumentor-element
  1469. -method
  1470. -public
  1471. "
  1472. >
  1473. <h4 class="phpdocumentor-element__name" id="method_render">
  1474. render()
  1475. <a href="classes/chillerlan-QRCode-QRCode.html#method_render" class="headerlink"><i class="fas fa-link"></i></a>
  1476. </h4>
  1477. <aside class="phpdocumentor-element-found-in">
  1478. <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>
  1479. :
  1480. <span class="phpdocumentor-element-found-in__line">132</span>
  1481. </aside>
  1482. <p class="phpdocumentor-summary">Renders a QR Code for the given $data and QROptions</p>
  1483. <code class="phpdocumentor-code phpdocumentor-signature ">
  1484. <span class="phpdocumentor-signature__visibility">public</span>
  1485. <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>
  1486. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1487. <dl class="phpdocumentor-argument-list">
  1488. <dt class="phpdocumentor-argument-list__entry">
  1489. <span class="phpdocumentor-signature__argument__name">$data</span>
  1490. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1491. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1492. <dd class="phpdocumentor-argument-list__definition">
  1493. <section class="phpdocumentor-description"></section>
  1494. </dd>
  1495. <dt class="phpdocumentor-argument-list__entry">
  1496. <span class="phpdocumentor-signature__argument__name">$file</span>
  1497. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1498. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1499. <dd class="phpdocumentor-argument-list__definition">
  1500. <section class="phpdocumentor-description"></section>
  1501. </dd>
  1502. </dl>
  1503. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1504. <span class="phpdocumentor-signature__response_type">mixed</span>
  1505. &mdash;
  1506. </article>
  1507. <article
  1508. class="phpdocumentor-element
  1509. -method
  1510. -protected
  1511. "
  1512. >
  1513. <h4 class="phpdocumentor-element__name" id="method_addSegment">
  1514. addSegment()
  1515. <a href="classes/chillerlan-QRCode-QRCode.html#method_addSegment" class="headerlink"><i class="fas fa-link"></i></a>
  1516. </h4>
  1517. <aside class="phpdocumentor-element-found-in">
  1518. <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>
  1519. :
  1520. <span class="phpdocumentor-element-found-in__line">273</span>
  1521. </aside>
  1522. <p class="phpdocumentor-summary">Adds a data segment</p>
  1523. <code class="phpdocumentor-code phpdocumentor-signature ">
  1524. <span class="phpdocumentor-signature__visibility">protected</span>
  1525. <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>
  1526. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.6 - Mixing modes
  1527. ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length</p>
  1528. </section>
  1529. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1530. <dl class="phpdocumentor-argument-list">
  1531. <dt class="phpdocumentor-argument-list__entry">
  1532. <span class="phpdocumentor-signature__argument__name">$segment</span>
  1533. : <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>
  1534. </dt>
  1535. <dd class="phpdocumentor-argument-list__definition">
  1536. <section class="phpdocumentor-description"></section>
  1537. </dd>
  1538. </dl>
  1539. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1540. <span class="phpdocumentor-signature__response_type">void</span>
  1541. &mdash;
  1542. </article>
  1543. <article
  1544. class="phpdocumentor-element
  1545. -method
  1546. -protected
  1547. "
  1548. >
  1549. <h4 class="phpdocumentor-element__name" id="method_initCustomOutputInterface">
  1550. initCustomOutputInterface()
  1551. <a href="classes/chillerlan-QRCode-QRCode.html#method_initCustomOutputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  1552. </h4>
  1553. <aside class="phpdocumentor-element-found-in">
  1554. <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>
  1555. :
  1556. <span class="phpdocumentor-element-found-in__line">209</span>
  1557. </aside>
  1558. <p class="phpdocumentor-summary">initializes a custom output module after checking the existence of the class and if it implemnts the required interface</p>
  1559. <code class="phpdocumentor-code phpdocumentor-signature ">
  1560. <span class="phpdocumentor-signature__visibility">protected</span>
  1561. <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>
  1562. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1563. Tags
  1564. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1565. </h5>
  1566. <dl class="phpdocumentor-tag-list">
  1567. <dt class="phpdocumentor-tag-list__entry">
  1568. <span class="phpdocumentor-tag__name">throws</span>
  1569. </dt>
  1570. <dd class="phpdocumentor-tag-list__definition">
  1571. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1572. </dd>
  1573. </dl>
  1574. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1575. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></span>
  1576. &mdash;
  1577. </article>
  1578. <article
  1579. class="phpdocumentor-element
  1580. -method
  1581. -protected
  1582. "
  1583. >
  1584. <h4 class="phpdocumentor-element__name" id="method_initOutputInterface">
  1585. initOutputInterface()
  1586. <a href="classes/chillerlan-QRCode-QRCode.html#method_initOutputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  1587. </h4>
  1588. <aside class="phpdocumentor-element-found-in">
  1589. <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>
  1590. :
  1591. <span class="phpdocumentor-element-found-in__line">189</span>
  1592. </aside>
  1593. <p class="phpdocumentor-summary">returns a fresh (built-in) QROutputInterface</p>
  1594. <code class="phpdocumentor-code phpdocumentor-signature ">
  1595. <span class="phpdocumentor-signature__visibility">protected</span>
  1596. <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>
  1597. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1598. Tags
  1599. <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1600. </h5>
  1601. <dl class="phpdocumentor-tag-list">
  1602. <dt class="phpdocumentor-tag-list__entry">
  1603. <span class="phpdocumentor-tag__name">throws</span>
  1604. </dt>
  1605. <dd class="phpdocumentor-tag-list__definition">
  1606. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1607. </dd>
  1608. </dl>
  1609. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1610. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></span>
  1611. &mdash;
  1612. </article>
  1613. </section>
  1614. <script type="text/javascript">
  1615. function loadExternalCodeSnippets(line) {
  1616. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1617. var src = pre.getAttribute('data-src').replace( /\\/g, '/');
  1618. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  1619. var language = 'php';
  1620. var code = document.createElement('code');
  1621. code.className = 'language-' + language;
  1622. pre.textContent = '';
  1623. pre.setAttribute('data-line', line)
  1624. code.textContent = 'Loading…';
  1625. pre.appendChild(code);
  1626. var xhr = new XMLHttpRequest();
  1627. xhr.open('GET', src, true);
  1628. xhr.onreadystatechange = function () {
  1629. if (xhr.readyState == 4) {
  1630. if (xhr.status < 400 && xhr.responseText) {
  1631. code.textContent = xhr.responseText;
  1632. Prism.highlightElement(code);
  1633. }
  1634. else if (xhr.status >= 400) {
  1635. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1636. }
  1637. else {
  1638. code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
  1639. }
  1640. }
  1641. };
  1642. xhr.send(null);
  1643. });
  1644. }
  1645. var modals = document.querySelectorAll("[data-modal]");
  1646. modals.forEach(function (trigger) {
  1647. trigger.addEventListener("click", function (event) {
  1648. //event.preventDefault();
  1649. const modal = document.getElementById(trigger.dataset.modal);
  1650. modal.classList.add("phpdocumentor-modal__open");
  1651. loadExternalCodeSnippets(trigger.dataset.line)
  1652. const exits = modal.querySelectorAll("[data-exit-button]");
  1653. exits.forEach(function (exit) {
  1654. exit.addEventListener("click", function (event) {
  1655. event.preventDefault();
  1656. modal.classList.remove("phpdocumentor-modal__open");
  1657. });
  1658. });
  1659. });
  1660. });
  1661. </script>
  1662. </article>
  1663. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1664. <section class="phpdocumentor-search-results__dialog">
  1665. <header class="phpdocumentor-search-results__header">
  1666. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1667. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1668. </header>
  1669. <section class="phpdocumentor-search-results__body">
  1670. <ul class="phpdocumentor-search-results__entries"></ul>
  1671. </section>
  1672. </section>
  1673. </section>
  1674. </div>
  1675. </div>
  1676. <a href="classes/chillerlan-QRCode-QRCode.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1677. </main>
  1678. <script>
  1679. cssVars({});
  1680. </script>
  1681. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1682. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1683. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1684. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1685. </body>
  1686. </html>