chillerlan-QRCode-Output-QROutputAbstract.html 84 KB

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