chillerlan-QRCode-QRCode.html 82 KB

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