chillerlan-QRCode-Output-QRFpdf.html 117 KB

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