chillerlan-QRCode-Output-QRInterventionImage.html 118 KB

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