chillerlan-QRCode-Output-QRFpdf.html 109 KB

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