chillerlan-QRCode-Output-QRInterventionImage.html 107 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172
  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. QRInterventionImage
  112. <span class="phpdocumentor-element__extends">
  113. extends <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html"><abbr title="\chillerlan\QRCode\Output\QROutputAbstract">QROutputAbstract</abbr></a>
  114. </span>
  115. <div class="phpdocumentor-element__package">
  116. in package
  117. <ul class="phpdocumentor-breadcrumbs">
  118. <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
  119. </ul>
  120. </div>
  121. <span class="phpdocumentor-element__extends">
  122. Uses
  123. <a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html"><abbr title="\chillerlan\QRCode\Output\CssColorModuleValueTrait">CssColorModuleValueTrait</abbr></a> </span>
  124. </h2>
  125. <div class="phpdocumentor-label-line">
  126. </div>
  127. <aside class="phpdocumentor-element-found-in">
  128. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRInterventionImage.php"><a href="files/src-output-qrinterventionimage.html"><abbr title="src/Output/QRInterventionImage.php">QRInterventionImage.php</abbr></a></abbr>
  129. :
  130. <span class="phpdocumentor-element-found-in__line">38</span>
  131. </aside>
  132. <p class="phpdocumentor-summary">intervention/image (GD/ImageMagick) output</p>
  133. <section class="phpdocumentor-description"><p>note: this output class works very slow compared to the native GD/Imagick output classes for obvious reasons.
  134. use only if you must.</p>
  135. </section>
  136. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  137. Tags
  138. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
  139. </h5>
  140. <dl class="phpdocumentor-tag-list">
  141. <dt class="phpdocumentor-tag-list__entry">
  142. <span class="phpdocumentor-tag__name">see</span>
  143. </dt>
  144. <dd class="phpdocumentor-tag-list__definition">
  145. <span class="phpdocumentor-tag-link"><a href="https://github.com/Intervention/image">https://github.com/Intervention/image</a></span>
  146. </dd>
  147. <dt class="phpdocumentor-tag-list__entry">
  148. <span class="phpdocumentor-tag__name">see</span>
  149. </dt>
  150. <dd class="phpdocumentor-tag-list__definition">
  151. <span class="phpdocumentor-tag-link"><a href="https://image.intervention.io/">https://image.intervention.io/</a></span>
  152. </dd>
  153. </dl>
  154. <h3 id="toc">
  155. Table of Contents
  156. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
  157. </h3>
  158. <h4 id="toc-properties">
  159. Properties
  160. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
  161. </h4>
  162. <dl class="phpdocumentor-table-of-contents">
  163. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  164. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter</a>
  165. <span>
  166. &nbsp;: float </span>
  167. </dt>
  168. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  169. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius</a>
  170. <span>
  171. &nbsp;: float </span>
  172. </dt>
  173. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  174. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths</a>
  175. <span>
  176. &nbsp;: bool </span>
  177. </dt>
  178. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  179. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules</a>
  180. <span>
  181. &nbsp;: bool </span>
  182. </dt>
  183. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  184. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules</a>
  185. <span>
  186. &nbsp;: bool </span>
  187. </dt>
  188. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  189. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#property_driver">$driver</a>
  190. <span>
  191. &nbsp;: <abbr title="\Intervention\Image\Interfaces\DriverInterface">DriverInterface</abbr> </span>
  192. </dt>
  193. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  194. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol</a>
  195. <span>
  196. &nbsp;: string </span>
  197. </dt>
  198. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  199. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect</a>
  200. <span>
  201. &nbsp;: array&lt;string|int, mixed&gt; </span>
  202. </dt>
  203. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  204. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#property_image">$image</a>
  205. <span>
  206. &nbsp;: <abbr title="\Intervention\Image\Interfaces\ImageInterface">ImageInterface</abbr> </span>
  207. </dt>
  208. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  209. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare</a>
  210. <span>
  211. &nbsp;: array&lt;string|int, mixed&gt; </span>
  212. </dt>
  213. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  214. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length</a>
  215. <span>
  216. &nbsp;: int </span>
  217. </dt>
  218. <dd>the side length of the QR image (modules * scale)</dd>
  219. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  220. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#property_manager">$manager</a>
  221. <span>
  222. &nbsp;: <abbr title="\Intervention\Image\Interfaces\ImageManagerInterface">ImageManagerInterface</abbr> </span>
  223. </dt>
  224. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  225. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix</a>
  226. <span>
  227. &nbsp;: <a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a> </span>
  228. </dt>
  229. <dd>the (filled) data matrix object</dd>
  230. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  231. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount</a>
  232. <span>
  233. &nbsp;: int </span>
  234. </dt>
  235. <dd>the current size of the QR matrix</dd>
  236. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  237. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues</a>
  238. <span>
  239. &nbsp;: array&lt;string|int, mixed&gt; </span>
  240. </dt>
  241. <dd>an (optional) array of color values for the several QR matrix parts</dd>
  242. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  243. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options</a>
  244. <span>
  245. &nbsp;: <abbr title="\chillerlan\Settings\SettingsContainerInterface">SettingsContainerInterface</abbr>|<a href="classes/chillerlan-QRCode-QROptions.html"><abbr title="\chillerlan\QRCode\QROptions">QROptions</abbr></a> </span>
  246. </dt>
  247. <dd>the options instance</dd>
  248. <dt class="phpdocumentor-table-of-contents__entry -property -protected">
  249. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale</a>
  250. <span>
  251. &nbsp;: int </span>
  252. </dt>
  253. </dl>
  254. <h4 id="toc-methods">
  255. Methods
  256. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
  257. </h4>
  258. <dl class="phpdocumentor-table-of-contents">
  259. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  260. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method___construct">__construct()</a>
  261. <span>
  262. &nbsp;: mixed </span>
  263. </dt>
  264. <dd>QRInterventionImage constructor.</dd>
  265. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  266. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method_dump">dump()</a>
  267. <span>
  268. &nbsp;: string|<abbr title="\Intervention\Image\Interfaces\ImageInterface">ImageInterface</abbr> </span>
  269. </dt>
  270. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  271. <a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_moduleValueIsValid">moduleValueIsValid()</a>
  272. <span>
  273. &nbsp;: bool </span>
  274. </dt>
  275. <dd>note: we&#039;re not necessarily validating the several values, just checking the general syntax
  276. note: css4 colors are not included</dd>
  277. <dt class="phpdocumentor-table-of-contents__entry -method -public">
  278. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method_setDriver">setDriver()</a>
  279. <span>
  280. &nbsp;: static </span>
  281. </dt>
  282. <dd>Sets a DriverInterface</dd>
  283. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  284. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a>
  285. <span>
  286. &nbsp;: array&lt;string|int, mixed&gt; </span>
  287. </dt>
  288. <dd>collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  289. returns an array with the transformed modules</dd>
  290. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  291. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a>
  292. <span>
  293. &nbsp;: void </span>
  294. </dt>
  295. <dd>Creates copies of several QROptions values to avoid calling the magic getters
  296. in long loops for a significant performance increase.</dd>
  297. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  298. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a>
  299. <span>
  300. &nbsp;: mixed </span>
  301. </dt>
  302. <dd>Returns a default value for either dark or light modules (return value depends on the output class)</dd>
  303. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  304. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a>
  305. <span>
  306. &nbsp;: mixed </span>
  307. </dt>
  308. <dd>Returns the prepared value for the given $M_TYPE</dd>
  309. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  310. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a>
  311. <span>
  312. &nbsp;: mixed </span>
  313. </dt>
  314. <dd>Returns the prepared module value at the given coordinate [$x, $y] (convenience)</dd>
  315. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  316. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a>
  317. <span>
  318. &nbsp;: array&lt;string|int, mixed&gt; </span>
  319. </dt>
  320. <dd>Returns a 2 element array with the current output width and height</dd>
  321. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  322. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method_module">module()</a>
  323. <span>
  324. &nbsp;: void </span>
  325. </dt>
  326. <dd>draws a single pixel at the given position</dd>
  327. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  328. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a>
  329. <span>
  330. &nbsp;: mixed </span>
  331. </dt>
  332. <dd>Prepares the value for the given input (return value depends on the output class)</dd>
  333. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  334. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a>
  335. <span>
  336. &nbsp;: void </span>
  337. </dt>
  338. <dd>Saves the qr $data to a $file. If $file is null, nothing happens.</dd>
  339. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  340. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a>
  341. <span>
  342. &nbsp;: void </span>
  343. </dt>
  344. <dd>Sets/updates the matrix dimensions</dd>
  345. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  346. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a>
  347. <span>
  348. &nbsp;: void </span>
  349. </dt>
  350. <dd>Sets the initial module values</dd>
  351. <dt class="phpdocumentor-table-of-contents__entry -method -protected">
  352. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a>
  353. <span>
  354. &nbsp;: string </span>
  355. </dt>
  356. <dd>Returns a base64 data URI for the given string and mime type</dd>
  357. </dl>
  358. <section class="phpdocumentor-properties">
  359. <h3 class="phpdocumentor-elements__header" id="properties">
  360. Properties
  361. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
  362. </h3>
  363. <article
  364. class="
  365. phpdocumentor-element
  366. -property
  367. -protected
  368. "
  369. >
  370. <h4 class="phpdocumentor-element__name" id="property_circleDiameter">
  371. $circleDiameter
  372. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter" class="headerlink"><i class="fas fa-link"></i></a>
  373. <span class="phpdocumentor-element__modifiers">
  374. </span>
  375. </h4>
  376. <aside class="phpdocumentor-element-found-in">
  377. <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>
  378. :
  379. <span class="phpdocumentor-element-found-in__line">67</span>
  380. </aside>
  381. <code class="phpdocumentor-code phpdocumentor-signature ">
  382. <span class="phpdocumentor-signature__visibility">protected</span>
  383. <span class="phpdocumentor-signature__type">float</span>
  384. <span class="phpdocumentor-signature__name">$circleDiameter</span>
  385. </code>
  386. </article>
  387. <article
  388. class="
  389. phpdocumentor-element
  390. -property
  391. -protected
  392. "
  393. >
  394. <h4 class="phpdocumentor-element__name" id="property_circleRadius">
  395. $circleRadius
  396. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius" class="headerlink"><i class="fas fa-link"></i></a>
  397. <span class="phpdocumentor-element__modifiers">
  398. </span>
  399. </h4>
  400. <aside class="phpdocumentor-element-found-in">
  401. <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>
  402. :
  403. <span class="phpdocumentor-element-found-in__line">66</span>
  404. </aside>
  405. <code class="phpdocumentor-code phpdocumentor-signature ">
  406. <span class="phpdocumentor-signature__visibility">protected</span>
  407. <span class="phpdocumentor-signature__type">float</span>
  408. <span class="phpdocumentor-signature__name">$circleRadius</span>
  409. </code>
  410. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  411. Tags
  412. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius#tags" class="headerlink"><i class="fas fa-link"></i></a>
  413. </h5>
  414. <dl class="phpdocumentor-tag-list">
  415. <dt class="phpdocumentor-tag-list__entry">
  416. <span class="phpdocumentor-tag__name">see</span>
  417. </dt>
  418. <dd class="phpdocumentor-tag-list__definition">
  419. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$circleRadius">QROptions::$circleRadius</abbr></span>
  420. </dd>
  421. </dl>
  422. </article>
  423. <article
  424. class="
  425. phpdocumentor-element
  426. -property
  427. -protected
  428. "
  429. >
  430. <h4 class="phpdocumentor-element__name" id="property_connectPaths">
  431. $connectPaths
  432. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths" class="headerlink"><i class="fas fa-link"></i></a>
  433. <span class="phpdocumentor-element__modifiers">
  434. </span>
  435. </h4>
  436. <aside class="phpdocumentor-element-found-in">
  437. <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>
  438. :
  439. <span class="phpdocumentor-element-found-in__line">54</span>
  440. </aside>
  441. <code class="phpdocumentor-code phpdocumentor-signature ">
  442. <span class="phpdocumentor-signature__visibility">protected</span>
  443. <span class="phpdocumentor-signature__type">bool</span>
  444. <span class="phpdocumentor-signature__name">$connectPaths</span>
  445. </code>
  446. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  447. Tags
  448. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths#tags" class="headerlink"><i class="fas fa-link"></i></a>
  449. </h5>
  450. <dl class="phpdocumentor-tag-list">
  451. <dt class="phpdocumentor-tag-list__entry">
  452. <span class="phpdocumentor-tag__name">see</span>
  453. </dt>
  454. <dd class="phpdocumentor-tag-list__definition">
  455. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$connectPaths">QROptions::$connectPaths</abbr></span>
  456. </dd>
  457. </dl>
  458. </article>
  459. <article
  460. class="
  461. phpdocumentor-element
  462. -property
  463. -protected
  464. "
  465. >
  466. <h4 class="phpdocumentor-element__name" id="property_drawCircularModules">
  467. $drawCircularModules
  468. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules" class="headerlink"><i class="fas fa-link"></i></a>
  469. <span class="phpdocumentor-element__modifiers">
  470. </span>
  471. </h4>
  472. <aside class="phpdocumentor-element-found-in">
  473. <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>
  474. :
  475. <span class="phpdocumentor-element-found-in__line">62</span>
  476. </aside>
  477. <code class="phpdocumentor-code phpdocumentor-signature ">
  478. <span class="phpdocumentor-signature__visibility">protected</span>
  479. <span class="phpdocumentor-signature__type">bool</span>
  480. <span class="phpdocumentor-signature__name">$drawCircularModules</span>
  481. </code>
  482. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  483. Tags
  484. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  485. </h5>
  486. <dl class="phpdocumentor-tag-list">
  487. <dt class="phpdocumentor-tag-list__entry">
  488. <span class="phpdocumentor-tag__name">see</span>
  489. </dt>
  490. <dd class="phpdocumentor-tag-list__definition">
  491. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawCircularModules">QROptions::$drawCircularModules</abbr></span>
  492. </dd>
  493. </dl>
  494. </article>
  495. <article
  496. class="
  497. phpdocumentor-element
  498. -property
  499. -protected
  500. "
  501. >
  502. <h4 class="phpdocumentor-element__name" id="property_drawLightModules">
  503. $drawLightModules
  504. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules" class="headerlink"><i class="fas fa-link"></i></a>
  505. <span class="phpdocumentor-element__modifiers">
  506. </span>
  507. </h4>
  508. <aside class="phpdocumentor-element-found-in">
  509. <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>
  510. :
  511. <span class="phpdocumentor-element-found-in__line">60</span>
  512. </aside>
  513. <code class="phpdocumentor-code phpdocumentor-signature ">
  514. <span class="phpdocumentor-signature__visibility">protected</span>
  515. <span class="phpdocumentor-signature__type">bool</span>
  516. <span class="phpdocumentor-signature__name">$drawLightModules</span>
  517. </code>
  518. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  519. Tags
  520. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
  521. </h5>
  522. <dl class="phpdocumentor-tag-list">
  523. <dt class="phpdocumentor-tag-list__entry">
  524. <span class="phpdocumentor-tag__name">see</span>
  525. </dt>
  526. <dd class="phpdocumentor-tag-list__definition">
  527. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$drawLightModules">QROptions::$drawLightModules</abbr></span>
  528. </dd>
  529. </dl>
  530. </article>
  531. <article
  532. class="
  533. phpdocumentor-element
  534. -property
  535. -protected
  536. "
  537. >
  538. <h4 class="phpdocumentor-element__name" id="property_driver">
  539. $driver
  540. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#property_driver" class="headerlink"><i class="fas fa-link"></i></a>
  541. <span class="phpdocumentor-element__modifiers">
  542. </span>
  543. </h4>
  544. <aside class="phpdocumentor-element-found-in">
  545. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRInterventionImage.php"><a href="files/src-output-qrinterventionimage.html"><abbr title="src/Output/QRInterventionImage.php">QRInterventionImage.php</abbr></a></abbr>
  546. :
  547. <span class="phpdocumentor-element-found-in__line">41</span>
  548. </aside>
  549. <code class="phpdocumentor-code phpdocumentor-signature ">
  550. <span class="phpdocumentor-signature__visibility">protected</span>
  551. <span class="phpdocumentor-signature__type"><abbr title="\Intervention\Image\Interfaces\DriverInterface">DriverInterface</abbr></span>
  552. <span class="phpdocumentor-signature__name">$driver</span>
  553. </code>
  554. </article>
  555. <article
  556. class="
  557. phpdocumentor-element
  558. -property
  559. -protected
  560. "
  561. >
  562. <h4 class="phpdocumentor-element__name" id="property_eol">
  563. $eol
  564. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol" class="headerlink"><i class="fas fa-link"></i></a>
  565. <span class="phpdocumentor-element__modifiers">
  566. </span>
  567. </h4>
  568. <aside class="phpdocumentor-element-found-in">
  569. <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>
  570. :
  571. <span class="phpdocumentor-element-found-in__line">58</span>
  572. </aside>
  573. <code class="phpdocumentor-code phpdocumentor-signature ">
  574. <span class="phpdocumentor-signature__visibility">protected</span>
  575. <span class="phpdocumentor-signature__type">string</span>
  576. <span class="phpdocumentor-signature__name">$eol</span>
  577. </code>
  578. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  579. Tags
  580. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol#tags" class="headerlink"><i class="fas fa-link"></i></a>
  581. </h5>
  582. <dl class="phpdocumentor-tag-list">
  583. <dt class="phpdocumentor-tag-list__entry">
  584. <span class="phpdocumentor-tag__name">see</span>
  585. </dt>
  586. <dd class="phpdocumentor-tag-list__definition">
  587. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$eol">QROptions::$eol</abbr></span>
  588. </dd>
  589. </dl>
  590. </article>
  591. <article
  592. class="
  593. phpdocumentor-element
  594. -property
  595. -protected
  596. "
  597. >
  598. <h4 class="phpdocumentor-element__name" id="property_excludeFromConnect">
  599. $excludeFromConnect
  600. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect" class="headerlink"><i class="fas fa-link"></i></a>
  601. <span class="phpdocumentor-element__modifiers">
  602. </span>
  603. </h4>
  604. <aside class="phpdocumentor-element-found-in">
  605. <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>
  606. :
  607. <span class="phpdocumentor-element-found-in__line">56</span>
  608. </aside>
  609. <code class="phpdocumentor-code phpdocumentor-signature ">
  610. <span class="phpdocumentor-signature__visibility">protected</span>
  611. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  612. <span class="phpdocumentor-signature__name">$excludeFromConnect</span>
  613. </code>
  614. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  615. Tags
  616. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect#tags" class="headerlink"><i class="fas fa-link"></i></a>
  617. </h5>
  618. <dl class="phpdocumentor-tag-list">
  619. <dt class="phpdocumentor-tag-list__entry">
  620. <span class="phpdocumentor-tag__name">see</span>
  621. </dt>
  622. <dd class="phpdocumentor-tag-list__definition">
  623. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$excludeFromConnect">QROptions::$excludeFromConnect</abbr></span>
  624. </dd>
  625. </dl>
  626. </article>
  627. <article
  628. class="
  629. phpdocumentor-element
  630. -property
  631. -protected
  632. "
  633. >
  634. <h4 class="phpdocumentor-element__name" id="property_image">
  635. $image
  636. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#property_image" class="headerlink"><i class="fas fa-link"></i></a>
  637. <span class="phpdocumentor-element__modifiers">
  638. </span>
  639. </h4>
  640. <aside class="phpdocumentor-element-found-in">
  641. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRInterventionImage.php"><a href="files/src-output-qrinterventionimage.html"><abbr title="src/Output/QRInterventionImage.php">QRInterventionImage.php</abbr></a></abbr>
  642. :
  643. <span class="phpdocumentor-element-found-in__line">43</span>
  644. </aside>
  645. <code class="phpdocumentor-code phpdocumentor-signature ">
  646. <span class="phpdocumentor-signature__visibility">protected</span>
  647. <span class="phpdocumentor-signature__type"><abbr title="\Intervention\Image\Interfaces\ImageInterface">ImageInterface</abbr></span>
  648. <span class="phpdocumentor-signature__name">$image</span>
  649. </code>
  650. </article>
  651. <article
  652. class="
  653. phpdocumentor-element
  654. -property
  655. -protected
  656. "
  657. >
  658. <h4 class="phpdocumentor-element__name" id="property_keepAsSquare">
  659. $keepAsSquare
  660. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare" class="headerlink"><i class="fas fa-link"></i></a>
  661. <span class="phpdocumentor-element__modifiers">
  662. </span>
  663. </h4>
  664. <aside class="phpdocumentor-element-found-in">
  665. <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>
  666. :
  667. <span class="phpdocumentor-element-found-in__line">64</span>
  668. </aside>
  669. <code class="phpdocumentor-code phpdocumentor-signature ">
  670. <span class="phpdocumentor-signature__visibility">protected</span>
  671. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  672. <span class="phpdocumentor-signature__name">$keepAsSquare</span>
  673. </code>
  674. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  675. Tags
  676. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare#tags" class="headerlink"><i class="fas fa-link"></i></a>
  677. </h5>
  678. <dl class="phpdocumentor-tag-list">
  679. <dt class="phpdocumentor-tag-list__entry">
  680. <span class="phpdocumentor-tag__name">see</span>
  681. </dt>
  682. <dd class="phpdocumentor-tag-list__definition">
  683. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$keepAsSquare">QROptions::$keepAsSquare</abbr></span>
  684. </dd>
  685. </dl>
  686. </article>
  687. <article
  688. class="
  689. phpdocumentor-element
  690. -property
  691. -protected
  692. "
  693. >
  694. <h4 class="phpdocumentor-element__name" id="property_length">
  695. $length
  696. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length" class="headerlink"><i class="fas fa-link"></i></a>
  697. <span class="phpdocumentor-element__modifiers">
  698. </span>
  699. </h4>
  700. <aside class="phpdocumentor-element-found-in">
  701. <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>
  702. :
  703. <span class="phpdocumentor-element-found-in__line">34</span>
  704. </aside>
  705. <p class="phpdocumentor-summary">the side length of the QR image (modules * scale)</p>
  706. <code class="phpdocumentor-code phpdocumentor-signature ">
  707. <span class="phpdocumentor-signature__visibility">protected</span>
  708. <span class="phpdocumentor-signature__type">int</span>
  709. <span class="phpdocumentor-signature__name">$length</span>
  710. </code>
  711. </article>
  712. <article
  713. class="
  714. phpdocumentor-element
  715. -property
  716. -protected
  717. "
  718. >
  719. <h4 class="phpdocumentor-element__name" id="property_manager">
  720. $manager
  721. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#property_manager" class="headerlink"><i class="fas fa-link"></i></a>
  722. <span class="phpdocumentor-element__modifiers">
  723. </span>
  724. </h4>
  725. <aside class="phpdocumentor-element-found-in">
  726. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRInterventionImage.php"><a href="files/src-output-qrinterventionimage.html"><abbr title="src/Output/QRInterventionImage.php">QRInterventionImage.php</abbr></a></abbr>
  727. :
  728. <span class="phpdocumentor-element-found-in__line">42</span>
  729. </aside>
  730. <code class="phpdocumentor-code phpdocumentor-signature ">
  731. <span class="phpdocumentor-signature__visibility">protected</span>
  732. <span class="phpdocumentor-signature__type"><abbr title="\Intervention\Image\Interfaces\ImageManagerInterface">ImageManagerInterface</abbr></span>
  733. <span class="phpdocumentor-signature__name">$manager</span>
  734. </code>
  735. </article>
  736. <article
  737. class="
  738. phpdocumentor-element
  739. -property
  740. -protected
  741. "
  742. >
  743. <h4 class="phpdocumentor-element__name" id="property_matrix">
  744. $matrix
  745. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix" class="headerlink"><i class="fas fa-link"></i></a>
  746. <span class="phpdocumentor-element__modifiers">
  747. </span>
  748. </h4>
  749. <aside class="phpdocumentor-element-found-in">
  750. <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>
  751. :
  752. <span class="phpdocumentor-element-found-in__line">44</span>
  753. </aside>
  754. <p class="phpdocumentor-summary">the (filled) data matrix object</p>
  755. <code class="phpdocumentor-code phpdocumentor-signature ">
  756. <span class="phpdocumentor-signature__visibility">protected</span>
  757. <span class="phpdocumentor-signature__type"><a href="classes/chillerlan-QRCode-Data-QRMatrix.html"><abbr title="\chillerlan\QRCode\Data\QRMatrix">QRMatrix</abbr></a></span>
  758. <span class="phpdocumentor-signature__name">$matrix</span>
  759. </code>
  760. </article>
  761. <article
  762. class="
  763. phpdocumentor-element
  764. -property
  765. -protected
  766. "
  767. >
  768. <h4 class="phpdocumentor-element__name" id="property_moduleCount">
  769. $moduleCount
  770. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount" class="headerlink"><i class="fas fa-link"></i></a>
  771. <span class="phpdocumentor-element__modifiers">
  772. </span>
  773. </h4>
  774. <aside class="phpdocumentor-element-found-in">
  775. <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>
  776. :
  777. <span class="phpdocumentor-element-found-in__line">29</span>
  778. </aside>
  779. <p class="phpdocumentor-summary">the current size of the QR matrix</p>
  780. <code class="phpdocumentor-code phpdocumentor-signature ">
  781. <span class="phpdocumentor-signature__visibility">protected</span>
  782. <span class="phpdocumentor-signature__type">int</span>
  783. <span class="phpdocumentor-signature__name">$moduleCount</span>
  784. </code>
  785. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  786. Tags
  787. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount#tags" class="headerlink"><i class="fas fa-link"></i></a>
  788. </h5>
  789. <dl class="phpdocumentor-tag-list">
  790. <dt class="phpdocumentor-tag-list__entry">
  791. <span class="phpdocumentor-tag__name">see</span>
  792. </dt>
  793. <dd class="phpdocumentor-tag-list__definition">
  794. <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>
  795. </dd>
  796. </dl>
  797. </article>
  798. <article
  799. class="
  800. phpdocumentor-element
  801. -property
  802. -protected
  803. "
  804. >
  805. <h4 class="phpdocumentor-element__name" id="property_moduleValues">
  806. $moduleValues
  807. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues" class="headerlink"><i class="fas fa-link"></i></a>
  808. <span class="phpdocumentor-element__modifiers">
  809. </span>
  810. </h4>
  811. <aside class="phpdocumentor-element-found-in">
  812. <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>
  813. :
  814. <span class="phpdocumentor-element-found-in__line">39</span>
  815. </aside>
  816. <p class="phpdocumentor-summary">an (optional) array of color values for the several QR matrix parts</p>
  817. <code class="phpdocumentor-code phpdocumentor-signature ">
  818. <span class="phpdocumentor-signature__visibility">protected</span>
  819. <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
  820. <span class="phpdocumentor-signature__name">$moduleValues</span>
  821. </code>
  822. </article>
  823. <article
  824. class="
  825. phpdocumentor-element
  826. -property
  827. -protected
  828. "
  829. >
  830. <h4 class="phpdocumentor-element__name" id="property_options">
  831. $options
  832. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
  833. <span class="phpdocumentor-element__modifiers">
  834. </span>
  835. </h4>
  836. <aside class="phpdocumentor-element-found-in">
  837. <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>
  838. :
  839. <span class="phpdocumentor-element-found-in__line">49</span>
  840. </aside>
  841. <p class="phpdocumentor-summary">the options instance</p>
  842. <code class="phpdocumentor-code phpdocumentor-signature ">
  843. <span class="phpdocumentor-signature__visibility">protected</span>
  844. <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>
  845. <span class="phpdocumentor-signature__name">$options</span>
  846. </code>
  847. </article>
  848. <article
  849. class="
  850. phpdocumentor-element
  851. -property
  852. -protected
  853. "
  854. >
  855. <h4 class="phpdocumentor-element__name" id="property_scale">
  856. $scale
  857. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale" class="headerlink"><i class="fas fa-link"></i></a>
  858. <span class="phpdocumentor-element__modifiers">
  859. </span>
  860. </h4>
  861. <aside class="phpdocumentor-element-found-in">
  862. <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>
  863. :
  864. <span class="phpdocumentor-element-found-in__line">52</span>
  865. </aside>
  866. <code class="phpdocumentor-code phpdocumentor-signature ">
  867. <span class="phpdocumentor-signature__visibility">protected</span>
  868. <span class="phpdocumentor-signature__type">int</span>
  869. <span class="phpdocumentor-signature__name">$scale</span>
  870. </code>
  871. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  872. Tags
  873. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale#tags" class="headerlink"><i class="fas fa-link"></i></a>
  874. </h5>
  875. <dl class="phpdocumentor-tag-list">
  876. <dt class="phpdocumentor-tag-list__entry">
  877. <span class="phpdocumentor-tag__name">see</span>
  878. </dt>
  879. <dd class="phpdocumentor-tag-list__definition">
  880. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$scale">QROptions::$scale</abbr></span>
  881. </dd>
  882. </dl>
  883. </article>
  884. </section>
  885. <section class="phpdocumentor-methods">
  886. <h3 class="phpdocumentor-elements__header" id="methods">
  887. Methods
  888. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
  889. </h3>
  890. <article
  891. class="phpdocumentor-element
  892. -method
  893. -public
  894. "
  895. >
  896. <h4 class="phpdocumentor-element__name" id="method___construct">
  897. __construct()
  898. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
  899. </h4>
  900. <aside class="phpdocumentor-element-found-in">
  901. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRInterventionImage.php"><a href="files/src-output-qrinterventionimage.html"><abbr title="src/Output/QRInterventionImage.php">QRInterventionImage.php</abbr></a></abbr>
  902. :
  903. <span class="phpdocumentor-element-found-in__line">50</span>
  904. </aside>
  905. <p class="phpdocumentor-summary">QRInterventionImage constructor.</p>
  906. <code class="phpdocumentor-code phpdocumentor-signature ">
  907. <span class="phpdocumentor-signature__visibility">public</span>
  908. <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>
  909. <div class="phpdocumentor-label-line">
  910. </div>
  911. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  912. <dl class="phpdocumentor-argument-list">
  913. <dt class="phpdocumentor-argument-list__entry">
  914. <span class="phpdocumentor-signature__argument__name">$options</span>
  915. : <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>
  916. </dt>
  917. <dd class="phpdocumentor-argument-list__definition">
  918. </dd>
  919. <dt class="phpdocumentor-argument-list__entry">
  920. <span class="phpdocumentor-signature__argument__name">$matrix</span>
  921. : <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>
  922. </dt>
  923. <dd class="phpdocumentor-argument-list__definition">
  924. </dd>
  925. </dl>
  926. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  927. Tags
  928. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
  929. </h5>
  930. <dl class="phpdocumentor-tag-list">
  931. <dt class="phpdocumentor-tag-list__entry">
  932. <span class="phpdocumentor-tag__name">throws</span>
  933. </dt>
  934. <dd class="phpdocumentor-tag-list__definition">
  935. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  936. </dd>
  937. </dl>
  938. </article>
  939. <article
  940. class="phpdocumentor-element
  941. -method
  942. -public
  943. "
  944. >
  945. <h4 class="phpdocumentor-element__name" id="method_dump">
  946. dump()
  947. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method_dump" class="headerlink"><i class="fas fa-link"></i></a>
  948. </h4>
  949. <aside class="phpdocumentor-element-found-in">
  950. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRInterventionImage.php"><a href="files/src-output-qrinterventionimage.html"><abbr title="src/Output/QRInterventionImage.php">QRInterventionImage.php</abbr></a></abbr>
  951. :
  952. <span class="phpdocumentor-element-found-in__line">88</span>
  953. </aside>
  954. <code class="phpdocumentor-code phpdocumentor-signature ">
  955. <span class="phpdocumentor-signature__visibility">public</span>
  956. <span class="phpdocumentor-signature__name">dump</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$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">string|<abbr title="\Intervention\Image\Interfaces\ImageInterface">ImageInterface</abbr></span></code>
  957. <div class="phpdocumentor-label-line">
  958. </div>
  959. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  960. <dl class="phpdocumentor-argument-list">
  961. <dt class="phpdocumentor-argument-list__entry">
  962. <span class="phpdocumentor-signature__argument__name">$file</span>
  963. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  964. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  965. <dd class="phpdocumentor-argument-list__definition">
  966. </dd>
  967. </dl>
  968. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  969. Tags
  970. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method_dump#tags" class="headerlink"><i class="fas fa-link"></i></a>
  971. </h5>
  972. <dl class="phpdocumentor-tag-list">
  973. <dt class="phpdocumentor-tag-list__entry">
  974. <span class="phpdocumentor-tag__name">inheritDoc</span>
  975. </dt>
  976. <dd class="phpdocumentor-tag-list__definition">
  977. </dd>
  978. </dl>
  979. <section>
  980. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  981. <span class="phpdocumentor-signature__response_type">string|<abbr title="\Intervention\Image\Interfaces\ImageInterface">ImageInterface</abbr></span>
  982. </section>
  983. </article>
  984. <article
  985. class="phpdocumentor-element
  986. -method
  987. -public
  988. -static "
  989. >
  990. <h4 class="phpdocumentor-element__name" id="method_moduleValueIsValid">
  991. moduleValueIsValid()
  992. <a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_moduleValueIsValid" class="headerlink"><i class="fas fa-link"></i></a>
  993. </h4>
  994. <aside class="phpdocumentor-element-found-in">
  995. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/CssColorModuleValueTrait.php"><a href="files/src-output-csscolormodulevaluetrait.html"><abbr title="src/Output/CssColorModuleValueTrait.php">CssColorModuleValueTrait.php</abbr></a></abbr>
  996. :
  997. <span class="phpdocumentor-element-found-in__line">30</span>
  998. </aside>
  999. <p class="phpdocumentor-summary">note: we&#039;re not necessarily validating the several values, just checking the general syntax
  1000. note: css4 colors are not included</p>
  1001. <code class="phpdocumentor-code phpdocumentor-signature ">
  1002. <span class="phpdocumentor-signature__visibility">public</span>
  1003. <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">moduleValueIsValid</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">bool</span></code>
  1004. <div class="phpdocumentor-label-line">
  1005. </div>
  1006. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1007. <dl class="phpdocumentor-argument-list">
  1008. <dt class="phpdocumentor-argument-list__entry">
  1009. <span class="phpdocumentor-signature__argument__name">$value</span>
  1010. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1011. </dt>
  1012. <dd class="phpdocumentor-argument-list__definition">
  1013. </dd>
  1014. </dl>
  1015. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1016. Tags
  1017. <a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_moduleValueIsValid#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1018. </h5>
  1019. <dl class="phpdocumentor-tag-list">
  1020. <dt class="phpdocumentor-tag-list__entry">
  1021. <span class="phpdocumentor-tag__name">todo:</span>
  1022. </dt>
  1023. <dd class="phpdocumentor-tag-list__definition">
  1024. <section class="phpdocumentor-description"><p>XSS proof</p>
  1025. </section>
  1026. </dd>
  1027. <dt class="phpdocumentor-tag-list__entry">
  1028. <span class="phpdocumentor-tag__name">see</span>
  1029. </dt>
  1030. <dd class="phpdocumentor-tag-list__definition">
  1031. <span class="phpdocumentor-tag-link"><a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value">https://developer.mozilla.org/en-US/docs/Web/CSS/color_value</a></span>
  1032. </dd>
  1033. <dt class="phpdocumentor-tag-list__entry">
  1034. <span class="phpdocumentor-tag__name">implements</span>
  1035. </dt>
  1036. <dd class="phpdocumentor-tag-list__definition">
  1037. <section class="phpdocumentor-description"><p>\chillerlan\QRCode\Output\QROutputInterface::moduleValueIsValid()</p>
  1038. </section>
  1039. </dd>
  1040. <dt class="phpdocumentor-tag-list__entry">
  1041. <span class="phpdocumentor-tag__name">inheritDoc</span>
  1042. </dt>
  1043. <dd class="phpdocumentor-tag-list__definition">
  1044. </dd>
  1045. </dl>
  1046. <section>
  1047. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1048. <span class="phpdocumentor-signature__response_type">bool</span>
  1049. </section>
  1050. </article>
  1051. <article
  1052. class="phpdocumentor-element
  1053. -method
  1054. -public
  1055. "
  1056. >
  1057. <h4 class="phpdocumentor-element__name" id="method_setDriver">
  1058. setDriver()
  1059. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method_setDriver" class="headerlink"><i class="fas fa-link"></i></a>
  1060. </h4>
  1061. <aside class="phpdocumentor-element-found-in">
  1062. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRInterventionImage.php"><a href="files/src-output-qrinterventionimage.html"><abbr title="src/Output/QRInterventionImage.php">QRInterventionImage.php</abbr></a></abbr>
  1063. :
  1064. <span class="phpdocumentor-element-found-in__line">79</span>
  1065. </aside>
  1066. <p class="phpdocumentor-summary">Sets a DriverInterface</p>
  1067. <code class="phpdocumentor-code phpdocumentor-signature ">
  1068. <span class="phpdocumentor-signature__visibility">public</span>
  1069. <span class="phpdocumentor-signature__name">setDriver</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Intervention\Image\Interfaces\DriverInterface">DriverInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$driver</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">static</span></code>
  1070. <div class="phpdocumentor-label-line">
  1071. </div>
  1072. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1073. <dl class="phpdocumentor-argument-list">
  1074. <dt class="phpdocumentor-argument-list__entry">
  1075. <span class="phpdocumentor-signature__argument__name">$driver</span>
  1076. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Intervention\Image\Interfaces\DriverInterface">DriverInterface</abbr></span>
  1077. </dt>
  1078. <dd class="phpdocumentor-argument-list__definition">
  1079. </dd>
  1080. </dl>
  1081. <section>
  1082. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1083. <span class="phpdocumentor-signature__response_type">static</span>
  1084. </section>
  1085. </article>
  1086. <article
  1087. class="phpdocumentor-element
  1088. -method
  1089. -protected
  1090. "
  1091. >
  1092. <h4 class="phpdocumentor-element__name" id="method_collectModules">
  1093. collectModules()
  1094. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules" class="headerlink"><i class="fas fa-link"></i></a>
  1095. </h4>
  1096. <aside class="phpdocumentor-element-found-in">
  1097. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QROutputAbstract.php"><a href="files/src-output-qroutputabstract.html"><abbr title="src/Output/QROutputAbstract.php">QROutputAbstract.php</abbr></a></abbr>
  1098. :
  1099. <span class="phpdocumentor-element-found-in__line">221</span>
  1100. </aside>
  1101. <p class="phpdocumentor-summary">collects the modules per QRMatrix::M_* type and runs a $transform function on each module and
  1102. returns an array with the transformed modules</p>
  1103. <code class="phpdocumentor-code phpdocumentor-signature ">
  1104. <span class="phpdocumentor-signature__visibility">protected</span>
  1105. <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>
  1106. <div class="phpdocumentor-label-line">
  1107. </div>
  1108. <section class="phpdocumentor-description"><p>The transform callback is called with the following parameters:</p>
  1109. <p>$x - current column
  1110. $y - current row
  1111. $M_TYPE - field value
  1112. $M_TYPE_LAYER - (possibly modified) field value that acts as layer id</p>
  1113. </section>
  1114. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1115. <dl class="phpdocumentor-argument-list">
  1116. <dt class="phpdocumentor-argument-list__entry">
  1117. <span class="phpdocumentor-signature__argument__name">$transform</span>
  1118. : <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Closure">Closure</abbr></span>
  1119. </dt>
  1120. <dd class="phpdocumentor-argument-list__definition">
  1121. </dd>
  1122. </dl>
  1123. <section>
  1124. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1125. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1126. </section>
  1127. </article>
  1128. <article
  1129. class="phpdocumentor-element
  1130. -method
  1131. -protected
  1132. "
  1133. >
  1134. <h4 class="phpdocumentor-element__name" id="method_copyVars">
  1135. copyVars()
  1136. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars" class="headerlink"><i class="fas fa-link"></i></a>
  1137. </h4>
  1138. <aside class="phpdocumentor-element-found-in">
  1139. <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>
  1140. :
  1141. <span class="phpdocumentor-element-found-in__line">91</span>
  1142. </aside>
  1143. <p class="phpdocumentor-summary">Creates copies of several QROptions values to avoid calling the magic getters
  1144. in long loops for a significant performance increase.</p>
  1145. <code class="phpdocumentor-code phpdocumentor-signature ">
  1146. <span class="phpdocumentor-signature__visibility">protected</span>
  1147. <span class="phpdocumentor-signature__name">copyVars</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1148. <div class="phpdocumentor-label-line">
  1149. </div>
  1150. <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>
  1151. </section>
  1152. </article>
  1153. <article
  1154. class="phpdocumentor-element
  1155. -method
  1156. -protected
  1157. -abstract "
  1158. >
  1159. <h4 class="phpdocumentor-element__name" id="method_getDefaultModuleValue">
  1160. getDefaultModuleValue()
  1161. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1162. </h4>
  1163. <aside class="phpdocumentor-element-found-in">
  1164. <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>
  1165. :
  1166. <span class="phpdocumentor-element-found-in__line">157</span>
  1167. </aside>
  1168. <p class="phpdocumentor-summary">Returns a default value for either dark or light modules (return value depends on the output class)</p>
  1169. <code class="phpdocumentor-code phpdocumentor-signature ">
  1170. <span class="phpdocumentor-signature__visibility">protected</span>
  1171. <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>
  1172. <div class="phpdocumentor-label-line">
  1173. </div>
  1174. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1175. <dl class="phpdocumentor-argument-list">
  1176. <dt class="phpdocumentor-argument-list__entry">
  1177. <span class="phpdocumentor-signature__argument__name">$isDark</span>
  1178. : <span class="phpdocumentor-signature__argument__return-type">bool</span>
  1179. </dt>
  1180. <dd class="phpdocumentor-argument-list__definition">
  1181. </dd>
  1182. </dl>
  1183. </article>
  1184. <article
  1185. class="phpdocumentor-element
  1186. -method
  1187. -protected
  1188. "
  1189. >
  1190. <h4 class="phpdocumentor-element__name" id="method_getModuleValue">
  1191. getModuleValue()
  1192. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1193. </h4>
  1194. <aside class="phpdocumentor-element-found-in">
  1195. <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>
  1196. :
  1197. <span class="phpdocumentor-element-found-in__line">164</span>
  1198. </aside>
  1199. <p class="phpdocumentor-summary">Returns the prepared value for the given $M_TYPE</p>
  1200. <code class="phpdocumentor-code phpdocumentor-signature ">
  1201. <span class="phpdocumentor-signature__visibility">protected</span>
  1202. <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>
  1203. <div class="phpdocumentor-label-line">
  1204. </div>
  1205. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1206. <dl class="phpdocumentor-argument-list">
  1207. <dt class="phpdocumentor-argument-list__entry">
  1208. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1209. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1210. </dt>
  1211. <dd class="phpdocumentor-argument-list__definition">
  1212. </dd>
  1213. </dl>
  1214. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1215. Tags
  1216. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1217. </h5>
  1218. <dl class="phpdocumentor-tag-list">
  1219. <dt class="phpdocumentor-tag-list__entry">
  1220. <span class="phpdocumentor-tag__name">throws</span>
  1221. </dt>
  1222. <dd class="phpdocumentor-tag-list__definition">
  1223. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1224. <section class="phpdocumentor-description"><p>if $moduleValues[$M_TYPE] doesn't exist</p>
  1225. </section>
  1226. </dd>
  1227. </dl>
  1228. </article>
  1229. <article
  1230. class="phpdocumentor-element
  1231. -method
  1232. -protected
  1233. "
  1234. >
  1235. <h4 class="phpdocumentor-element__name" id="method_getModuleValueAt">
  1236. getModuleValueAt()
  1237. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt" class="headerlink"><i class="fas fa-link"></i></a>
  1238. </h4>
  1239. <aside class="phpdocumentor-element-found-in">
  1240. <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>
  1241. :
  1242. <span class="phpdocumentor-element-found-in__line">176</span>
  1243. </aside>
  1244. <p class="phpdocumentor-summary">Returns the prepared module value at the given coordinate [$x, $y] (convenience)</p>
  1245. <code class="phpdocumentor-code phpdocumentor-signature ">
  1246. <span class="phpdocumentor-signature__visibility">protected</span>
  1247. <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>
  1248. <div class="phpdocumentor-label-line">
  1249. </div>
  1250. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1251. <dl class="phpdocumentor-argument-list">
  1252. <dt class="phpdocumentor-argument-list__entry">
  1253. <span class="phpdocumentor-signature__argument__name">$x</span>
  1254. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1255. </dt>
  1256. <dd class="phpdocumentor-argument-list__definition">
  1257. </dd>
  1258. <dt class="phpdocumentor-argument-list__entry">
  1259. <span class="phpdocumentor-signature__argument__name">$y</span>
  1260. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1261. </dt>
  1262. <dd class="phpdocumentor-argument-list__definition">
  1263. </dd>
  1264. </dl>
  1265. </article>
  1266. <article
  1267. class="phpdocumentor-element
  1268. -method
  1269. -protected
  1270. "
  1271. >
  1272. <h4 class="phpdocumentor-element__name" id="method_getOutputDimensions">
  1273. getOutputDimensions()
  1274. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1275. </h4>
  1276. <aside class="phpdocumentor-element-found-in">
  1277. <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>
  1278. :
  1279. <span class="phpdocumentor-element-found-in__line">126</span>
  1280. </aside>
  1281. <p class="phpdocumentor-summary">Returns a 2 element array with the current output width and height</p>
  1282. <code class="phpdocumentor-code phpdocumentor-signature ">
  1283. <span class="phpdocumentor-signature__visibility">protected</span>
  1284. <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>
  1285. <div class="phpdocumentor-label-line">
  1286. </div>
  1287. <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>
  1288. </section>
  1289. <section>
  1290. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1291. <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
  1292. </section>
  1293. </article>
  1294. <article
  1295. class="phpdocumentor-element
  1296. -method
  1297. -protected
  1298. "
  1299. >
  1300. <h4 class="phpdocumentor-element__name" id="method_module">
  1301. module()
  1302. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method_module" class="headerlink"><i class="fas fa-link"></i></a>
  1303. </h4>
  1304. <aside class="phpdocumentor-element-found-in">
  1305. <abbr class="phpdocumentor-element-found-in__file" title="src/Output/QRInterventionImage.php"><a href="files/src-output-qrinterventionimage.html"><abbr title="src/Output/QRInterventionImage.php">QRInterventionImage.php</abbr></a></abbr>
  1306. :
  1307. <span class="phpdocumentor-element-found-in__line">129</span>
  1308. </aside>
  1309. <p class="phpdocumentor-summary">draws a single pixel at the given position</p>
  1310. <code class="phpdocumentor-code phpdocumentor-signature ">
  1311. <span class="phpdocumentor-signature__visibility">protected</span>
  1312. <span class="phpdocumentor-signature__name">module</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 class="phpdocumentor-signature__argument"><span>, </span><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">void</span></code>
  1313. <div class="phpdocumentor-label-line">
  1314. </div>
  1315. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1316. <dl class="phpdocumentor-argument-list">
  1317. <dt class="phpdocumentor-argument-list__entry">
  1318. <span class="phpdocumentor-signature__argument__name">$x</span>
  1319. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1320. </dt>
  1321. <dd class="phpdocumentor-argument-list__definition">
  1322. </dd>
  1323. <dt class="phpdocumentor-argument-list__entry">
  1324. <span class="phpdocumentor-signature__argument__name">$y</span>
  1325. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1326. </dt>
  1327. <dd class="phpdocumentor-argument-list__definition">
  1328. </dd>
  1329. <dt class="phpdocumentor-argument-list__entry">
  1330. <span class="phpdocumentor-signature__argument__name">$M_TYPE</span>
  1331. : <span class="phpdocumentor-signature__argument__return-type">int</span>
  1332. </dt>
  1333. <dd class="phpdocumentor-argument-list__definition">
  1334. </dd>
  1335. </dl>
  1336. </article>
  1337. <article
  1338. class="phpdocumentor-element
  1339. -method
  1340. -protected
  1341. -abstract "
  1342. >
  1343. <h4 class="phpdocumentor-element__name" id="method_prepareModuleValue">
  1344. prepareModuleValue()
  1345. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue" class="headerlink"><i class="fas fa-link"></i></a>
  1346. </h4>
  1347. <aside class="phpdocumentor-element-found-in">
  1348. <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>
  1349. :
  1350. <span class="phpdocumentor-element-found-in__line">152</span>
  1351. </aside>
  1352. <p class="phpdocumentor-summary">Prepares the value for the given input (return value depends on the output class)</p>
  1353. <code class="phpdocumentor-code phpdocumentor-signature ">
  1354. <span class="phpdocumentor-signature__visibility">protected</span>
  1355. <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>
  1356. <div class="phpdocumentor-label-line">
  1357. </div>
  1358. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1359. <dl class="phpdocumentor-argument-list">
  1360. <dt class="phpdocumentor-argument-list__entry">
  1361. <span class="phpdocumentor-signature__argument__name">$value</span>
  1362. : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
  1363. </dt>
  1364. <dd class="phpdocumentor-argument-list__definition">
  1365. </dd>
  1366. </dl>
  1367. </article>
  1368. <article
  1369. class="phpdocumentor-element
  1370. -method
  1371. -protected
  1372. "
  1373. >
  1374. <h4 class="phpdocumentor-element__name" id="method_saveToFile">
  1375. saveToFile()
  1376. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile" class="headerlink"><i class="fas fa-link"></i></a>
  1377. </h4>
  1378. <aside class="phpdocumentor-element-found-in">
  1379. <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>
  1380. :
  1381. <span class="phpdocumentor-element-found-in__line">195</span>
  1382. </aside>
  1383. <p class="phpdocumentor-summary">Saves the qr $data to a $file. If $file is null, nothing happens.</p>
  1384. <code class="phpdocumentor-code phpdocumentor-signature ">
  1385. <span class="phpdocumentor-signature__visibility">protected</span>
  1386. <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>
  1387. <div class="phpdocumentor-label-line">
  1388. </div>
  1389. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1390. <dl class="phpdocumentor-argument-list">
  1391. <dt class="phpdocumentor-argument-list__entry">
  1392. <span class="phpdocumentor-signature__argument__name">$data</span>
  1393. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1394. </dt>
  1395. <dd class="phpdocumentor-argument-list__definition">
  1396. </dd>
  1397. <dt class="phpdocumentor-argument-list__entry">
  1398. <span class="phpdocumentor-signature__argument__name">$file</span>
  1399. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1400. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1401. <dd class="phpdocumentor-argument-list__definition">
  1402. </dd>
  1403. </dl>
  1404. <h5 class="phpdocumentor-tag-list__heading" id="tags">
  1405. Tags
  1406. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
  1407. </h5>
  1408. <dl class="phpdocumentor-tag-list">
  1409. <dt class="phpdocumentor-tag-list__entry">
  1410. <span class="phpdocumentor-tag__name">see</span>
  1411. </dt>
  1412. <dd class="phpdocumentor-tag-list__definition">
  1413. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\Output\file_put_contents()">file_put_contents()</abbr></span>
  1414. </dd>
  1415. <dt class="phpdocumentor-tag-list__entry">
  1416. <span class="phpdocumentor-tag__name">see</span>
  1417. </dt>
  1418. <dd class="phpdocumentor-tag-list__definition">
  1419. <span class="phpdocumentor-tag-link"><abbr title="\chillerlan\QRCode\QROptions::$cachefile">QROptions::$cachefile</abbr></span>
  1420. </dd>
  1421. <dt class="phpdocumentor-tag-list__entry">
  1422. <span class="phpdocumentor-tag__name">throws</span>
  1423. </dt>
  1424. <dd class="phpdocumentor-tag-list__definition">
  1425. <span class="phpdocumentor-tag-link"><a href="classes/chillerlan-QRCode-Output-QRCodeOutputException.html"><abbr title="\chillerlan\QRCode\Output\QRCodeOutputException">QRCodeOutputException</abbr></a></span>
  1426. </dd>
  1427. </dl>
  1428. </article>
  1429. <article
  1430. class="phpdocumentor-element
  1431. -method
  1432. -protected
  1433. "
  1434. >
  1435. <h4 class="phpdocumentor-element__name" id="method_setMatrixDimensions">
  1436. setMatrixDimensions()
  1437. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions" class="headerlink"><i class="fas fa-link"></i></a>
  1438. </h4>
  1439. <aside class="phpdocumentor-element-found-in">
  1440. <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>
  1441. :
  1442. <span class="phpdocumentor-element-found-in__line">115</span>
  1443. </aside>
  1444. <p class="phpdocumentor-summary">Sets/updates the matrix dimensions</p>
  1445. <code class="phpdocumentor-code phpdocumentor-signature ">
  1446. <span class="phpdocumentor-signature__visibility">protected</span>
  1447. <span class="phpdocumentor-signature__name">setMatrixDimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1448. <div class="phpdocumentor-label-line">
  1449. </div>
  1450. <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>
  1451. </section>
  1452. </article>
  1453. <article
  1454. class="phpdocumentor-element
  1455. -method
  1456. -protected
  1457. "
  1458. >
  1459. <h4 class="phpdocumentor-element__name" id="method_setModuleValues">
  1460. setModuleValues()
  1461. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues" class="headerlink"><i class="fas fa-link"></i></a>
  1462. </h4>
  1463. <aside class="phpdocumentor-element-found-in">
  1464. <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>
  1465. :
  1466. <span class="phpdocumentor-element-found-in__line">133</span>
  1467. </aside>
  1468. <p class="phpdocumentor-summary">Sets the initial module values</p>
  1469. <code class="phpdocumentor-code phpdocumentor-signature ">
  1470. <span class="phpdocumentor-signature__visibility">protected</span>
  1471. <span class="phpdocumentor-signature__name">setModuleValues</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
  1472. <div class="phpdocumentor-label-line">
  1473. </div>
  1474. </article>
  1475. <article
  1476. class="phpdocumentor-element
  1477. -method
  1478. -protected
  1479. "
  1480. >
  1481. <h4 class="phpdocumentor-element__name" id="method_toBase64DataURI">
  1482. toBase64DataURI()
  1483. <a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI" class="headerlink"><i class="fas fa-link"></i></a>
  1484. </h4>
  1485. <aside class="phpdocumentor-element-found-in">
  1486. <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>
  1487. :
  1488. <span class="phpdocumentor-element-found-in__line">183</span>
  1489. </aside>
  1490. <p class="phpdocumentor-summary">Returns a base64 data URI for the given string and mime type</p>
  1491. <code class="phpdocumentor-code phpdocumentor-signature ">
  1492. <span class="phpdocumentor-signature__visibility">protected</span>
  1493. <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>
  1494. <div class="phpdocumentor-label-line">
  1495. </div>
  1496. <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
  1497. <dl class="phpdocumentor-argument-list">
  1498. <dt class="phpdocumentor-argument-list__entry">
  1499. <span class="phpdocumentor-signature__argument__name">$data</span>
  1500. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1501. </dt>
  1502. <dd class="phpdocumentor-argument-list__definition">
  1503. </dd>
  1504. <dt class="phpdocumentor-argument-list__entry">
  1505. <span class="phpdocumentor-signature__argument__name">$mime</span>
  1506. : <span class="phpdocumentor-signature__argument__return-type">string</span>
  1507. = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
  1508. <dd class="phpdocumentor-argument-list__definition">
  1509. </dd>
  1510. </dl>
  1511. <section>
  1512. <h5 class="phpdocumentor-return-value__heading">Return values</h5>
  1513. <span class="phpdocumentor-signature__response_type">string</span>
  1514. </section>
  1515. </article>
  1516. </section>
  1517. <div class="phpdocumentor-modal" id="source-view">
  1518. <div class="phpdocumentor-modal-bg" data-exit-button></div>
  1519. <div class="phpdocumentor-modal-container">
  1520. <div class="phpdocumentor-modal-content">
  1521. <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Output/QRInterventionImage.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
  1522. </div>
  1523. <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
  1524. </div>
  1525. </div>
  1526. <script type="text/javascript">
  1527. (function () {
  1528. function loadExternalCodeSnippet(el, url, line) {
  1529. Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
  1530. const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
  1531. const language = 'php';
  1532. const code = document.createElement('code');
  1533. code.className = 'language-' + language;
  1534. pre.textContent = '';
  1535. pre.setAttribute('data-line', line)
  1536. code.textContent = 'Loading…';
  1537. pre.appendChild(code);
  1538. var xhr = new XMLHttpRequest();
  1539. xhr.open('GET', src, true);
  1540. xhr.onreadystatechange = function () {
  1541. if (xhr.readyState !== 4) {
  1542. return;
  1543. }
  1544. if (xhr.status < 400 && xhr.responseText) {
  1545. code.textContent = xhr.responseText;
  1546. Prism.highlightElement(code);
  1547. return;
  1548. }
  1549. if (xhr.status === 404) {
  1550. code.textContent = '✖ Error: File could not be found';
  1551. return;
  1552. }
  1553. if (xhr.status >= 400) {
  1554. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  1555. return;
  1556. }
  1557. code.textContent = '✖ Error: An unknown error occurred';
  1558. };
  1559. xhr.send(null);
  1560. });
  1561. }
  1562. const modalButtons = document.querySelectorAll("[data-modal]");
  1563. const openedAsLocalFile = window.location.protocol === 'file:';
  1564. if (modalButtons.length > 0 && openedAsLocalFile) {
  1565. console.warn(
  1566. 'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
  1567. 'browsers block XHR requests when a page is opened this way'
  1568. );
  1569. }
  1570. modalButtons.forEach(function (trigger) {
  1571. if (openedAsLocalFile) {
  1572. trigger.setAttribute("hidden", "hidden");
  1573. }
  1574. trigger.addEventListener("click", function (event) {
  1575. event.preventDefault();
  1576. const modal = document.getElementById(trigger.dataset.modal);
  1577. if (!modal) {
  1578. console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
  1579. return;
  1580. }
  1581. modal.classList.add("phpdocumentor-modal__open");
  1582. loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
  1583. const exits = modal.querySelectorAll("[data-exit-button]");
  1584. exits.forEach(function (exit) {
  1585. exit.addEventListener("click", function (event) {
  1586. event.preventDefault();
  1587. modal.classList.remove("phpdocumentor-modal__open");
  1588. });
  1589. });
  1590. });
  1591. });
  1592. })();
  1593. </script>
  1594. </article>
  1595. </section>
  1596. <section class="phpdocumentor-on-this-page__sidebar">
  1597. <section class="phpdocumentor-on-this-page__content">
  1598. <strong class="phpdocumentor-on-this-page__title">On this page</strong>
  1599. <ul class="phpdocumentor-list -clean">
  1600. <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
  1601. <li>
  1602. <ul class="phpdocumentor-list -clean">
  1603. <li><a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#toc-properties">Properties</a></li>
  1604. <li><a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#toc-methods">Methods</a></li>
  1605. </ul>
  1606. </li>
  1607. <li class="phpdocumentor-on-this-page-section__title">Properties</li>
  1608. <li>
  1609. <ul class="phpdocumentor-list -clean">
  1610. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleDiameter">$circleDiameter<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1611. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_circleRadius">$circleRadius<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1612. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_connectPaths">$connectPaths<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1613. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawCircularModules">$drawCircularModules<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1614. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_drawLightModules">$drawLightModules<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1615. <li><a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#property_driver">$driver<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1616. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_eol">$eol<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1617. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_excludeFromConnect">$excludeFromConnect<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1618. <li><a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#property_image">$image<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1619. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_keepAsSquare">$keepAsSquare<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1620. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_length">$length<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1621. <li><a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#property_manager">$manager<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1622. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_matrix">$matrix<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1623. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleCount">$moduleCount<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1624. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_moduleValues">$moduleValues<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1625. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_options">$options<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1626. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#property_scale">$scale<a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html"></li>
  1627. </ul>
  1628. </li>
  1629. <li class="phpdocumentor-on-this-page-section__title">Methods</li>
  1630. <li>
  1631. <ul class="phpdocumentor-list -clean">
  1632. <li><a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method___construct">__construct()</a></li>
  1633. <li><a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method_dump">dump()</a></li>
  1634. <li><a href="classes/chillerlan-QRCode-Output-CssColorModuleValueTrait.html#method_moduleValueIsValid">moduleValueIsValid()</a></li>
  1635. <li><a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method_setDriver">setDriver()</a></li>
  1636. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_collectModules">collectModules()</a></li>
  1637. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_copyVars">copyVars()</a></li>
  1638. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getDefaultModuleValue">getDefaultModuleValue()</a></li>
  1639. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValue">getModuleValue()</a></li>
  1640. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getModuleValueAt">getModuleValueAt()</a></li>
  1641. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_getOutputDimensions">getOutputDimensions()</a></li>
  1642. <li><a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#method_module">module()</a></li>
  1643. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_prepareModuleValue">prepareModuleValue()</a></li>
  1644. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_saveToFile">saveToFile()</a></li>
  1645. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setMatrixDimensions">setMatrixDimensions()</a></li>
  1646. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_setModuleValues">setModuleValues()</a></li>
  1647. <li><a href="classes/chillerlan-QRCode-Output-QROutputAbstract.html#method_toBase64DataURI">toBase64DataURI()</a></li>
  1648. </ul>
  1649. </li>
  1650. </ul>
  1651. </section>
  1652. </section>
  1653. </div>
  1654. <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
  1655. <section class="phpdocumentor-search-results__dialog">
  1656. <header class="phpdocumentor-search-results__header">
  1657. <h2 class="phpdocumentor-search-results__title">Search results</h2>
  1658. <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
  1659. </header>
  1660. <section class="phpdocumentor-search-results__body">
  1661. <ul class="phpdocumentor-search-results__entries"></ul>
  1662. </section>
  1663. </section>
  1664. </section>
  1665. </div>
  1666. <a href="classes/chillerlan-QRCode-Output-QRInterventionImage.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
  1667. </main>
  1668. <script>
  1669. cssVars({});
  1670. </script>
  1671. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
  1672. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
  1673. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
  1674. <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
  1675. </body>
  1676. </html>