chillerlan-QRCode-QRCode.html 98 KB

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