chillerlan-QRCode-QRCode.html 83 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710
  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=Open+Sans:wght@100;200;300;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/template.js"></script>
  22. <script src="js/search.js"></script>
  23. <script defer src="js/searchIndex.js"></script>
  24. </head>
  25. <body id="top">
  26. <header class="phpdocumentor-header phpdocumentor-section">
  27. <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
  28. <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
  29. <label class="phpdocumentor-header__menu-icon" for="menu-button">
  30. <i class="fas fa-bars"></i>
  31. </label>
  32. <section data-search-form class="phpdocumentor-search">
  33. <label>
  34. <span class="visually-hidden">Search for</span>
  35. <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
  36. <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
  37. <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
  38. </svg>
  39. <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
  40. </label>
  41. </section>
  42. <nav class="phpdocumentor-topnav">
  43. <ul class="phpdocumentor-topnav__menu">
  44. <li class="phpdocumentor-topnav__menu-item -menu">
  45. <a href="https://php-qrcode.readthedocs.io">
  46. <span>
  47. User Manual
  48. </span>
  49. </a>
  50. </li>
  51. <li class="phpdocumentor-topnav__menu-item -social">
  52. <a href="https://github.com/chillerlan/php-qrcode">
  53. <span>
  54. <i class="fab fa-github"></i>
  55. </span>
  56. </a>
  57. </li>
  58. <li class="phpdocumentor-topnav__menu-item -social">
  59. <a href="https://github.com/chillerlan/php-qrcode/discussions">
  60. <span>
  61. <i class="fas fa-envelope-open-text"></i>
  62. </span>
  63. </a>
  64. </li>
  65. </ul>
  66. </nav>
  67. </header>
  68. <main class="phpdocumentor">
  69. <div class="phpdocumentor-section">
  70. <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
  71. <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
  72. Menu
  73. </label>
  74. <aside class="phpdocumentor-column -three phpdocumentor-sidebar">
  75. <section class="phpdocumentor-sidebar__category -namespaces">
  76. <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
  77. <h4 class="phpdocumentor-sidebar__root-namespace">
  78. <a href="namespaces/chillerlan.html" class="">chillerlan</a>
  79. </h4>
  80. <ul class="phpdocumentor-list">
  81. <li>
  82. <a href="namespaces/chillerlan-qrcode.html" class="">QRCode</a>
  83. </li>
  84. <li>
  85. <a href="namespaces/chillerlan-qrcodetest.html" class="">QRCodeTest</a>
  86. </li>
  87. </ul>
  88. </section>
  89. <section class="phpdocumentor-sidebar__category -packages">
  90. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  91. <h4 class="phpdocumentor-sidebar__root-namespace">
  92. <a href="packages/Application.html" class="">Application</a>
  93. </h4>
  94. </section>
  95. <section class="phpdocumentor-sidebar__category -reports">
  96. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  97. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  98. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  99. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  100. </section>
  101. <section class="phpdocumentor-sidebar__category -indices">
  102. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  103. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  104. </section>
  105. </aside>
  106. <div class="phpdocumentor-column -nine phpdocumentor-content">
  107. <section>
  108. <ul class="phpdocumentor-breadcrumbs">
  109. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  110. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  111. </ul>
  112. <article class="phpdocumentor-element -class">
  113. <h2 class="phpdocumentor-content__title">
  114. QRCode
  115. <div class="phpdocumentor-element__package">
  116. in package
  117. <ul class="phpdocumentor-breadcrumbs">
  118. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  119. </ul>
  120. </div>
  121. </h2>
  122. <div class="phpdocumentor-label-line">
  123. </div>
  124. <aside class="phpdocumentor-element-found-in">
  125. <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>
  126. :
  127. <span class="phpdocumentor-element-found-in__line">34</span>
  128. </aside>
  129. <p class="phpdocumentor-summary">Turns a text string into a Model 2 QR Code</p>
  130. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  131. Tags
  132. <a href="classes/chillerlan-QRCode-QRCode.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  133. </h5>
  134. <dl class="phpdocumentor-tag-list">
  135. <dt class="phpdocumentor-tag-list__entry">
  136. <span class="phpdocumentor-tag__name">see</span>
  137. </dt>
  138. <dd class="phpdocumentor-tag-list__definition">
  139. <span class="phpdocumentor-tag-link"><a href="https://github.com/kazuhikoarase/qrcode-generator/tree/master/php">https://github.com/kazuhikoarase/qrcode-generator/tree/master/php</a></span>
  140. </dd>
  141. <dt class="phpdocumentor-tag-list__entry">
  142. <span class="phpdocumentor-tag__name">see</span>
  143. </dt>
  144. <dd class="phpdocumentor-tag-list__definition">
  145. <span class="phpdocumentor-tag-link"><a href="https://www.qrcode.com/en/codes/model12.html">https://www.qrcode.com/en/codes/model12.html</a></span>
  146. </dd>
  147. <dt class="phpdocumentor-tag-list__entry">
  148. <span class="phpdocumentor-tag__name">see</span>
  149. </dt>
  150. <dd class="phpdocumentor-tag-list__definition">
  151. <span class="phpdocumentor-tag-link"><a href="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</a></span>
  152. </dd>
  153. <dt class="phpdocumentor-tag-list__entry">
  154. <span class="phpdocumentor-tag__name">see</span>
  155. </dt>
  156. <dd class="phpdocumentor-tag-list__definition">
  157. <span class="phpdocumentor-tag-link"><a href="https://en.wikipedia.org/wiki/QR_code">https://en.wikipedia.org/wiki/QR_code</a></span>
  158. </dd>
  159. <dt class="phpdocumentor-tag-list__entry">
  160. <span class="phpdocumentor-tag__name">see</span>
  161. </dt>
  162. <dd class="phpdocumentor-tag-list__definition">
  163. <span class="phpdocumentor-tag-link"><a href="https://www.thonky.com/qr-code-tutorial/">https://www.thonky.com/qr-code-tutorial/</a></span>
  164. </dd>
  165. </dl>
  166. <h3 id="toc">
  167. Table of Contents
  168. <a href="classes/chillerlan-QRCode-QRCode.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  169. </h3>
  170. <h4 id="toc-properties">
  171. Properties
  172. <a href="classes/chillerlan-QRCode-QRCode.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  173. </h4>
  174. <dl class="phpdocumentor-table-of-contents">
  175. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  176. <a class="" href="classes/chillerlan-QRCode-QRCode.html#property_dataSegments">$dataSegments</a>
  177. <span>
  178. &nbsp;: array&lt;string|int, <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeInterface">QRDataModeInterface</abbr></a>&gt; </span>
  179. </dt>
  180. <dd>A collection of one or more data segments of QRDataModeInterface instances to write</dd>
  181. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  182. <a class="" href="classes/chillerlan-QRCode-QRCode.html#property_luminanceSourceFQN">$luminanceSourceFQN</a>
  183. <span>
  184. &nbsp;: string </span>
  185. </dt>
  186. <dd>The luminance source for the reader</dd>
  187. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  188. <a class="" href="classes/chillerlan-QRCode-QRCode.html#property_options">$options</a>
  189. <span>
  190. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  191. </dt>
  192. <dd>The settings container</dd>
  193. </dl>
  194. <h4 id="toc-methods">
  195. Methods
  196. <a href="classes/chillerlan-QRCode-QRCode.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  197. </h4>
  198. <dl class="phpdocumentor-table-of-contents">
  199. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  200. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method___construct">__construct()</a>
  201. <span>
  202. &nbsp;: mixed </span>
  203. </dt>
  204. <dd>QRCode constructor.</dd>
  205. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  206. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_addAlphaNumSegment">addAlphaNumSegment()</a>
  207. <span>
  208. &nbsp;: static </span>
  209. </dt>
  210. <dd>Adds an alphanumeric data segment</dd>
  211. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  212. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_addByteSegment">addByteSegment()</a>
  213. <span>
  214. &nbsp;: static </span>
  215. </dt>
  216. <dd>Adds an 8-bit byte data segment</dd>
  217. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  218. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_addEciDesignator">addEciDesignator()</a>
  219. <span>
  220. &nbsp;: static </span>
  221. </dt>
  222. <dd>Adds a standalone ECI designator</dd>
  223. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  224. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_addEciSegment">addEciSegment()</a>
  225. <span>
  226. &nbsp;: static </span>
  227. </dt>
  228. <dd>Adds an ECI data segment (including designator)</dd>
  229. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  230. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_addHanziSegment">addHanziSegment()</a>
  231. <span>
  232. &nbsp;: static </span>
  233. </dt>
  234. <dd>Adds a Hanzi data segment (simplified Chinese 13-bit double-byte characters, GB2312/GB18030)</dd>
  235. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  236. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_addKanjiSegment">addKanjiSegment()</a>
  237. <span>
  238. &nbsp;: static </span>
  239. </dt>
  240. <dd>Adds a Kanji data segment (Japanese 13-bit double-byte characters, Shift-JIS)</dd>
  241. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  242. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_addNumericSegment">addNumericSegment()</a>
  243. <span>
  244. &nbsp;: static </span>
  245. </dt>
  246. <dd>Adds a numeric data segment</dd>
  247. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  248. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_addSegment">addSegment()</a>
  249. <span>
  250. &nbsp;: static </span>
  251. </dt>
  252. <dd>Adds a data segment</dd>
  253. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  254. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_clearSegments">clearSegments()</a>
  255. <span>
  256. &nbsp;: static </span>
  257. </dt>
  258. <dd>Clears the data segments array</dd>
  259. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  260. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_getQRMatrix">getQRMatrix()</a>
  261. <span>
  262. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  263. </dt>
  264. <dd>Returns a QRMatrix object for the given $data and current QROptions</dd>
  265. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  266. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_readFromBlob">readFromBlob()</a>
  267. <span>
  268. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  269. </dt>
  270. <dd>Reads a QR Code from the given data blob</dd>
  271. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  272. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_readFromFile">readFromFile()</a>
  273. <span>
  274. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  275. </dt>
  276. <dd>Reads a QR Code from a given file</dd>
  277. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  278. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_readFromSource">readFromSource()</a>
  279. <span>
  280. &nbsp;: <a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a> </span>
  281. </dt>
  282. <dd>Reads a QR Code from the given luminance source</dd>
  283. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  284. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_render">render()</a>
  285. <span>
  286. &nbsp;: mixed </span>
  287. </dt>
  288. <dd>Renders a QR Code for the given $data and QROptions, saves $file optionally</dd>
  289. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  290. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_renderMatrix">renderMatrix()</a>
  291. <span>
  292. &nbsp;: mixed </span>
  293. </dt>
  294. <dd>Renders a QR Code for the given QRMatrix and QROptions, saves $file optionally</dd>
  295. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  296. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_setOptions">setOptions()</a>
  297. <span>
  298. &nbsp;: static </span>
  299. </dt>
  300. <dd>Sets an options instance</dd>
  301. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  302. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_addMatrixModifications">addMatrixModifications()</a>
  303. <span>
  304. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  305. </dt>
  306. <dd>add matrix modifications after mask pattern evaluation and before handing over to output</dd>
  307. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  308. <a class="" href="classes/chillerlan-QRCode-QRCode.html#method_initOutputInterface">initOutputInterface()</a>
  309. <span>
  310. &nbsp;: <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a> </span>
  311. </dt>
  312. <dd>initializes a fresh built-in or custom QROutputInterface</dd>
  313. </dl>
  314. <section class="phpdocumentor-properties">
  315. <h3 class="phpdocumentor-elements__header" id="properties">
  316. Properties
  317. <a href="classes/chillerlan-QRCode-QRCode.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  318. </h3>
  319. <article
  320. class="
  321. phpdocumentor-element
  322. -property
  323. -protected
  324. "
  325. >
  326. <h4 class="phpdocumentor-element__name" id="property_dataSegments">
  327. $dataSegments
  328. <a href="classes/chillerlan-QRCode-QRCode.html#property_dataSegments" class="headerlink"><i class="fas fa-link"></i></a>
  329. <span class="phpdocumentor-element__modifiers">
  330. </span>
  331. </h4>
  332. <aside class="phpdocumentor-element-found-in">
  333. <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>
  334. :
  335. <span class="phpdocumentor-element-found-in__line">46</span>
  336. </aside>
  337. <p class="phpdocumentor-summary">A collection of one or more data segments of QRDataModeInterface instances to write</p>
  338. <code class="phpdocumentor-code phpdocumentor-signature ">
  339. <span class="phpdocumentor-signature__visibility">protected</span>
  340. <span class="phpdocumentor-signature__type">array&lt;string|int, <a href="classes/chillerlan-QRCode-Data-QRDataModeInterface.html"><abbr title="\chillerlan\QRCode\Data\QRDataModeInterface">QRDataModeInterface</abbr></a>&gt;</span>
  341. <span class="phpdocumentor-signature__name">$dataSegments</span>
  342. = <span class="phpdocumentor-signature__default-value">[]</span></code>
  343. </article>
  344. <article
  345. class="
  346. phpdocumentor-element
  347. -property
  348. -protected
  349. "
  350. >
  351. <h4 class="phpdocumentor-element__name" id="property_luminanceSourceFQN">
  352. $luminanceSourceFQN
  353. <a href="classes/chillerlan-QRCode-QRCode.html#property_luminanceSourceFQN" class="headerlink"><i class="fas fa-link"></i></a>
  354. <span class="phpdocumentor-element__modifiers">
  355. </span>
  356. </h4>
  357. <aside class="phpdocumentor-element-found-in">
  358. <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>
  359. :
  360. <span class="phpdocumentor-element-found-in__line">51</span>
  361. </aside>
  362. <p class="phpdocumentor-summary">The luminance source for the reader</p>
  363. <code class="phpdocumentor-code phpdocumentor-signature ">
  364. <span class="phpdocumentor-signature__visibility">protected</span>
  365. <span class="phpdocumentor-signature__type">string</span>
  366. <span class="phpdocumentor-signature__name">$luminanceSourceFQN</span>
  367. = <span class="phpdocumentor-signature__default-value">\chillerlan\QRCode\Common\GDLuminanceSource::class</span></code>
  368. </article>
  369. <article
  370. class="
  371. phpdocumentor-element
  372. -property
  373. -protected
  374. "
  375. >
  376. <h4 class="phpdocumentor-element__name" id="property_options">
  377. $options
  378. <a href="classes/chillerlan-QRCode-QRCode.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  379. <span class="phpdocumentor-element__modifiers">
  380. </span>
  381. </h4>
  382. <aside class="phpdocumentor-element-found-in">
  383. <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>
  384. :
  385. <span class="phpdocumentor-element-found-in__line">39</span>
  386. </aside>
  387. <p class="phpdocumentor-summary">The settings container</p>
  388. <code class="phpdocumentor-code phpdocumentor-signature ">
  389. <span class="phpdocumentor-signature__visibility">protected</span>
  390. <span class="phpdocumentor-signature__type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a></span>
  391. <span class="phpdocumentor-signature__name">$options</span>
  392. </code>
  393. </article>
  394. </section>
  395. <section class="phpdocumentor-methods">
  396. <h3 class="phpdocumentor-elements__header" id="methods">
  397. Methods
  398. <a href="classes/chillerlan-QRCode-QRCode.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  399. </h3>
  400. <article
  401. class="phpdocumentor-element
  402. -method
  403. -public
  404. "
  405. >
  406. <h4 class="phpdocumentor-element__name" id="method___construct">
  407. __construct()
  408. <a href="classes/chillerlan-QRCode-QRCode.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  409. </h4>
  410. <aside class="phpdocumentor-element-found-in">
  411. <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>
  412. :
  413. <span class="phpdocumentor-element-found-in__line">58</span>
  414. </aside>
  415. <p class="phpdocumentor-summary">QRCode constructor.</p>
  416. <code class="phpdocumentor-code phpdocumentor-signature ">
  417. <span class="phpdocumentor-signature__visibility">public</span>
  418. <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>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a>|iterable&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">new QROptions()</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  419. <div class="phpdocumentor-label-line">
  420. </div>
  421. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  422. <dl class="phpdocumentor-argument-list">
  423. <dt class="phpdocumentor-argument-list__entry">
  424. <span class="phpdocumentor-signature__argument__name">$options</span>
  425. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a>|iterable&lt;string|int, mixed&gt;</span>
  426. = <span class="phpdocumentor-signature__argument__default-value">new QROptions()</span> </dt>
  427. <dd class="phpdocumentor-argument-list__definition">
  428. </dd>
  429. </dl>
  430. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  431. Tags
  432. <a href="classes/chillerlan-QRCode-QRCode.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
  433. </h5>
  434. <dl class="phpdocumentor-tag-list">
  435. <dt class="phpdocumentor-tag-list__entry">
  436. <span class="phpdocumentor-tag__name">phpstan-param</span>
  437. </dt>
  438. <dd class="phpdocumentor-tag-list__definition">
  439. <section class="phpdocumentor-description"><p>array&lt;string, mixed&gt; $options</p>
  440. </section>
  441. </dd>
  442. </dl>
  443. </article>
  444. <article
  445. class="phpdocumentor-element
  446. -method
  447. -public
  448. "
  449. >
  450. <h4 class="phpdocumentor-element__name" id="method_addAlphaNumSegment">
  451. addAlphaNumSegment()
  452. <a href="classes/chillerlan-QRCode-QRCode.html#method_addAlphaNumSegment" class="headerlink"><i class="fas fa-link"></i></a>
  453. </h4>
  454. <aside class="phpdocumentor-element-found-in">
  455. <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>
  456. :
  457. <span class="phpdocumentor-element-found-in__line">207</span>
  458. </aside>
  459. <p class="phpdocumentor-summary">Adds an alphanumeric data segment</p>
  460. <code class="phpdocumentor-code phpdocumentor-signature ">
  461. <span class="phpdocumentor-signature__visibility">public</span>
  462. <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">static</span></code>
  463. <div class="phpdocumentor-label-line">
  464. </div>
  465. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.3 - Alphanumeric Mode</p>
  466. </section>
  467. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  468. <dl class="phpdocumentor-argument-list">
  469. <dt class="phpdocumentor-argument-list__entry">
  470. <span class="phpdocumentor-signature__argument__name">$data</span>
  471. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  472. </dt>
  473. <dd class="phpdocumentor-argument-list__definition">
  474. </dd>
  475. </dl>
  476. <section>
  477. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  478. <span class="phpdocumentor-signature__response_type">static</span>
  479. </section>
  480. </article>
  481. <article
  482. class="phpdocumentor-element
  483. -method
  484. -public
  485. "
  486. >
  487. <h4 class="phpdocumentor-element__name" id="method_addByteSegment">
  488. addByteSegment()
  489. <a href="classes/chillerlan-QRCode-QRCode.html#method_addByteSegment" class="headerlink"><i class="fas fa-link"></i></a>
  490. </h4>
  491. <aside class="phpdocumentor-element-found-in">
  492. <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>
  493. :
  494. <span class="phpdocumentor-element-found-in__line">234</span>
  495. </aside>
  496. <p class="phpdocumentor-summary">Adds an 8-bit byte data segment</p>
  497. <code class="phpdocumentor-code phpdocumentor-signature ">
  498. <span class="phpdocumentor-signature__visibility">public</span>
  499. <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">static</span></code>
  500. <div class="phpdocumentor-label-line">
  501. </div>
  502. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.4 - 8-bit Byte Mode</p>
  503. </section>
  504. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  505. <dl class="phpdocumentor-argument-list">
  506. <dt class="phpdocumentor-argument-list__entry">
  507. <span class="phpdocumentor-signature__argument__name">$data</span>
  508. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  509. </dt>
  510. <dd class="phpdocumentor-argument-list__definition">
  511. </dd>
  512. </dl>
  513. <section>
  514. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  515. <span class="phpdocumentor-signature__response_type">static</span>
  516. </section>
  517. </article>
  518. <article
  519. class="phpdocumentor-element
  520. -method
  521. -public
  522. "
  523. >
  524. <h4 class="phpdocumentor-element__name" id="method_addEciDesignator">
  525. addEciDesignator()
  526. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciDesignator" class="headerlink"><i class="fas fa-link"></i></a>
  527. </h4>
  528. <aside class="phpdocumentor-element-found-in">
  529. <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>
  530. :
  531. <span class="phpdocumentor-element-found-in__line">245</span>
  532. </aside>
  533. <p class="phpdocumentor-summary">Adds a standalone ECI designator</p>
  534. <code class="phpdocumentor-code phpdocumentor-signature ">
  535. <span class="phpdocumentor-signature__visibility">public</span>
  536. <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">static</span></code>
  537. <div class="phpdocumentor-label-line">
  538. </div>
  539. <section class="phpdocumentor-description"><p>The ECI designator must be followed by a Byte segment that contains the string encoded according to the given ECI charset</p>
  540. <p>ISO/IEC 18004:2000 8.3.1 - Extended Channel Interpretation (ECI) Mode</p>
  541. </section>
  542. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  543. <dl class="phpdocumentor-argument-list">
  544. <dt class="phpdocumentor-argument-list__entry">
  545. <span class="phpdocumentor-signature__argument__name">$encoding</span>
  546. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  547. </dt>
  548. <dd class="phpdocumentor-argument-list__definition">
  549. </dd>
  550. </dl>
  551. <section>
  552. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  553. <span class="phpdocumentor-signature__response_type">static</span>
  554. </section>
  555. </article>
  556. <article
  557. class="phpdocumentor-element
  558. -method
  559. -public
  560. "
  561. >
  562. <h4 class="phpdocumentor-element__name" id="method_addEciSegment">
  563. addEciSegment()
  564. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciSegment" class="headerlink"><i class="fas fa-link"></i></a>
  565. </h4>
  566. <aside class="phpdocumentor-element-found-in">
  567. <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>
  568. :
  569. <span class="phpdocumentor-element-found-in__line">258</span>
  570. </aside>
  571. <p class="phpdocumentor-summary">Adds an ECI data segment (including designator)</p>
  572. <code class="phpdocumentor-code phpdocumentor-signature ">
  573. <span class="phpdocumentor-signature__visibility">public</span>
  574. <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">static</span></code>
  575. <div class="phpdocumentor-label-line">
  576. </div>
  577. <section class="phpdocumentor-description"><p>The given string will be encoded from mb_internal_encoding() to the given ECI character set</p>
  578. <p>I hate this somehow, but I'll leave it for now</p>
  579. </section>
  580. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  581. <dl class="phpdocumentor-argument-list">
  582. <dt class="phpdocumentor-argument-list__entry">
  583. <span class="phpdocumentor-signature__argument__name">$encoding</span>
  584. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  585. </dt>
  586. <dd class="phpdocumentor-argument-list__definition">
  587. </dd>
  588. <dt class="phpdocumentor-argument-list__entry">
  589. <span class="phpdocumentor-signature__argument__name">$data</span>
  590. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  591. </dt>
  592. <dd class="phpdocumentor-argument-list__definition">
  593. </dd>
  594. </dl>
  595. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  596. Tags
  597. <a href="classes/chillerlan-QRCode-QRCode.html#method_addEciSegment#tags" class="headerlink"><i class="fas fa-link"></i></a>
  598. </h5>
  599. <dl class="phpdocumentor-tag-list">
  600. <dt class="phpdocumentor-tag-list__entry">
  601. <span class="phpdocumentor-tag__name">throws</span>
  602. </dt>
  603. <dd class="phpdocumentor-tag-list__definition">
  604. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-QRCodeException.html"><abbr title="\chillerlan\QRCode\QRCodeException">QRCodeException</abbr></a></span>
  605. </dd>
  606. </dl>
  607. <section>
  608. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  609. <span class="phpdocumentor-signature__response_type">static</span>
  610. </section>
  611. </article>
  612. <article
  613. class="phpdocumentor-element
  614. -method
  615. -public
  616. "
  617. >
  618. <h4 class="phpdocumentor-element__name" id="method_addHanziSegment">
  619. addHanziSegment()
  620. <a href="classes/chillerlan-QRCode-QRCode.html#method_addHanziSegment" class="headerlink"><i class="fas fa-link"></i></a>
  621. </h4>
  622. <aside class="phpdocumentor-element-found-in">
  623. <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>
  624. :
  625. <span class="phpdocumentor-element-found-in__line">225</span>
  626. </aside>
  627. <p class="phpdocumentor-summary">Adds a Hanzi data segment (simplified Chinese 13-bit double-byte characters, GB2312/GB18030)</p>
  628. <code class="phpdocumentor-code phpdocumentor-signature ">
  629. <span class="phpdocumentor-signature__visibility">public</span>
  630. <span class="phpdocumentor-signature__name">addHanziSegment</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">static</span></code>
  631. <div class="phpdocumentor-label-line">
  632. </div>
  633. <section class="phpdocumentor-description"><p>GBT18284-2000 Hanzi Mode</p>
  634. </section>
  635. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  636. <dl class="phpdocumentor-argument-list">
  637. <dt class="phpdocumentor-argument-list__entry">
  638. <span class="phpdocumentor-signature__argument__name">$data</span>
  639. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  640. </dt>
  641. <dd class="phpdocumentor-argument-list__definition">
  642. </dd>
  643. </dl>
  644. <section>
  645. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  646. <span class="phpdocumentor-signature__response_type">static</span>
  647. </section>
  648. </article>
  649. <article
  650. class="phpdocumentor-element
  651. -method
  652. -public
  653. "
  654. >
  655. <h4 class="phpdocumentor-element__name" id="method_addKanjiSegment">
  656. addKanjiSegment()
  657. <a href="classes/chillerlan-QRCode-QRCode.html#method_addKanjiSegment" class="headerlink"><i class="fas fa-link"></i></a>
  658. </h4>
  659. <aside class="phpdocumentor-element-found-in">
  660. <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>
  661. :
  662. <span class="phpdocumentor-element-found-in__line">216</span>
  663. </aside>
  664. <p class="phpdocumentor-summary">Adds a Kanji data segment (Japanese 13-bit double-byte characters, Shift-JIS)</p>
  665. <code class="phpdocumentor-code phpdocumentor-signature ">
  666. <span class="phpdocumentor-signature__visibility">public</span>
  667. <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">static</span></code>
  668. <div class="phpdocumentor-label-line">
  669. </div>
  670. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.5 - Kanji Mode</p>
  671. </section>
  672. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  673. <dl class="phpdocumentor-argument-list">
  674. <dt class="phpdocumentor-argument-list__entry">
  675. <span class="phpdocumentor-signature__argument__name">$data</span>
  676. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  677. </dt>
  678. <dd class="phpdocumentor-argument-list__definition">
  679. </dd>
  680. </dl>
  681. <section>
  682. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  683. <span class="phpdocumentor-signature__response_type">static</span>
  684. </section>
  685. </article>
  686. <article
  687. class="phpdocumentor-element
  688. -method
  689. -public
  690. "
  691. >
  692. <h4 class="phpdocumentor-element__name" id="method_addNumericSegment">
  693. addNumericSegment()
  694. <a href="classes/chillerlan-QRCode-QRCode.html#method_addNumericSegment" class="headerlink"><i class="fas fa-link"></i></a>
  695. </h4>
  696. <aside class="phpdocumentor-element-found-in">
  697. <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>
  698. :
  699. <span class="phpdocumentor-element-found-in__line">198</span>
  700. </aside>
  701. <p class="phpdocumentor-summary">Adds a numeric data segment</p>
  702. <code class="phpdocumentor-code phpdocumentor-signature ">
  703. <span class="phpdocumentor-signature__visibility">public</span>
  704. <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">static</span></code>
  705. <div class="phpdocumentor-label-line">
  706. </div>
  707. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.2 - Numeric Mode</p>
  708. </section>
  709. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  710. <dl class="phpdocumentor-argument-list">
  711. <dt class="phpdocumentor-argument-list__entry">
  712. <span class="phpdocumentor-signature__argument__name">$data</span>
  713. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  714. </dt>
  715. <dd class="phpdocumentor-argument-list__definition">
  716. </dd>
  717. </dl>
  718. <section>
  719. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  720. <span class="phpdocumentor-signature__response_type">static</span>
  721. </section>
  722. </article>
  723. <article
  724. class="phpdocumentor-element
  725. -method
  726. -public
  727. "
  728. >
  729. <h4 class="phpdocumentor-element__name" id="method_addSegment">
  730. addSegment()
  731. <a href="classes/chillerlan-QRCode-QRCode.html#method_addSegment" 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">176</span>
  737. </aside>
  738. <p class="phpdocumentor-summary">Adds a data segment</p>
  739. <code class="phpdocumentor-code phpdocumentor-signature ">
  740. <span class="phpdocumentor-signature__visibility">public</span>
  741. <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">static</span></code>
  742. <div class="phpdocumentor-label-line">
  743. </div>
  744. <section class="phpdocumentor-description"><p>ISO/IEC 18004:2000 8.3.6 - Mixing modes
  745. ISO/IEC 18004:2000 Annex H - Optimisation of bit stream length</p>
  746. </section>
  747. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  748. <dl class="phpdocumentor-argument-list">
  749. <dt class="phpdocumentor-argument-list__entry">
  750. <span class="phpdocumentor-signature__argument__name">$segment</span>
  751. : <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>
  752. </dt>
  753. <dd class="phpdocumentor-argument-list__definition">
  754. </dd>
  755. </dl>
  756. <section>
  757. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  758. <span class="phpdocumentor-signature__response_type">static</span>
  759. </section>
  760. </article>
  761. <article
  762. class="phpdocumentor-element
  763. -method
  764. -public
  765. "
  766. >
  767. <h4 class="phpdocumentor-element__name" id="method_clearSegments">
  768. clearSegments()
  769. <a href="classes/chillerlan-QRCode-QRCode.html#method_clearSegments" class="headerlink"><i class="fas fa-link"></i></a>
  770. </h4>
  771. <aside class="phpdocumentor-element-found-in">
  772. <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>
  773. :
  774. <span class="phpdocumentor-element-found-in__line">187</span>
  775. </aside>
  776. <p class="phpdocumentor-summary">Clears the data segments array</p>
  777. <code class="phpdocumentor-code phpdocumentor-signature ">
  778. <span class="phpdocumentor-signature__visibility">public</span>
  779. <span class="phpdocumentor-signature__name">clearSegments</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  780. <div class="phpdocumentor-label-line">
  781. </div>
  782. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  783. Tags
  784. <a href="classes/chillerlan-QRCode-QRCode.html#method_clearSegments#tags" class="headerlink"><i class="fas fa-link"></i></a>
  785. </h5>
  786. <dl class="phpdocumentor-tag-list">
  787. <dt class="phpdocumentor-tag-list__entry">
  788. <span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
  789. </dt>
  790. <dd class="phpdocumentor-tag-list__definition">
  791. </dd>
  792. </dl>
  793. <section>
  794. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  795. <span class="phpdocumentor-signature__response_type">static</span>
  796. </section>
  797. </article>
  798. <article
  799. class="phpdocumentor-element
  800. -method
  801. -public
  802. "
  803. >
  804. <h4 class="phpdocumentor-element__name" id="method_getQRMatrix">
  805. getQRMatrix()
  806. <a href="classes/chillerlan-QRCode-QRCode.html#method_getQRMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  807. </h4>
  808. <aside class="phpdocumentor-element-found-in">
  809. <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>
  810. :
  811. <span class="phpdocumentor-element-found-in__line">111</span>
  812. </aside>
  813. <p class="phpdocumentor-summary">Returns a QRMatrix object for the given $data and current QROptions</p>
  814. <code class="phpdocumentor-code phpdocumentor-signature ">
  815. <span class="phpdocumentor-signature__visibility">public</span>
  816. <span class="phpdocumentor-signature__name">getQRMatrix</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>
  817. <div class="phpdocumentor-label-line">
  818. </div>
  819. <section>
  820. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  821. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  822. </section>
  823. </article>
  824. <article
  825. class="phpdocumentor-element
  826. -method
  827. -public
  828. "
  829. >
  830. <h4 class="phpdocumentor-element__name" id="method_readFromBlob">
  831. readFromBlob()
  832. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromBlob" class="headerlink"><i class="fas fa-link"></i></a>
  833. </h4>
  834. <aside class="phpdocumentor-element-found-in">
  835. <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>
  836. :
  837. <span class="phpdocumentor-element-found-in__line">286</span>
  838. </aside>
  839. <p class="phpdocumentor-summary">Reads a QR Code from the given data blob</p>
  840. <code class="phpdocumentor-code phpdocumentor-signature ">
  841. <span class="phpdocumentor-signature__visibility">public</span>
  842. <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>
  843. <div class="phpdocumentor-label-line">
  844. </div>
  845. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  846. <dl class="phpdocumentor-argument-list">
  847. <dt class="phpdocumentor-argument-list__entry">
  848. <span class="phpdocumentor-signature__argument__name">$blob</span>
  849. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  850. </dt>
  851. <dd class="phpdocumentor-argument-list__definition">
  852. </dd>
  853. </dl>
  854. <section>
  855. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  856. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  857. </section>
  858. </article>
  859. <article
  860. class="phpdocumentor-element
  861. -method
  862. -public
  863. "
  864. >
  865. <h4 class="phpdocumentor-element__name" id="method_readFromFile">
  866. readFromFile()
  867. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromFile" class="headerlink"><i class="fas fa-link"></i></a>
  868. </h4>
  869. <aside class="phpdocumentor-element-found-in">
  870. <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>
  871. :
  872. <span class="phpdocumentor-element-found-in__line">279</span>
  873. </aside>
  874. <p class="phpdocumentor-summary">Reads a QR Code from a given file</p>
  875. <code class="phpdocumentor-code phpdocumentor-signature ">
  876. <span class="phpdocumentor-signature__visibility">public</span>
  877. <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>
  878. <div class="phpdocumentor-label-line">
  879. </div>
  880. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  881. <dl class="phpdocumentor-argument-list">
  882. <dt class="phpdocumentor-argument-list__entry">
  883. <span class="phpdocumentor-signature__argument__name">$path</span>
  884. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  885. </dt>
  886. <dd class="phpdocumentor-argument-list__definition">
  887. </dd>
  888. </dl>
  889. <section>
  890. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  891. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  892. </section>
  893. </article>
  894. <article
  895. class="phpdocumentor-element
  896. -method
  897. -public
  898. "
  899. >
  900. <h4 class="phpdocumentor-element__name" id="method_readFromSource">
  901. readFromSource()
  902. <a href="classes/chillerlan-QRCode-QRCode.html#method_readFromSource" class="headerlink"><i class="fas fa-link"></i></a>
  903. </h4>
  904. <aside class="phpdocumentor-element-found-in">
  905. <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>
  906. :
  907. <span class="phpdocumentor-element-found-in__line">293</span>
  908. </aside>
  909. <p class="phpdocumentor-summary">Reads a QR Code from the given luminance source</p>
  910. <code class="phpdocumentor-code phpdocumentor-signature ">
  911. <span class="phpdocumentor-signature__visibility">public</span>
  912. <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-Common-LuminanceSourceInterface.html"><abbr title="\chillerlan\QRCode\Common\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>
  913. <div class="phpdocumentor-label-line">
  914. </div>
  915. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  916. <dl class="phpdocumentor-argument-list">
  917. <dt class="phpdocumentor-argument-list__entry">
  918. <span class="phpdocumentor-signature__argument__name">$source</span>
  919. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Common-LuminanceSourceInterface.html"><abbr title="\chillerlan\QRCode\Common\LuminanceSourceInterface">LuminanceSourceInterface</abbr></a></span>
  920. </dt>
  921. <dd class="phpdocumentor-argument-list__definition">
  922. </dd>
  923. </dl>
  924. <section>
  925. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  926. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Decoder-DecoderResult.html"><abbr title="\chillerlan\QRCode\Decoder\DecoderResult">DecoderResult</abbr></a></span>
  927. </section>
  928. </article>
  929. <article
  930. class="phpdocumentor-element
  931. -method
  932. -public
  933. "
  934. >
  935. <h4 class="phpdocumentor-element__name" id="method_render">
  936. render()
  937. <a href="classes/chillerlan-QRCode-QRCode.html#method_render" class="headerlink"><i class="fas fa-link"></i></a>
  938. </h4>
  939. <aside class="phpdocumentor-element-found-in">
  940. <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>
  941. :
  942. <span class="phpdocumentor-element-found-in__line">85</span>
  943. </aside>
  944. <p class="phpdocumentor-summary">Renders a QR Code for the given $data and QROptions, saves $file optionally</p>
  945. <code class="phpdocumentor-code phpdocumentor-signature ">
  946. <span class="phpdocumentor-signature__visibility">public</span>
  947. <span class="phpdocumentor-signature__name">render</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string|null&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|null&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>
  948. <div class="phpdocumentor-label-line">
  949. </div>
  950. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  951. <dl class="phpdocumentor-argument-list">
  952. <dt class="phpdocumentor-argument-list__entry">
  953. <span class="phpdocumentor-signature__argument__name">$data</span>
  954. : <span class="phpdocumentor-signature__argument__return-type">string|null</span>
  955. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  956. <dd class="phpdocumentor-argument-list__definition">
  957. </dd>
  958. <dt class="phpdocumentor-argument-list__entry">
  959. <span class="phpdocumentor-signature__argument__name">$file</span>
  960. : <span class="phpdocumentor-signature__argument__return-type">string|null</span>
  961. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  962. <dd class="phpdocumentor-argument-list__definition">
  963. </dd>
  964. </dl>
  965. </article>
  966. <article
  967. class="phpdocumentor-element
  968. -method
  969. -public
  970. "
  971. >
  972. <h4 class="phpdocumentor-element__name" id="method_renderMatrix">
  973. renderMatrix()
  974. <a href="classes/chillerlan-QRCode-QRCode.html#method_renderMatrix" class="headerlink"><i class="fas fa-link"></i></a>
  975. </h4>
  976. <aside class="phpdocumentor-element-found-in">
  977. <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>
  978. :
  979. <span class="phpdocumentor-element-found-in__line">104</span>
  980. </aside>
  981. <p class="phpdocumentor-summary">Renders a QR Code for the given QRMatrix and QROptions, saves $file optionally</p>
  982. <code class="phpdocumentor-code phpdocumentor-signature ">
  983. <span class="phpdocumentor-signature__visibility">public</span>
  984. <span class="phpdocumentor-signature__name">renderMatrix</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&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>
  985. <div class="phpdocumentor-label-line">
  986. </div>
  987. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  988. <dl class="phpdocumentor-argument-list">
  989. <dt class="phpdocumentor-argument-list__entry">
  990. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  991. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  992. </dt>
  993. <dd class="phpdocumentor-argument-list__definition">
  994. </dd>
  995. <dt class="phpdocumentor-argument-list__entry">
  996. <span class="phpdocumentor-signature__argument__name">$file</span>
  997. : <span class="phpdocumentor-signature__argument__return-type">string|null</span>
  998. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  999. <dd class="phpdocumentor-argument-list__definition">
  1000. </dd>
  1001. </dl>
  1002. </article>
  1003. <article
  1004. class="phpdocumentor-element
  1005. -method
  1006. -public
  1007. "
  1008. >
  1009. <h4 class="phpdocumentor-element__name" id="method_setOptions">
  1010. setOptions()
  1011. <a href="classes/chillerlan-QRCode-QRCode.html#method_setOptions" class="headerlink"><i class="fas fa-link"></i></a>
  1012. </h4>
  1013. <aside class="phpdocumentor-element-found-in">
  1014. <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>
  1015. :
  1016. <span class="phpdocumentor-element-found-in__line">67</span>
  1017. </aside>
  1018. <p class="phpdocumentor-summary">Sets an options instance</p>
  1019. <code class="phpdocumentor-code phpdocumentor-signature ">
  1020. <span class="phpdocumentor-signature__visibility">public</span>
  1021. <span class="phpdocumentor-signature__name">setOptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a>|iterable&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  1022. <div class="phpdocumentor-label-line">
  1023. </div>
  1024. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1025. <dl class="phpdocumentor-argument-list">
  1026. <dt class="phpdocumentor-argument-list__entry">
  1027. <span class="phpdocumentor-signature__argument__name">$options</span>
  1028. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a>|iterable&lt;string|int, mixed&gt;</span>
  1029. </dt>
  1030. <dd class="phpdocumentor-argument-list__definition">
  1031. </dd>
  1032. </dl>
  1033. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1034. Tags
  1035. <a href="classes/chillerlan-QRCode-QRCode.html#method_setOptions#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1036. </h5>
  1037. <dl class="phpdocumentor-tag-list">
  1038. <dt class="phpdocumentor-tag-list__entry">
  1039. <span class="phpdocumentor-tag__name">phpstan-param</span>
  1040. </dt>
  1041. <dd class="phpdocumentor-tag-list__definition">
  1042. <section class="phpdocumentor-description"><p>array&lt;string, mixed&gt; $options</p>
  1043. </section>
  1044. </dd>
  1045. </dl>
  1046. <section>
  1047. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1048. <span class="phpdocumentor-signature__response_type">static</span>
  1049. </section>
  1050. </article>
  1051. <article
  1052. class="phpdocumentor-element
  1053. -method
  1054. -protected
  1055. "
  1056. >
  1057. <h4 class="phpdocumentor-element__name" id="method_addMatrixModifications">
  1058. addMatrixModifications()
  1059. <a href="classes/chillerlan-QRCode-QRCode.html#method_addMatrixModifications" class="headerlink"><i class="fas fa-link"></i></a>
  1060. </h4>
  1061. <aside class="phpdocumentor-element-found-in">
  1062. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1063. :
  1064. <span class="phpdocumentor-element-found-in__line">126</span>
  1065. </aside>
  1066. <p class="phpdocumentor-summary">add matrix modifications after mask pattern evaluation and before handing over to output</p>
  1067. <code class="phpdocumentor-code phpdocumentor-signature ">
  1068. <span class="phpdocumentor-signature__visibility">protected</span>
  1069. <span class="phpdocumentor-signature__name">addMatrixModifications</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</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>
  1070. <div class="phpdocumentor-label-line">
  1071. </div>
  1072. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1073. <dl class="phpdocumentor-argument-list">
  1074. <dt class="phpdocumentor-argument-list__entry">
  1075. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  1076. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  1077. </dt>
  1078. <dd class="phpdocumentor-argument-list__definition">
  1079. </dd>
  1080. </dl>
  1081. <section>
  1082. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1083. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  1084. </section>
  1085. </article>
  1086. <article
  1087. class="phpdocumentor-element
  1088. -method
  1089. -protected
  1090. "
  1091. >
  1092. <h4 class="phpdocumentor-element__name" id="method_initOutputInterface">
  1093. initOutputInterface()
  1094. <a href="classes/chillerlan-QRCode-QRCode.html#method_initOutputInterface" class="headerlink"><i class="fas fa-link"></i></a>
  1095. </h4>
  1096. <aside class="phpdocumentor-element-found-in">
  1097. <abbr class="phpdocumentor-element-found-in__file" title="src/QRCode.php"><a href="files/src-qrcode.html"><abbr title="src/QRCode.php">QRCode.php</abbr></a></abbr>
  1098. :
  1099. <span class="phpdocumentor-element-found-in__line">153</span>
  1100. </aside>
  1101. <p class="phpdocumentor-summary">initializes a fresh built-in or custom QROutputInterface</p>
  1102. <code class="phpdocumentor-code phpdocumentor-signature ">
  1103. <span class="phpdocumentor-signature__visibility">protected</span>
  1104. <span class="phpdocumentor-signature__name">initOutputInterface</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$matrix</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>
  1105. <div class="phpdocumentor-label-line">
  1106. </div>
  1107. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1108. <dl class="phpdocumentor-argument-list">
  1109. <dt class="phpdocumentor-argument-list__entry">
  1110. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  1111. : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  1112. </dt>
  1113. <dd class="phpdocumentor-argument-list__definition">
  1114. </dd>
  1115. </dl>
  1116. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1117. Tags
  1118. <a href="classes/chillerlan-QRCode-QRCode.html#method_initOutputInterface#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1119. </h5>
  1120. <dl class="phpdocumentor-tag-list">
  1121. <dt class="phpdocumentor-tag-list__entry">
  1122. <span class="phpdocumentor-tag__name">throws</span>
  1123. </dt>
  1124. <dd class="phpdocumentor-tag-list__definition">
  1125. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1126. </dd>
  1127. </dl>
  1128. <section>
  1129. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1130. <span class="phpdocumentor-signature__response_type"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></span>
  1131. </section>
  1132. </article>
  1133. </section>
  1134. <div class="phpdocumentor-modal" id="source-view">
  1135. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1136. <div class="phpdocumentor-modal-container">
  1137. <div class="phpdocumentor-modal-content">
  1138. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/QRCode.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  1139. </div>
  1140. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1141. </div>
  1142. </div>
  1143. <script type="text/javascript">
  1144. (function () {
  1145. function loadExternalCodeSnippet(el, url, line) {
  1146. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1147. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1148. const language = 'php';
  1149. const code = document.createElement('code');
  1150. code.className = 'language-' + language;
  1151. pre.textContent = '';
  1152. pre.setAttribute('data-line', line)
  1153. code.textContent = 'Loading…';
  1154. pre.appendChild(code);
  1155. var xhr = new XMLHttpRequest();
  1156. xhr.open('GET', src, true);
  1157. xhr.onreadystatechange = function () {
  1158. if (xhr.readyState !== 4) {
  1159. return;
  1160. }
  1161. if (xhr.status < 400 && xhr.responseText) {
  1162. code.textContent = xhr.responseText;
  1163. Prism.highlightElement(code);
  1164. return;
  1165. }
  1166. if (xhr.status === 404) {
  1167. code.textContent = '✖ Error: File could not be found';
  1168. return;
  1169. }
  1170. if (xhr.status >= 400) {
  1171. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1172. return;
  1173. }
  1174. code.textContent = '✖ Error: An unknown error occurred';
  1175. };
  1176. xhr.send(null);
  1177. });
  1178. }
  1179. const modalButtons = document.querySelectorAll("[data-modal]");
  1180. const openedAsLocalFile = window.location.protocol === 'file:';
  1181. if (modalButtons.length > 0 && openedAsLocalFile) {
  1182. console.warn(
  1183. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1184. 'browsers block XHR requests when a page is opened this way'
  1185. );
  1186. }
  1187. modalButtons.forEach(function (trigger) {
  1188. if (openedAsLocalFile) {
  1189. trigger.setAttribute("hidden", "hidden");
  1190. }
  1191. trigger.addEventListener("click", function (event) {
  1192. event.preventDefault();
  1193. const modal = document.getElementById(trigger.dataset.modal);
  1194. if (!modal) {
  1195. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1196. return;
  1197. }
  1198. modal.classList.add("phpdocumentor-modal__open");
  1199. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1200. const exits = modal.querySelectorAll("[data-exit-button]");
  1201. exits.forEach(function (exit) {
  1202. exit.addEventListener("click", function (event) {
  1203. event.preventDefault();
  1204. modal.classList.remove("phpdocumentor-modal__open");
  1205. });
  1206. });
  1207. });
  1208. });
  1209. })();
  1210. </script>
  1211. </article>
  1212. </section>
  1213. <section class="phpdocumentor-on-this-page__sidebar">
  1214. <section class="phpdocumentor-on-this-page__content">
  1215. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1216. <ul class="phpdocumentor-list -clean">
  1217. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1218. <li>
  1219. <ul class="phpdocumentor-list -clean">
  1220. <li><a href="classes/chillerlan-QRCode-QRCode.html#toc-properties">Properties</a></li>
  1221. <li><a href="classes/chillerlan-QRCode-QRCode.html#toc-methods">Methods</a></li>
  1222. </ul>
  1223. </li>
  1224. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1225. <li>
  1226. <ul class="phpdocumentor-list -clean">
  1227. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#property_dataSegments">$dataSegments</a></li>
  1228. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#property_luminanceSourceFQN">$luminanceSourceFQN</a></li>
  1229. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#property_options">$options</a></li>
  1230. </ul>
  1231. </li>
  1232. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1233. <li>
  1234. <ul class="phpdocumentor-list -clean">
  1235. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method___construct">__construct()</a></li>
  1236. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_addAlphaNumSegment">addAlphaNumSegment()</a></li>
  1237. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_addByteSegment">addByteSegment()</a></li>
  1238. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_addEciDesignator">addEciDesignator()</a></li>
  1239. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_addEciSegment">addEciSegment()</a></li>
  1240. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_addHanziSegment">addHanziSegment()</a></li>
  1241. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_addKanjiSegment">addKanjiSegment()</a></li>
  1242. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_addNumericSegment">addNumericSegment()</a></li>
  1243. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_addSegment">addSegment()</a></li>
  1244. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_clearSegments">clearSegments()</a></li>
  1245. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_getQRMatrix">getQRMatrix()</a></li>
  1246. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_readFromBlob">readFromBlob()</a></li>
  1247. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_readFromFile">readFromFile()</a></li>
  1248. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_readFromSource">readFromSource()</a></li>
  1249. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_render">render()</a></li>
  1250. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_renderMatrix">renderMatrix()</a></li>
  1251. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_setOptions">setOptions()</a></li>
  1252. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_addMatrixModifications">addMatrixModifications()</a></li>
  1253. <li class=""><a href="classes/chillerlan-QRCode-QRCode.html#method_initOutputInterface">initOutputInterface()</a></li>
  1254. </ul>
  1255. </li>
  1256. </ul>
  1257. </section>
  1258. </section>
  1259. </div>
  1260. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1261. <section class="phpdocumentor-search-results__dialog">
  1262. <header class="phpdocumentor-search-results__header">
  1263. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1264. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1265. </header>
  1266. <section class="phpdocumentor-search-results__body">
  1267. <ul class="phpdocumentor-search-results__entries"></ul>
  1268. </section>
  1269. </section>
  1270. </section>
  1271. </div>
  1272. <a href="classes/chillerlan-QRCode-QRCode.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1273. </main>
  1274. <script>
  1275. cssVars({});
  1276. </script>
  1277. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1278. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1279. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1280. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1281. </body>
  1282. </html>