chillerlan-QRCode-QRCode.html 98 KB

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