chillerlan-QRCode-QRCode.html 81 KB

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