chillerlan-QRCode-QRCode.html 109 KB

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