chillerlan-QRCode-Output-QROutputAbstract.html 83 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719
  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. </section>
  82. <section class="phpdocumentor-sidebar__category">
  83. <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
  84. <h4 class="phpdocumentor-sidebar__root-namespace">
  85. <a href="packages/Application.html" class="">Application</a>
  86. </h4>
  87. </section>
  88. <section class="phpdocumentor-sidebar__category">
  89. <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
  90. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
  91. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
  92. <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
  93. </section>
  94. <section class="phpdocumentor-sidebar__category">
  95. <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
  96. <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
  97. </section>
  98. </aside>
  99. <div class="phpdocumentor-column -nine phpdocumentor-content">
  100. <section>
  101. <ul class="phpdocumentor-breadcrumbs">
  102. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan.html">chillerlan</a></li>
  103. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode.html">QRCode</a></li>
  104. <li class="phpdocumentor-breadcrumb"><a href="namespaces/chillerlan-qrcode-output.html">Output</a></li>
  105. </ul>
  106. <article class="phpdocumentor-element -class">
  107. <h2 class="phpdocumentor-content__title">
  108. QROutputAbstract
  109. <div class="phpdocumentor-element__package">
  110. in package
  111. <ul class="phpdocumentor-breadcrumbs">
  112. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  113. </ul>
  114. </div>
  115. <span class="phpdocumentor-element__implements">
  116. implements
  117. <a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a> </span>
  118. </h2>
  119. <div class="phpdocumentor-label-line">
  120. <div class="phpdocumentor-label phpdocumentor-label--success"><span>Abstract</span><span>Yes</span></div>
  121. </div>
  122. <aside class="phpdocumentor-element-found-in">
  123. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  124. :
  125. <span class="phpdocumentor-element-found-in__line">21</span>
  126. </aside>
  127. <p class="phpdocumentor-summary">common output abstract</p>
  128. <h3 id="toc">
  129. Table of Contents
  130. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  131. </h3>
  132. <h4 id="toc-interfaces">
  133. Interfaces
  134. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc-interfaces" class="headerlink"><i class="fas fa-link"></i></a>
  135. </h4>
  136. <dl class="phpdocumentor-table-of-contents">
  137. <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/chillerlan-QRCode-Output-QROutputInterface.html"><abbr title="\chillerlan\QRCode\Output\QROutputInterface">QROutputInterface</abbr></a></dt><dd>Converts the data matrix into readable output</dd> </dl>
  138. <h4 id="toc-properties">
  139. Properties
  140. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  141. </h4>
  142. <dl class="phpdocumentor-table-of-contents">
  143. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  144. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius</a>
  145. <span>
  146. &nbsp;: float </span>
  147. </dt>
  148. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  149. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths</a>
  150. <span>
  151. &nbsp;: bool </span>
  152. </dt>
  153. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  154. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules</a>
  155. <span>
  156. &nbsp;: bool </span>
  157. </dt>
  158. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  159. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules</a>
  160. <span>
  161. &nbsp;: bool </span>
  162. </dt>
  163. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  164. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol</a>
  165. <span>
  166. &nbsp;: string </span>
  167. </dt>
  168. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect</a>
  170. <span>
  171. &nbsp;: array&lt;string|int, mixed&gt; </span>
  172. </dt>
  173. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  174. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare</a>
  175. <span>
  176. &nbsp;: array&lt;string|int, mixed&gt; </span>
  177. </dt>
  178. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  179. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  180. <span>
  181. &nbsp;: int </span>
  182. </dt>
  183. <dd>the side length of the QR image (modules * scale)</dd>
  184. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  185. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  186. <span>
  187. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  188. </dt>
  189. <dd>the (filled) data matrix object</dd>
  190. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  191. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  192. <span>
  193. &nbsp;: int </span>
  194. </dt>
  195. <dd>the current size of the QR matrix</dd>
  196. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  197. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  198. <span>
  199. &nbsp;: array&lt;string|int, mixed&gt; </span>
  200. </dt>
  201. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  202. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  203. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  204. <span>
  205. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  206. </dt>
  207. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  208. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  209. <span>
  210. &nbsp;: int </span>
  211. </dt>
  212. </dl>
  213. <h4 id="toc-methods">
  214. Methods
  215. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  216. </h4>
  217. <dl class="phpdocumentor-table-of-contents">
  218. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  219. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a>
  220. <span>
  221. &nbsp;: mixed </span>
  222. </dt>
  223. <dd>QROutputAbstract constructor.</dd>
  224. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  225. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  226. <span>
  227. &nbsp;: array&lt;string|int, mixed&gt; </span>
  228. </dt>
  229. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  230. returns an array with the transformed modules</dd>
  231. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  232. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a>
  233. <span>
  234. &nbsp;: void </span>
  235. </dt>
  236. <dd>Creates copies of several QROptions values to avoid calling the magic getters
  237. in long loops for a significant performance increase.</dd>
  238. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  239. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  240. <span>
  241. &nbsp;: mixed|null </span>
  242. </dt>
  243. <dd>Returns a default value for either dark or light modules</dd>
  244. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  245. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  246. <span>
  247. &nbsp;: mixed </span>
  248. </dt>
  249. <dd>Returns the prepared value for the given $M_TYPE</dd>
  250. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  251. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  252. <span>
  253. &nbsp;: mixed|null </span>
  254. </dt>
  255. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  256. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  257. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a>
  258. <span>
  259. &nbsp;: array&lt;string|int, mixed&gt; </span>
  260. </dt>
  261. <dd>Returns a 2 element array with the current output width and height</dd>
  262. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  263. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a>
  264. <span>
  265. &nbsp;: mixed|null </span>
  266. </dt>
  267. <dd>Prepares the value for the given input ()</dd>
  268. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  269. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  270. <span>
  271. &nbsp;: void </span>
  272. </dt>
  273. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  274. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  275. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  276. <span>
  277. &nbsp;: void </span>
  278. </dt>
  279. <dd>Sets/updates the matrix dimensions</dd>
  280. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  281. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  282. <span>
  283. &nbsp;: void </span>
  284. </dt>
  285. <dd>Sets the initial module values</dd>
  286. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  287. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  288. <span>
  289. &nbsp;: string </span>
  290. </dt>
  291. <dd>Returns a base64 data URI for the given string and mime type</dd>
  292. </dl>
  293. <section class="phpdocumentor-properties">
  294. <h3 class="phpdocumentor-elements__header" id="properties">
  295. Properties
  296. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  297. </h3>
  298. <article
  299. class="
  300. phpdocumentor-element
  301. -property
  302. -protected
  303. "
  304. >
  305. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  306. $circleRadius
  307. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  308. <span class="phpdocumentor-element__modifiers">
  309. </span>
  310. </h4>
  311. <aside class="phpdocumentor-element-found-in">
  312. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  313. :
  314. <span class="phpdocumentor-element-found-in__line">65</span>
  315. </aside>
  316. <code class="phpdocumentor-code phpdocumentor-signature ">
  317. <span class="phpdocumentor-signature__visibility">protected</span>
  318. <span class="phpdocumentor-signature__type">float</span>
  319. <span class="phpdocumentor-signature__name">$circleRadius</span>
  320. </code>
  321. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  322. Tags
  323. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius#tags" class="headerlink"><i class="fas fa-link"></i></a>
  324. </h5>
  325. <dl class="phpdocumentor-tag-list">
  326. <dt class="phpdocumentor-tag-list__entry">
  327. <span class="phpdocumentor-tag__name">see</span>
  328. </dt>
  329. <dd class="phpdocumentor-tag-list__definition">
  330. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$circleRadius">QROptions::$circleRadius</abbr></span>
  331. </dd>
  332. </dl>
  333. </article>
  334. <article
  335. class="
  336. phpdocumentor-element
  337. -property
  338. -protected
  339. "
  340. >
  341. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  342. $connectPaths
  343. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  344. <span class="phpdocumentor-element__modifiers">
  345. </span>
  346. </h4>
  347. <aside class="phpdocumentor-element-found-in">
  348. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  349. :
  350. <span class="phpdocumentor-element-found-in__line">53</span>
  351. </aside>
  352. <code class="phpdocumentor-code phpdocumentor-signature ">
  353. <span class="phpdocumentor-signature__visibility">protected</span>
  354. <span class="phpdocumentor-signature__type">bool</span>
  355. <span class="phpdocumentor-signature__name">$connectPaths</span>
  356. </code>
  357. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  358. Tags
  359. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  360. </h5>
  361. <dl class="phpdocumentor-tag-list">
  362. <dt class="phpdocumentor-tag-list__entry">
  363. <span class="phpdocumentor-tag__name">see</span>
  364. </dt>
  365. <dd class="phpdocumentor-tag-list__definition">
  366. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$connectPaths">QROptions::$connectPaths</abbr></span>
  367. </dd>
  368. </dl>
  369. </article>
  370. <article
  371. class="
  372. phpdocumentor-element
  373. -property
  374. -protected
  375. "
  376. >
  377. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  378. $drawCircularModules
  379. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  380. <span class="phpdocumentor-element__modifiers">
  381. </span>
  382. </h4>
  383. <aside class="phpdocumentor-element-found-in">
  384. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  385. :
  386. <span class="phpdocumentor-element-found-in__line">61</span>
  387. </aside>
  388. <code class="phpdocumentor-code phpdocumentor-signature ">
  389. <span class="phpdocumentor-signature__visibility">protected</span>
  390. <span class="phpdocumentor-signature__type">bool</span>
  391. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  392. </code>
  393. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  394. Tags
  395. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  396. </h5>
  397. <dl class="phpdocumentor-tag-list">
  398. <dt class="phpdocumentor-tag-list__entry">
  399. <span class="phpdocumentor-tag__name">see</span>
  400. </dt>
  401. <dd class="phpdocumentor-tag-list__definition">
  402. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawCircularModules">QROptions::$drawCircularModules</abbr></span>
  403. </dd>
  404. </dl>
  405. </article>
  406. <article
  407. class="
  408. phpdocumentor-element
  409. -property
  410. -protected
  411. "
  412. >
  413. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  414. $drawLightModules
  415. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  416. <span class="phpdocumentor-element__modifiers">
  417. </span>
  418. </h4>
  419. <aside class="phpdocumentor-element-found-in">
  420. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  421. :
  422. <span class="phpdocumentor-element-found-in__line">59</span>
  423. </aside>
  424. <code class="phpdocumentor-code phpdocumentor-signature ">
  425. <span class="phpdocumentor-signature__visibility">protected</span>
  426. <span class="phpdocumentor-signature__type">bool</span>
  427. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  428. </code>
  429. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  430. Tags
  431. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  432. </h5>
  433. <dl class="phpdocumentor-tag-list">
  434. <dt class="phpdocumentor-tag-list__entry">
  435. <span class="phpdocumentor-tag__name">see</span>
  436. </dt>
  437. <dd class="phpdocumentor-tag-list__definition">
  438. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawLightModules">QROptions::$drawLightModules</abbr></span>
  439. </dd>
  440. </dl>
  441. </article>
  442. <article
  443. class="
  444. phpdocumentor-element
  445. -property
  446. -protected
  447. "
  448. >
  449. <h4 class="phpdocumentor-element__name" id="property_eol">
  450. $eol
  451. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  452. <span class="phpdocumentor-element__modifiers">
  453. </span>
  454. </h4>
  455. <aside class="phpdocumentor-element-found-in">
  456. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  457. :
  458. <span class="phpdocumentor-element-found-in__line">57</span>
  459. </aside>
  460. <code class="phpdocumentor-code phpdocumentor-signature ">
  461. <span class="phpdocumentor-signature__visibility">protected</span>
  462. <span class="phpdocumentor-signature__type">string</span>
  463. <span class="phpdocumentor-signature__name">$eol</span>
  464. </code>
  465. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  466. Tags
  467. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol#tags" class="headerlink"><i class="fas fa-link"></i></a>
  468. </h5>
  469. <dl class="phpdocumentor-tag-list">
  470. <dt class="phpdocumentor-tag-list__entry">
  471. <span class="phpdocumentor-tag__name">see</span>
  472. </dt>
  473. <dd class="phpdocumentor-tag-list__definition">
  474. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$eol">QROptions::$eol</abbr></span>
  475. </dd>
  476. </dl>
  477. </article>
  478. <article
  479. class="
  480. phpdocumentor-element
  481. -property
  482. -protected
  483. "
  484. >
  485. <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
  486. $excludeFromConnect
  487. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  488. <span class="phpdocumentor-element__modifiers">
  489. </span>
  490. </h4>
  491. <aside class="phpdocumentor-element-found-in">
  492. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  493. :
  494. <span class="phpdocumentor-element-found-in__line">55</span>
  495. </aside>
  496. <code class="phpdocumentor-code phpdocumentor-signature ">
  497. <span class="phpdocumentor-signature__visibility">protected</span>
  498. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  499. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  500. </code>
  501. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  502. Tags
  503. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect#tags" class="headerlink"><i class="fas fa-link"></i></a>
  504. </h5>
  505. <dl class="phpdocumentor-tag-list">
  506. <dt class="phpdocumentor-tag-list__entry">
  507. <span class="phpdocumentor-tag__name">see</span>
  508. </dt>
  509. <dd class="phpdocumentor-tag-list__definition">
  510. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$excludeFromConnect">QROptions::$excludeFromConnect</abbr></span>
  511. </dd>
  512. </dl>
  513. </article>
  514. <article
  515. class="
  516. phpdocumentor-element
  517. -property
  518. -protected
  519. "
  520. >
  521. <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
  522. $keepAsSquare
  523. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  524. <span class="phpdocumentor-element__modifiers">
  525. </span>
  526. </h4>
  527. <aside class="phpdocumentor-element-found-in">
  528. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  529. :
  530. <span class="phpdocumentor-element-found-in__line">63</span>
  531. </aside>
  532. <code class="phpdocumentor-code phpdocumentor-signature ">
  533. <span class="phpdocumentor-signature__visibility">protected</span>
  534. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  535. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  536. </code>
  537. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  538. Tags
  539. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare#tags" class="headerlink"><i class="fas fa-link"></i></a>
  540. </h5>
  541. <dl class="phpdocumentor-tag-list">
  542. <dt class="phpdocumentor-tag-list__entry">
  543. <span class="phpdocumentor-tag__name">see</span>
  544. </dt>
  545. <dd class="phpdocumentor-tag-list__definition">
  546. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$keepAsSquare">QROptions::$keepAsSquare</abbr></span>
  547. </dd>
  548. </dl>
  549. </article>
  550. <article
  551. class="
  552. phpdocumentor-element
  553. -property
  554. -protected
  555. "
  556. >
  557. <h4 class="phpdocumentor-element__name" id="property_length">
  558. $length
  559. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  560. <span class="phpdocumentor-element__modifiers">
  561. </span>
  562. </h4>
  563. <aside class="phpdocumentor-element-found-in">
  564. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  565. :
  566. <span class="phpdocumentor-element-found-in__line">33</span>
  567. </aside>
  568. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  569. <code class="phpdocumentor-code phpdocumentor-signature ">
  570. <span class="phpdocumentor-signature__visibility">protected</span>
  571. <span class="phpdocumentor-signature__type">int</span>
  572. <span class="phpdocumentor-signature__name">$length</span>
  573. </code>
  574. </article>
  575. <article
  576. class="
  577. phpdocumentor-element
  578. -property
  579. -protected
  580. "
  581. >
  582. <h4 class="phpdocumentor-element__name" id="property_matrix">
  583. $matrix
  584. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  585. <span class="phpdocumentor-element__modifiers">
  586. </span>
  587. </h4>
  588. <aside class="phpdocumentor-element-found-in">
  589. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  590. :
  591. <span class="phpdocumentor-element-found-in__line">43</span>
  592. </aside>
  593. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  594. <code class="phpdocumentor-code phpdocumentor-signature ">
  595. <span class="phpdocumentor-signature__visibility">protected</span>
  596. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  597. <span class="phpdocumentor-signature__name">$matrix</span>
  598. </code>
  599. </article>
  600. <article
  601. class="
  602. phpdocumentor-element
  603. -property
  604. -protected
  605. "
  606. >
  607. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  608. $moduleCount
  609. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  610. <span class="phpdocumentor-element__modifiers">
  611. </span>
  612. </h4>
  613. <aside class="phpdocumentor-element-found-in">
  614. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  615. :
  616. <span class="phpdocumentor-element-found-in__line">28</span>
  617. </aside>
  618. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  619. <code class="phpdocumentor-code phpdocumentor-signature ">
  620. <span class="phpdocumentor-signature__visibility">protected</span>
  621. <span class="phpdocumentor-signature__type">int</span>
  622. <span class="phpdocumentor-signature__name">$moduleCount</span>
  623. </code>
  624. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  625. Tags
  626. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  627. </h5>
  628. <dl class="phpdocumentor-tag-list">
  629. <dt class="phpdocumentor-tag-list__entry">
  630. <span class="phpdocumentor-tag__name">see</span>
  631. </dt>
  632. <dd class="phpdocumentor-tag-list__definition">
  633. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html#method_getSize"><abbr title="\chillerlan\QRCode\Data\QRMatrix::getSize()">QRMatrix::getSize()</abbr></a></span>
  634. </dd>
  635. </dl>
  636. </article>
  637. <article
  638. class="
  639. phpdocumentor-element
  640. -property
  641. -protected
  642. "
  643. >
  644. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  645. $moduleValues
  646. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  647. <span class="phpdocumentor-element__modifiers">
  648. </span>
  649. </h4>
  650. <aside class="phpdocumentor-element-found-in">
  651. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  652. :
  653. <span class="phpdocumentor-element-found-in__line">38</span>
  654. </aside>
  655. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  656. <code class="phpdocumentor-code phpdocumentor-signature ">
  657. <span class="phpdocumentor-signature__visibility">protected</span>
  658. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  659. <span class="phpdocumentor-signature__name">$moduleValues</span>
  660. </code>
  661. </article>
  662. <article
  663. class="
  664. phpdocumentor-element
  665. -property
  666. -protected
  667. "
  668. >
  669. <h4 class="phpdocumentor-element__name" id="property_options">
  670. $options
  671. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  672. <span class="phpdocumentor-element__modifiers">
  673. </span>
  674. </h4>
  675. <aside class="phpdocumentor-element-found-in">
  676. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  677. :
  678. <span class="phpdocumentor-element-found-in__line">48</span>
  679. </aside>
  680. <code class="phpdocumentor-code phpdocumentor-signature ">
  681. <span class="phpdocumentor-signature__visibility">protected</span>
  682. <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>
  683. <span class="phpdocumentor-signature__name">$options</span>
  684. </code>
  685. </article>
  686. <article
  687. class="
  688. phpdocumentor-element
  689. -property
  690. -protected
  691. "
  692. >
  693. <h4 class="phpdocumentor-element__name" id="property_scale">
  694. $scale
  695. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  696. <span class="phpdocumentor-element__modifiers">
  697. </span>
  698. </h4>
  699. <aside class="phpdocumentor-element-found-in">
  700. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  701. :
  702. <span class="phpdocumentor-element-found-in__line">51</span>
  703. </aside>
  704. <code class="phpdocumentor-code phpdocumentor-signature ">
  705. <span class="phpdocumentor-signature__visibility">protected</span>
  706. <span class="phpdocumentor-signature__type">int</span>
  707. <span class="phpdocumentor-signature__name">$scale</span>
  708. </code>
  709. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  710. Tags
  711. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  712. </h5>
  713. <dl class="phpdocumentor-tag-list">
  714. <dt class="phpdocumentor-tag-list__entry">
  715. <span class="phpdocumentor-tag__name">see</span>
  716. </dt>
  717. <dd class="phpdocumentor-tag-list__definition">
  718. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  719. </dd>
  720. </dl>
  721. </article>
  722. </section>
  723. <section class="phpdocumentor-methods">
  724. <h3 class="phpdocumentor-elements__header" id="methods">
  725. Methods
  726. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  727. </h3>
  728. <article
  729. class="phpdocumentor-element
  730. -method
  731. -public
  732. "
  733. >
  734. <h4 class="phpdocumentor-element__name" id="method___construct">
  735. __construct()
  736. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  737. </h4>
  738. <aside class="phpdocumentor-element-found-in">
  739. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  740. :
  741. <span class="phpdocumentor-element-found-in__line">70</span>
  742. </aside>
  743. <p class="phpdocumentor-summary">QROutputAbstract constructor.</p>
  744. <code class="phpdocumentor-code phpdocumentor-signature ">
  745. <span class="phpdocumentor-signature__visibility">public</span>
  746. <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span></span><span class="phpdocumentor-signature__argument"><span>, </span><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">mixed</span></code>
  747. <div class="phpdocumentor-label-line">
  748. </div>
  749. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  750. <dl class="phpdocumentor-argument-list">
  751. <dt class="phpdocumentor-argument-list__entry">
  752. <span class="phpdocumentor-signature__argument__name">$options</span>
  753. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr></span>
  754. </dt>
  755. <dd class="phpdocumentor-argument-list__definition">
  756. </dd>
  757. <dt class="phpdocumentor-argument-list__entry">
  758. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  759. : <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>
  760. </dt>
  761. <dd class="phpdocumentor-argument-list__definition">
  762. </dd>
  763. </dl>
  764. </article>
  765. <article
  766. class="phpdocumentor-element
  767. -method
  768. -protected
  769. "
  770. >
  771. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  772. collectModules()
  773. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  774. </h4>
  775. <aside class="phpdocumentor-element-found-in">
  776. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  777. :
  778. <span class="phpdocumentor-element-found-in__line">227</span>
  779. </aside>
  780. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  781. returns an array with the transformed modules</p>
  782. <code class="phpdocumentor-code phpdocumentor-signature ">
  783. <span class="phpdocumentor-signature__visibility">protected</span>
  784. <span class="phpdocumentor-signature__name">collectModules</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$transform</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  785. <div class="phpdocumentor-label-line">
  786. </div>
  787. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  788. <p>$x - current column
  789. $y - current row
  790. $M_TYPE - field value
  791. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  792. </section>
  793. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  794. <dl class="phpdocumentor-argument-list">
  795. <dt class="phpdocumentor-argument-list__entry">
  796. <span class="phpdocumentor-signature__argument__name">$transform</span>
  797. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  798. </dt>
  799. <dd class="phpdocumentor-argument-list__definition">
  800. </dd>
  801. </dl>
  802. <section>
  803. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  804. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  805. </section>
  806. </article>
  807. <article
  808. class="phpdocumentor-element
  809. -method
  810. -protected
  811. "
  812. >
  813. <h4 class="phpdocumentor-element__name" id="method_copyVars">
  814. copyVars()
  815. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars" class="headerlink"><i class="fas fa-link"></i></a>
  816. </h4>
  817. <aside class="phpdocumentor-element-found-in">
  818. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  819. :
  820. <span class="phpdocumentor-element-found-in__line">89</span>
  821. </aside>
  822. <p class="phpdocumentor-summary">Creates copies of several QROptions values to avoid calling the magic getters
  823. in long loops for a significant performance increase.</p>
  824. <code class="phpdocumentor-code phpdocumentor-signature ">
  825. <span class="phpdocumentor-signature__visibility">protected</span>
  826. <span class="phpdocumentor-signature__name">copyVars</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  827. <div class="phpdocumentor-label-line">
  828. </div>
  829. <section class="phpdocumentor-description"><p>These variables are usually used in the &quot;module&quot; methods and are called up to 31329 times (at version 40).</p>
  830. </section>
  831. </article>
  832. <article
  833. class="phpdocumentor-element
  834. -method
  835. -protected
  836. -abstract "
  837. >
  838. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  839. getDefaultModuleValue()
  840. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  841. </h4>
  842. <aside class="phpdocumentor-element-found-in">
  843. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  844. :
  845. <span class="phpdocumentor-element-found-in__line">184</span>
  846. </aside>
  847. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules</p>
  848. <code class="phpdocumentor-code phpdocumentor-signature ">
  849. <span class="phpdocumentor-signature__visibility">protected</span>
  850. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getDefaultModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$isDark</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  851. <div class="phpdocumentor-label-line">
  852. </div>
  853. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  854. <dl class="phpdocumentor-argument-list">
  855. <dt class="phpdocumentor-argument-list__entry">
  856. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  857. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  858. </dt>
  859. <dd class="phpdocumentor-argument-list__definition">
  860. </dd>
  861. </dl>
  862. <section>
  863. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  864. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  865. &mdash;
  866. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  867. </section>
  868. </section>
  869. </article>
  870. <article
  871. class="phpdocumentor-element
  872. -method
  873. -protected
  874. "
  875. >
  876. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  877. getModuleValue()
  878. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  879. </h4>
  880. <aside class="phpdocumentor-element-found-in">
  881. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  882. :
  883. <span class="phpdocumentor-element-found-in__line">152</span>
  884. </aside>
  885. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  886. <code class="phpdocumentor-code phpdocumentor-signature ">
  887. <span class="phpdocumentor-signature__visibility">protected</span>
  888. <span class="phpdocumentor-signature__name">getModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$M_TYPE</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
  889. <div class="phpdocumentor-label-line">
  890. </div>
  891. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  892. <dl class="phpdocumentor-argument-list">
  893. <dt class="phpdocumentor-argument-list__entry">
  894. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  895. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  896. </dt>
  897. <dd class="phpdocumentor-argument-list__definition">
  898. </dd>
  899. </dl>
  900. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  901. Tags
  902. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  903. </h5>
  904. <dl class="phpdocumentor-tag-list">
  905. <dt class="phpdocumentor-tag-list__entry">
  906. <span class="phpdocumentor-tag__name">throws</span>
  907. </dt>
  908. <dd class="phpdocumentor-tag-list__definition">
  909. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  910. <section class="phpdocumentor-description"><p>if $moduleValues[$M_TYPE] doesn't exist</p>
  911. </section>
  912. </dd>
  913. </dl>
  914. <section>
  915. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  916. <span class="phpdocumentor-signature__response_type">mixed</span>
  917. &mdash;
  918. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  919. </section>
  920. </section>
  921. </article>
  922. <article
  923. class="phpdocumentor-element
  924. -method
  925. -protected
  926. "
  927. >
  928. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  929. getModuleValueAt()
  930. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  931. </h4>
  932. <aside class="phpdocumentor-element-found-in">
  933. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  934. :
  935. <span class="phpdocumentor-element-found-in__line">166</span>
  936. </aside>
  937. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  938. <code class="phpdocumentor-code phpdocumentor-signature ">
  939. <span class="phpdocumentor-signature__visibility">protected</span>
  940. <span class="phpdocumentor-signature__name">getModuleValueAt</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$x</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$y</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  941. <div class="phpdocumentor-label-line">
  942. </div>
  943. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  944. <dl class="phpdocumentor-argument-list">
  945. <dt class="phpdocumentor-argument-list__entry">
  946. <span class="phpdocumentor-signature__argument__name">$x</span>
  947. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  948. </dt>
  949. <dd class="phpdocumentor-argument-list__definition">
  950. </dd>
  951. <dt class="phpdocumentor-argument-list__entry">
  952. <span class="phpdocumentor-signature__argument__name">$y</span>
  953. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  954. </dt>
  955. <dd class="phpdocumentor-argument-list__definition">
  956. </dd>
  957. </dl>
  958. <section>
  959. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  960. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  961. </section>
  962. </article>
  963. <article
  964. class="phpdocumentor-element
  965. -method
  966. -protected
  967. "
  968. >
  969. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  970. getOutputDimensions()
  971. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  972. </h4>
  973. <aside class="phpdocumentor-element-found-in">
  974. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  975. :
  976. <span class="phpdocumentor-element-found-in__line">123</span>
  977. </aside>
  978. <p class="phpdocumentor-summary">Returns a 2 element array with the current output width and height</p>
  979. <code class="phpdocumentor-code phpdocumentor-signature ">
  980. <span class="phpdocumentor-signature__visibility">protected</span>
  981. <span class="phpdocumentor-signature__name">getOutputDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
  982. <div class="phpdocumentor-label-line">
  983. </div>
  984. <section class="phpdocumentor-description"><p>The type and units of the values depend on the output class. The default value is the current module count * scale.</p>
  985. </section>
  986. <section>
  987. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  988. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  989. </section>
  990. </article>
  991. <article
  992. class="phpdocumentor-element
  993. -method
  994. -protected
  995. -abstract "
  996. >
  997. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  998. prepareModuleValue()
  999. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1000. </h4>
  1001. <aside class="phpdocumentor-element-found-in">
  1002. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1003. :
  1004. <span class="phpdocumentor-element-found-in__line">177</span>
  1005. </aside>
  1006. <p class="phpdocumentor-summary">Prepares the value for the given input ()</p>
  1007. <code class="phpdocumentor-code phpdocumentor-signature ">
  1008. <span class="phpdocumentor-signature__visibility">protected</span>
  1009. <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">prepareModuleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
  1010. <div class="phpdocumentor-label-line">
  1011. </div>
  1012. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1013. <dl class="phpdocumentor-argument-list">
  1014. <dt class="phpdocumentor-argument-list__entry">
  1015. <span class="phpdocumentor-signature__argument__name">$value</span>
  1016. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1017. </dt>
  1018. <dd class="phpdocumentor-argument-list__definition">
  1019. </dd>
  1020. </dl>
  1021. <section>
  1022. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1023. <span class="phpdocumentor-signature__response_type">mixed|null</span>
  1024. &mdash;
  1025. <section class="phpdocumentor-description"><p>return value depends on the output class</p>
  1026. </section>
  1027. </section>
  1028. </article>
  1029. <article
  1030. class="phpdocumentor-element
  1031. -method
  1032. -protected
  1033. "
  1034. >
  1035. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1036. saveToFile()
  1037. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1038. </h4>
  1039. <aside class="phpdocumentor-element-found-in">
  1040. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1041. :
  1042. <span class="phpdocumentor-element-found-in__line">201</span>
  1043. </aside>
  1044. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1045. <code class="phpdocumentor-code phpdocumentor-signature ">
  1046. <span class="phpdocumentor-signature__visibility">protected</span>
  1047. <span class="phpdocumentor-signature__name">saveToFile</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 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">void</span></code>
  1048. <div class="phpdocumentor-label-line">
  1049. </div>
  1050. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1051. <dl class="phpdocumentor-argument-list">
  1052. <dt class="phpdocumentor-argument-list__entry">
  1053. <span class="phpdocumentor-signature__argument__name">$data</span>
  1054. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1055. </dt>
  1056. <dd class="phpdocumentor-argument-list__definition">
  1057. </dd>
  1058. <dt class="phpdocumentor-argument-list__entry">
  1059. <span class="phpdocumentor-signature__argument__name">$file</span>
  1060. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1061. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1062. <dd class="phpdocumentor-argument-list__definition">
  1063. </dd>
  1064. </dl>
  1065. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1066. Tags
  1067. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1068. </h5>
  1069. <dl class="phpdocumentor-tag-list">
  1070. <dt class="phpdocumentor-tag-list__entry">
  1071. <span class="phpdocumentor-tag__name">see</span>
  1072. </dt>
  1073. <dd class="phpdocumentor-tag-list__definition">
  1074. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1075. </dd>
  1076. <dt class="phpdocumentor-tag-list__entry">
  1077. <span class="phpdocumentor-tag__name">see</span>
  1078. </dt>
  1079. <dd class="phpdocumentor-tag-list__definition">
  1080. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1081. </dd>
  1082. <dt class="phpdocumentor-tag-list__entry">
  1083. <span class="phpdocumentor-tag__name">throws</span>
  1084. </dt>
  1085. <dd class="phpdocumentor-tag-list__definition">
  1086. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1087. </dd>
  1088. </dl>
  1089. </article>
  1090. <article
  1091. class="phpdocumentor-element
  1092. -method
  1093. -protected
  1094. "
  1095. >
  1096. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1097. setMatrixDimensions()
  1098. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1099. </h4>
  1100. <aside class="phpdocumentor-element-found-in">
  1101. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1102. :
  1103. <span class="phpdocumentor-element-found-in__line">112</span>
  1104. </aside>
  1105. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1106. <code class="phpdocumentor-code phpdocumentor-signature ">
  1107. <span class="phpdocumentor-signature__visibility">protected</span>
  1108. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1109. <div class="phpdocumentor-label-line">
  1110. </div>
  1111. <section class="phpdocumentor-description"><p>Call this method if you modify the matrix from within your custom module in case the dimensions have been changed</p>
  1112. </section>
  1113. </article>
  1114. <article
  1115. class="phpdocumentor-element
  1116. -method
  1117. -protected
  1118. "
  1119. >
  1120. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1121. setModuleValues()
  1122. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1123. </h4>
  1124. <aside class="phpdocumentor-element-found-in">
  1125. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1126. :
  1127. <span class="phpdocumentor-element-found-in__line">130</span>
  1128. </aside>
  1129. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1130. <code class="phpdocumentor-code phpdocumentor-signature ">
  1131. <span class="phpdocumentor-signature__visibility">protected</span>
  1132. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1133. <div class="phpdocumentor-label-line">
  1134. </div>
  1135. </article>
  1136. <article
  1137. class="phpdocumentor-element
  1138. -method
  1139. -protected
  1140. "
  1141. >
  1142. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1143. toBase64DataURI()
  1144. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1145. </h4>
  1146. <aside class="phpdocumentor-element-found-in">
  1147. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1148. :
  1149. <span class="phpdocumentor-element-found-in__line">189</span>
  1150. </aside>
  1151. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1152. <code class="phpdocumentor-code phpdocumentor-signature ">
  1153. <span class="phpdocumentor-signature__visibility">protected</span>
  1154. <span class="phpdocumentor-signature__name">toBase64DataURI</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 class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$mime</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
  1155. <div class="phpdocumentor-label-line">
  1156. </div>
  1157. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1158. <dl class="phpdocumentor-argument-list">
  1159. <dt class="phpdocumentor-argument-list__entry">
  1160. <span class="phpdocumentor-signature__argument__name">$data</span>
  1161. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1162. </dt>
  1163. <dd class="phpdocumentor-argument-list__definition">
  1164. </dd>
  1165. <dt class="phpdocumentor-argument-list__entry">
  1166. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1167. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1168. </dt>
  1169. <dd class="phpdocumentor-argument-list__definition">
  1170. </dd>
  1171. </dl>
  1172. <section>
  1173. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1174. <span class="phpdocumentor-signature__response_type">string</span>
  1175. </section>
  1176. </article>
  1177. </section>
  1178. <div class="phpdocumentor-modal" id="source-view">
  1179. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1180. <div class="phpdocumentor-modal-container">
  1181. <div class="phpdocumentor-modal-content">
  1182. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Output/QROutputAbstract.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  1183. </div>
  1184. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1185. </div>
  1186. </div>
  1187. <script type="text/javascript">
  1188. (function () {
  1189. function loadExternalCodeSnippet(el, url, line) {
  1190. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1191. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1192. const language = 'php';
  1193. const code = document.createElement('code');
  1194. code.className = 'language-' + language;
  1195. pre.textContent = '';
  1196. pre.setAttribute('data-line', line)
  1197. code.textContent = 'Loading…';
  1198. pre.appendChild(code);
  1199. var xhr = new XMLHttpRequest();
  1200. xhr.open('GET', src, true);
  1201. xhr.onreadystatechange = function () {
  1202. if (xhr.readyState !== 4) {
  1203. return;
  1204. }
  1205. if (xhr.status < 400 && xhr.responseText) {
  1206. code.textContent = xhr.responseText;
  1207. Prism.highlightElement(code);
  1208. return;
  1209. }
  1210. if (xhr.status === 404) {
  1211. code.textContent = '✖ Error: File could not be found';
  1212. return;
  1213. }
  1214. if (xhr.status >= 400) {
  1215. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1216. return;
  1217. }
  1218. code.textContent = '✖ Error: An unknown error occurred';
  1219. };
  1220. xhr.send(null);
  1221. });
  1222. }
  1223. const modalButtons = document.querySelectorAll("[data-modal]");
  1224. const openedAsLocalFile = window.location.protocol === 'file:';
  1225. if (modalButtons.length > 0 && openedAsLocalFile) {
  1226. console.warn(
  1227. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1228. 'browsers block XHR requests when a page is opened this way'
  1229. );
  1230. }
  1231. modalButtons.forEach(function (trigger) {
  1232. if (openedAsLocalFile) {
  1233. trigger.setAttribute("hidden", "hidden");
  1234. }
  1235. trigger.addEventListener("click", function (event) {
  1236. event.preventDefault();
  1237. const modal = document.getElementById(trigger.dataset.modal);
  1238. if (!modal) {
  1239. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1240. return;
  1241. }
  1242. modal.classList.add("phpdocumentor-modal__open");
  1243. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1244. const exits = modal.querySelectorAll("[data-exit-button]");
  1245. exits.forEach(function (exit) {
  1246. exit.addEventListener("click", function (event) {
  1247. event.preventDefault();
  1248. modal.classList.remove("phpdocumentor-modal__open");
  1249. });
  1250. });
  1251. });
  1252. });
  1253. })();
  1254. </script>
  1255. </article>
  1256. </section>
  1257. <section class="phpdocumentor-on-this-page__sidebar">
  1258. <section class="phpdocumentor-on-this-page__content">
  1259. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1260. <ul class="phpdocumentor-list -clean">
  1261. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1262. <li>
  1263. <ul class="phpdocumentor-list -clean">
  1264. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc-properties">Properties</a></li>
  1265. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#toc-methods">Methods</a></li>
  1266. </ul>
  1267. </li>
  1268. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1269. <li>
  1270. <ul class="phpdocumentor-list -clean">
  1271. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1272. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1273. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1274. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1275. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1276. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1277. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1278. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1279. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1280. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1281. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1282. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1283. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"></li>
  1284. </ul>
  1285. </li>
  1286. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1287. <li>
  1288. <ul class="phpdocumentor-list -clean">
  1289. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method___construct">__construct()</a></li>
  1290. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1291. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a></li>
  1292. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1293. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1294. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1295. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1296. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1297. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1298. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1299. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1300. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1301. </ul>
  1302. </li>
  1303. </ul>
  1304. </section>
  1305. </section>
  1306. </div>
  1307. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1308. <section class="phpdocumentor-search-results__dialog">
  1309. <header class="phpdocumentor-search-results__header">
  1310. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1311. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1312. </header>
  1313. <section class="phpdocumentor-search-results__body">
  1314. <ul class="phpdocumentor-search-results__entries"></ul>
  1315. </section>
  1316. </section>
  1317. </section>
  1318. </div>
  1319. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1320. </main>
  1321. <script>
  1322. cssVars({});
  1323. </script>
  1324. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1325. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1326. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1327. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1328. </body>
  1329. </html>