chillerlan-QRCode-Output-QREps.html 112 KB

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